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

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

Contents

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: ''

Top ↑

Return

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

Top ↑

Source

File: wp-includes/query.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Used By

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

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

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

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

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

Displays or retrieves page title for all areas of blog.
post_type_archive_title() wp-includes/general-template.php

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

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

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

Retrieves an array of the class names for the body element.
Show 4 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example
    If the current page is an archive of a custom post type, display the custom post type title:

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

    Notes
    This returns true for a page like /?post_type=my-custom-post-type, but not for /category/uncategorized/?post_type=custom. It’s only testing whether this is an archive of all posts of a given type. It is not checking for the existence of the post_type query parameter — that can be found by get_query_var('post_type').

    Also, depending on when this function runs it may or may not be run by nav_menu_item. For example:

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

    Whether “Do stuff” gets run in the menu depends on whether the theme use nav menus. A better usage would be:

    <?php
function wpdocs_my_function( $query ) {
    if ( is_post_type_archive( 'my_custom_post_type' ) && 'my_custom_post_type' === $query->query['post_type'] ) {
         // Do stuff
    }
}
add_action( 'pre_get_posts', 'wpdocs_my_function' );
?>
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Muhammad Ayoub —

    Conditionally enqueue (add) styles/scripts with custom post type archive page 

    add_action( 'wp_enqueue_scripts', function() {
    // check if this is snippets archive page
    if ( is_post_type_archive( 'snippets' ) ) {
        wp_enqueue_style( 'wpdocs-style-name', get_stylesheet_uri() );
        wp_enqueue_script( 'wpdocs-script-name', get_template_directory_uri() . '/js/example.js', array(), '1.0.0', true );
    }
} );

You must log in before being able to contribute a note or feedback.