is_post_type_archive

Advertisement

Summery Summery

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

Syntax Syntax

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

Description Description

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

Parameters Parameters

$post_types

(Optional) Post type or array of posts types to check against.

Default value: ''

Return Return

(bool)

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

Advertisement

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Advertisement

Leave a Reply