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 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 See also


Top ↑

Parameters Parameters

$post_types

(string|string[]) (Optional) Post type or array of post types to check against.

Default value: ''


Top ↑

Return Return

(bool) Whether the query is for an existing single post or any of the given post types.


Top ↑

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


Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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