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|string[]optional- Taxonomy slug or slugs to check against.
Default:
''
$term
int|string|int[]|string[]optional- Term ID, name, slug, or array of such to check against.
Default:
''
Source
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
How to limit the number of posts that appear in a landing page for a specific taxonomy:
If you are making a custom archive landing page that is based on a taxonomy and NOT a category or tag you can place the following code in your
functions.php
file:To check for more than one taxonomy, you can use an array. That’s useful when you want to display some code only on those taxonomy pages.
Check for any taxonomy archive
is_tax()
only checks if the current query is for a custom taxonomy.This doesn’t include the default category and tag taxonomies. You can check for any taxonomy archive by using is_category() and is_tag() alongside the is_tax() function
The $term parameter also accepts term objects.
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_format
taxonomy term “Aside” has a slug ofpost-format-aside
.