is_tax() – Function | Developer.WordPress.org

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

$taxonomystring|string[]optional: Taxonomy slug or slugs to check against.

Default:''
$termint|string|int[]|string[]optional: Term ID, name, slug, or array of such to check against.
Default:''

Return

bool Whether the query is for an existing custom taxonomy archive page.
True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).

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

View all references View on Trac View on GitHub

Uses	Description
WP_Query::is_tax()`wp-includes/class-wp-query.php`	Determines whether the query is for an existing custom taxonomy archive page.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Show 1 more Show less

Used by	Description
rest_get_queried_resource_route()`wp-includes/rest-api.php`	Gets the REST route for the currently queried object.
wp_get_document_title()`wp-includes/general-template.php`	Returns document title for the current page.
get_the_archive_title()`wp-includes/general-template.php`	Retrieves the archive title based on the queried object.
term_description()`wp-includes/category-template.php`	Retrieves term description.
wp_list_categories()`wp-includes/category-template.php`	Displays or retrieves the HTML list of categories.
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.
single_term_title()`wp-includes/general-template.php`	Displays or retrieves page title for taxonomy term archive.
WP::handle_404()`wp-includes/class-wp.php`	Set the Headers for 404, if nothing is found for requested URL.
get_body_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the body element.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.

Show 6 more Show less

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

Codex 9 years ago

Examples

is_tax();
// When any custom taxonomy archive page is being displayed.

is_tax( 'channel' );
// When the archive page for taxonomy of 'channel' is being displayed.

is_tax( 'channel', 'BBC1' );
// When the archive page for taxonomy of 'channel' is being displayed
// and the 'channel' taxonomy term is 'BBC1'.

Skip to note 8 content

Jonm511 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
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:
```
add_action( 'pre_get_posts', function( $query) {
    if ( $query->is_tax( 'NAME_OF_TAXONOMY' ) ) { // Replace with the name of the taxonomy you want to target
        $query->set( 'posts_per_page', 6 ); // change '6' to the number of posts you want to appear
    }

} );
```
Log in to add feedback
Skip to note 9 content

junkes 3 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
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.
```
if ( is_tax( array('channel', 'broadcaster') ) ) {
// your code goes here
}
```
Log in to add feedback
Skip to note 10 content

tdrayson 9 months ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
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
```
if ( is_category() || is_tag() || is_tax() ){
	// Is any taxonomy archive page
}
```
Log in to add feedback
Skip to note 11 content

xrichard 5 years ago

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
The $term parameter also accepts term objects.
```
is_tax( 'custom_taxonomy', $taxonomy_term_object );
```
Log in to add feedback
Skip to note 12 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Post Formats
The taxonomy slug for Post Formats differs from the Post Format slug. The register_taxonomy() function appends a post-format- base to the Post Format slug. So, e.g. while the “Aside” Post Format type has a slug of aside, the post_format taxonomy term “Aside” has a slug of post-format-aside.
```
// When the archive page for any Post Format term is being displayed.
is_tax( 'post_format' );

// When the archive page for Post Format type 'aside' is being displayed.
is_tax( 'post_format', 'post-format-aside' );
```
Log in to add feedback

is_tax( string|string[] $taxonomy = ”, int|string|int[]|string[] $term = ” ): bool

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes

is_tax( string|string[] $taxonomy = ”, int|string|int[]|string[] $term = ” ): bool

In this article

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes