is_post_type_archive() WordPress Function

The is_post_type_archive() function is used to check if a post type archive page is being displayed. This function returns true if a post type archive is being displayed, and false if not.

is_post_type_archive( string|string[] $post_types = '' ) #

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


Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.


Top ↑

Parameters

$post_types

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

Default value: ''


Top ↑

Return

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


Top ↑

Source

File: wp-includes/query.php

function is_post_type_archive( $post_types = '' ) {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_post_type_archive( $post_types );
}


Top ↑

Changelog

Changelog
VersionDescription
3.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.