Docs4dev
Docs
wordpress / latest / functions / is_singular.html

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

Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).

Description

If the $post_types parameter is specified, this function will additionally check if the query is for one of the Posts Types specified.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

See also

Parameters

$post_types string|string[] Optional
Post type or array of post types to check against.

Default: ''

Return

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

Source

File: wp-includes/query.php. View all references

function is_singular( $post_types = '' ) {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_singular( $post_types );
}

Uses

Uses Description
WP_Query::is_singular() wp-includes/class-wp-query.php

Is the query for an existing single post of any post type (post, attachment, page, custom post types)?
__() wp-includes/l10n.php

Retrieves the translation of $text.
_doing_it_wrong() wp-includes/functions.php

Marks something as being incorrectly called.

Used By

Used By Description
rest_get_queried_resource_route() wp-includes/rest-api.php

Gets the REST route for the currently queried object.
WP_Widget_Text::_filter_gallery_shortcode_attrs() wp-includes/widgets/class-wp-widget-text.php

Filters gallery shortcode attributes.
WP_Widget_Custom_HTML::_filter_gallery_shortcode_attrs() wp-includes/widgets/class-wp-widget-custom-html.php

Filters gallery shortcode attributes.
WP_Widget_Custom_HTML::widget() wp-includes/widgets/class-wp-widget-custom-html.php

Outputs the content for the current Custom HTML widget instance.
wp_oembed_add_discovery_links() wp-includes/embed.php

Adds oEmbed discovery links in the head element of the website.
wp_get_document_title() wp-includes/general-template.php

Returns document title for the current page.
feed_links_extra() wp-includes/general-template.php

Displays the links to the extra feeds such as category feeds.
WP::handle_404() wp-includes/class-wp.php

Set the Headers for 404, if nothing is found for requested URL.
WP::send_headers() wp-includes/class-wp.php

Sends additional HTTP headers for caching, content type, etc.
WP_Widget_Text::widget() wp-includes/widgets/class-wp-widget-text.php

Outputs the content for the current Text widget instance.
rel_canonical() wp-includes/link-template.php

Outputs rel=canonical for singular queries.
wp_get_shortlink() wp-includes/link-template.php

Returns a shortlink for a post, page, attachment, or site.
get_next_comments_link() wp-includes/link-template.php

Retrieves the link to the next comments page.
get_previous_comments_link() wp-includes/link-template.php

Retrieves the link to the previous comments page.
paginate_comments_links() wp-includes/link-template.php

Displays or retrieves pagination links for the comments on the current post.
get_posts_nav_link() wp-includes/link-template.php

Retrieves the post pages link navigation for previous and next pages.
is_page_template() wp-includes/post-template.php

Determines whether the current post uses a page template.
wp_list_pages() wp-includes/post-template.php

Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
get_body_class() wp-includes/post-template.php

Retrieves an array of the class names for the body element.
redirect_canonical() wp-includes/canonical.php

Redirects incoming links to the proper URL based on the site url.

Changelog

Version Description
1.5.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_singular