is_tax( string|array $taxonomy = '', int|string|array $term = '' )
Determines whether the query is for an existing custom taxonomy archive page.
Description
If the $taxonomy parameter is specified, this function will additionally check if the query is for that specific $taxonomy.
If the $term parameter is specified in addition to the $taxonomy parameter, this function will additionally check if the query is for one of the terms specified.
For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.
Parameters
- $taxonomy
-
(string|array) (Optional) Taxonomy slug or slugs.
Default value: ''
- $term
-
(int|string|array) (Optional) Term ID, name, slug or array of Term IDs, names, and slugs.
Default value: ''
Return
(bool) True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).
Source
File: wp-includes/query.php
function is_tax( $taxonomy = '', $term = '' ) {
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_tax( $taxonomy, $term );
}
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Introduced. |
Examples
Post Formats
The taxonomy slug for Post Formats differs from the Post Format slug. The
register_taxonomy()function appends apost-format-base to the Post Format slug. So, e.g. while the “Aside” Post Format type has a slug of aside, thepost_formattaxonomy term “Aside” has a slug ofpost-format-aside.