is_singular( string|string[] $post_types = '' ): bool

Description

Parameters

$post_typesstring|string[]optional

Post type or array of post types to check against. Default empty.Default: ''

Return

bool

Whether the query is for an existing single post or any of the given post types.

Uses · 2

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 50

• WP::handle_404()Set the Headers for 404, if nothing is found for requested URL.
• WP::send_headers()Sends additional HTTP headers for caching, content type, etc.
• WP_Widget_Custom_HTML::_filter_gallery_shortcode_attrs()Filters gallery shortcode attributes.
• WP_Widget_Custom_HTML::widget()Outputs the content for the current Custom HTML widget instance.
• WP_Widget_Text::_filter_gallery_shortcode_attrs()Filters gallery shortcode attributes.
• WP_Widget_Text::widget()Outputs the content for the current Text widget instance.
• feed_links_extra()Displays the links to the extra feeds such as category feeds.
• get_body_class()Retrieves an array of the class names for the body element.
• get_next_comments_link()Retrieves the link to the next comments page.
• get_posts_nav_link()Retrieves the post pages link navigation for previous and next pages.
• get_previous_comments_link()Retrieves the link to the previous comments page.
• get_the_block_template_html()Returns the markup for the current template.

Source

View on Trac ↗View on GitHub ↗

762function is_singular( $post_types = '' ) {763	global $wp_query;764 765	if ( ! isset( $wp_query ) ) {766		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );767		return false;768	}769 770	return $wp_query->is_singular( $post_types );771}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.