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

Determines whether the query is for an existing single post.

Contents

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.

Top ↑

See also

Top ↑

Parameters

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

Default: ''

Top ↑

Return

bool Whether the query is for an existing single post.

Top ↑

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.

Top ↑

Source

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

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 );
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

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

Displays or retrieves page title for all areas of blog.
get_next_posts_page_link() wp-includes/link-template.php

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

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

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

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

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

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

Loads the comment template specified in $file.
Show 5 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note
    Contributed by Codex — 
    is_single();
// When any single Post page is being displayed.

is_single('17');
// When Post 17 (ID) is being displayed.

is_single(17);
// When Post 17 (ID) is being displayed. Integer parameter also works
is_single('Irish Stew');
// When the Post with post_title of "Irish Stew" is being displayed.

is_single('beef-stew');
// When the Post with post_name (slug) of "beef-stew" is being displayed.

is_single(array(17,'beef-stew','Irish Stew'));
// Returns true when the single post being displayed is either post ID 17,
// or the post_name is "beef-stew", or the post_title is "Irish Stew".
// Note: the array ability was added in version 2.5.

You must log in before being able to contribute a note or feedback.