W3cubDocs

/WordPress

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

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 value: ''

Return

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

Source

File: wp-includes/query.php 

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-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/class-wp-query.php: WP_Query::is_singular()

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

Mark something as being incorrectly called.

Used By

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

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

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

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

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

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

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

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

Set the Headers for 404, if nothing is found for requested URL.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::widget()

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

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

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

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

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

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

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

Determines whether currently in a page template.
wp-includes/post-template.php: wp_list_pages()

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

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

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

Changelog

Version Description
1.5.0 Introduced.

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