is_post_type_archive()

You are here:

is_post_type_archive( string|string[] $post_types =  )

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

Description Description

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


Top ↑

Parameters Parameters

$post_types

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

Default value: ”


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-includes/query.php

179
180
181
182
183
184
185
186
187
188
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 );
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
3.1.0Introduced.
Was this article helpful?
Dislike 0
Views: 3

Cart

Log in

Create an Account
Back to Top