W3cubDocs

/WordPress

is_single( int|string|int[]|string[] $post = '' )

Determines whether the query is for an existing single post.

Description

Works for any post type, except attachments and pages

If the $post parameter is specified, this function will additionally check if the query is for one of the Posts 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

(int|string|int[]|string[]) (Optional) Post ID, title, slug, or array of such to check against.

Default value: ''

Return

(bool) Whether the query is for an existing single post.

More Information

  • See Also: is_singular()
  • Although is_single() will usually return true for attachments, this behavior should not be relied upon. It is possible for $is_page and $is_attachment to be true at the same time, and in that case $is_single will be false. For this reason, you should use is_attachment() || is_single() if you want to include attachments, or use is_singular() if you want to include pages too.

Source

File: wp-includes/query.php 

function is_single( $post = '' ) {
	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_single( $post );
}

Uses

Uses Description
wp-includes/l10n.php: __()

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

Is the query for an existing single post?
wp-includes/functions.php: _doing_it_wrong()

Mark something as being incorrectly called.

Used By

Used By Description
wp-includes/general-template.php: wp_title()

Display or retrieve page title for all areas of blog.
wp-includes/link-template.php: get_next_posts_page_link()

Retrieves the next posts page link.
wp-includes/link-template.php: get_next_posts_link()

Retrieves the next posts page link.
wp-includes/link-template.php: get_previous_posts_page_link()

Retrieves the previous posts page link.
wp-includes/link-template.php: get_previous_posts_link()

Retrieves the previous posts page link.
wp-includes/link-template.php: adjacent_posts_rel_link_wp_head()

Displays relational links for the posts adjacent to the current post for single post pages.
wp-includes/link-template.php: get_boundary_post()

Retrieves the boundary post.
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.
wp-includes/comment-template.php: comments_template()

Loads the comment template specified in $file.

Changelog

Version Description
1.5.0 Introduced.

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