WordPress.org

Languages: English • Italiano • 日本語 (Add your language)

Description

Checks if the query is for an archive page of a given post type(s).

Usage

<?php is_post_type_archive( $post_types ); ?>

Parameters

$post_types

(array/string) (optional) Post type or array of posts types to check against.

Default: None

Return Values

(boolean) 

Whether the query is for an archive page of a given post type(s).

Examples

Determine if the current page is an archive made by a custom post type and display the custom post type title:

<?php
if ( is_post_type_archive() ) {
    ?>
    <h1><?php post_type_archive_title(); ?></h1>
    <?php
}
?>

Notes

This returns false for a page like /category/uncategorized/?post_type=custom. It only returns true for a page like /?post_type=custom. In other words, it's not checking for the existence of the post_type query parameter, it's testing if this is the archive of all posts of a given type. You might instead be looking for get_query_var('post_type').

Depending on when this function is run it may or may not be run by nav_menu_item. Take the following code example:

<?php
function some_func( $query ){
    if ( is_post_type_archive('my_custom_post_type') ) {
         // Do stuff
    }
}
add_action('pre_get_posts','some_func');
?>

"Do stuff" may or may not be run in the menu, depending on if the theme is using nav menus or not. The correct usage would be:

<?php
function some_func( $query ){
    if ( is_post_type_archive('my_custom_post_type') && ! empty( $query->query['post_type']  == 'my_custom_post_type' )) {
         // Do stuff
    }
}
add_action('pre_get_posts','some_func');
?>

Change Log

• Since: 3.1.0

Source File

is_post_type_archive() is located in wp-includes/query.php.

Related

Post Types: register_post_type(), add_post_type_support(), remove_post_type_support(), post_type_supports(), post_type_exists(), set_post_type(), get_post_type(), get_post_types(), get_post_type_object(), get_post_type_capabilities(), get_post_type_labels(), is_post_type_hierarchical(), is_post_type_archive(), post_type_archive_title()

• Article: Introduction to WordPress conditional functions
• Function: comments_open()
• Function: is_404()
• Function: is_admin()
• Function: is_admin_bar_showing()
• Function: is_archive()
• Function: is_attachment()
• Function: is_author()
• Function: is_category()
• Function: is_comments_popup()
• Function: is_date()
• Function: is_day()
• Function: is_feed()
• Function: is_front_page()
• Function: is_home()
• Function: is_local_attachment()
• Function: is_main_query
• Function: is_multi_author
• Function: is_month()
• Function: is_new_day()
• Function: is_page()
• Function: is_page_template()
• Function: is_paged()
• Function: is_plugin_active()
• Function: is_plugin_active_for_network()
• Function: is_plugin_inactive()
• Function: is_plugin_page()
• Function: is_post_type_archive()
• Function: is_preview()
• Function: is_search()
• Function: is_single()
• Function: is_singular()
• Function: is_sticky()
• Function: is_tag()
• Function: is_tax()
• Function: is_taxonomy_hierarchical()
• Function: is_time()
• Function: is_trackback()
• Function: is_year()
• Function: in_category()
• Function: in_the_loop()
• Function: is_active_sidebar()
• Function: is_active_widget()
• Function: is_blog_installed()
• Function: is_rtl()
• Function: is_dynamic_sidebar()
• Function: is_user_logged_in()
• Function: has_excerpt()
• Function: has_post_thumbnail()
• Function: has_tag()
• Function: pings_open()
• Function: email_exists()
• Function: post_type_exists()
• Function: taxonomy_exists()
• Function: term_exists()
• Function: username_exists()
• Function: wp_attachment_is_image()
• Function: wp_script_is()