WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Query::is_singular()

WP_Query::is_singular( string|string[] $post_types = ” ): bool

In this article

Back to top

Determines whether the query is 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_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

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

View all references View on Trac View on GitHub

UsesDescription
WP_Query::get_queried_object()wp-includes/class-wp-query.php

Retrieves the currently queried object.

Used byDescription
is_singular()wp-includes/query.php

Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

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