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.

Parameters

$post_types

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

Default value: ''

Return

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

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

Uses

Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/class-wp-query.php: WP_Query::is_post_type_archive()

Is the query for an existing post type archive page?
wp-includes/functions.php: _doing_it_wrong()

Mark something as being incorrectly called.

Used By

Used By Description
wp-includes/general-template.php: wp_get_document_title()

Returns document title for the current page.
wp-includes/general-template.php: get_the_archive_description()

Retrieves the description for an author, post type, or term archive.
wp-includes/general-template.php: get_the_archive_title()

Retrieve the archive title based on the queried object.
wp-includes/general-template.php: feed_links_extra()

Display the links to the extra feeds such as category feeds.
wp-includes/general-template.php: wp_title()

Display or retrieve page title for all areas of blog.
wp-includes/general-template.php: post_type_archive_title()

Display or retrieve title for a post type archive.
wp-includes/class-wp.php: WP::handle_404()

Set the Headers for 404, if nothing is found for requested URL.
wp-includes/nav-menu-template.php: _wp_menu_item_classes_by_context()

Adds the class property classes for the current context, if applicable.
wp-includes/post-template.php: get_body_class()

Retrieves an array of the class names for the body element.

Changelog

Version Description
3.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/is_post_type_archive