On this page
is_single( int|string|int[]|string[] $post = '' ): bool
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
$postint|string|int[]|string[] Optional-
Post ID, title, slug, or array of such to check against.
Default:
''
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. 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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_Query::is_single() wp-includes/class-wp-query.php | Is the query for an existing single post? |
| __() 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 |
|---|---|
| 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. |
Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_single