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

Is the query for an existing post type archive page?


Parameters

$post_types string|string[] Optional
Post type or array of posts types to check against.

Default: ''


Top ↑

Return

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


Top ↑

Source

File: wp-includes/class-wp-query.php. View all references

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

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


Top ↑

Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

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