WP_Query::is_singular() WordPress Method
The WP_Query::is_singular() method is used to check if a query is for a specific post type. If the post type is not specified, then the method will check if the query is for a specific post.
WP_Query::is_singular( string|string[] $post_types = '' ) #
Is the query 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.
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/class-wp-query.php
public function is_singular( $post_types = '' ) {
if ( empty( $post_types ) || ! $this->is_singular ) {
return (bool) $this->is_singular;
}
$post_obj = $this->get_queried_object();
return in_array( $post_obj->post_type, (array) $post_types, true );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |