is_post_type_archive() WordPress Function
The is_post_type_archive() function is used to check if a post type archive page is being displayed. This function returns true if a post type archive is being displayed, and false if not.
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |