WP_Query::is_post_type_archive() – Method

WP_Query::is_post_type_archive( string|string[] $post_types = '' ): bool

Determines whether the query is for an existing post type archive page.

Parameters

$post_typesstring|string[]optional: Post type or array of posts types to check against.
Default:''

Return

bool Whether the query is for an existing post type archive page.

Source

public function is_post_type_archive( $post_types = '' ) {
	if ( empty( $post_types ) || ! $this->is_post_type_archive ) {
		return (bool) $this->is_post_type_archive;
	}

	$post_type = $this->get( 'post_type' );
	if ( is_array( $post_type ) ) {
		$post_type = reset( $post_type );
	}
	$post_type_object = get_post_type_object( $post_type );

	if ( ! $post_type_object ) {
		return false;
	}

	return in_array( $post_type_object->name, (array) $post_types, true );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Query::get()`wp-includes/class-wp-query.php`	Retrieves the value of a query variable.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Used by	Description
is_post_type_archive()`wp-includes/query.php`	Determines whether the query is for an existing post type archive page.

Changelog

Version	Description
3.1.0	Introduced.

User Contributed Notes

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