WP_Query::is_singular( string|string[] $post_types = '' ): bool
Is the query for an existing single post of any post type (post, attachment, page, custom post types)?
Contents
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_typesstring|string[] Optional -
Post type or array of post types to check against.
Default:
''
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.
View all references
public function is_singular( $post_types = '' ) {
if ( empty( $post_types ) || ! $this->is_singular ) {
return (bool) $this->is_singular;
}
$post_obj = $this->get_queried_object();
if ( ! $post_obj ) {
return false;
}
return in_array( $post_obj->post_type, (array) $post_types, true );
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |