is_post_type_archive( string|string[] $post_types = '' ): bool
- Since
- 3.1.0
- Source
wp-includes/query.php:187
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 <a href="https://developer.wordpress.org/themes/basics/conditional-tags/">https://developer.wordpress.org/themes/basics/conditional-tags/</a> Conditional Tags article in the Theme Developer Handbook.
Parameters
$post_typesstring|string[]optional- Post type or array of posts types to check against. Default empty.Default:
''
Return
bool- Whether the query is for an existing post type archive page.
Uses · 2
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
Used by · 13
- WP::handle_404()Set the Headers for 404, if nothing is found for requested URL.
- _wp_menu_item_classes_by_context()Adds the class property classes for the current context, if applicable.
- block_core_breadcrumbs_get_archive_breadcrumbs()Generates breadcrumb items for archive pages.
- feed_links_extra()Displays the links to the extra feeds such as category feeds.
- get_body_class()Retrieves an array of the class names for the body element.
- get_the_archive_description()Retrieves the description for an author, post type, or term archive.
- get_the_archive_title()Retrieves the archive title based on the queried object.
- post_type_archive_title()Displays or retrieves title for a post type archive.
- render_block_core_navigation_link()Renders the `core/navigation-link` block.
- render_block_core_navigation_submenu()Renders the `core/navigation-submenu` block.
- twentynineteen_get_the_archive_title()Filters the default archive titles.
- wp_get_document_title()Returns document title for the current page.
Show all 13
- wp_title()Displays or retrieves page title for all areas of blog.
Source
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 );}History
Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.