is_tax() WordPress Function

The is_tax() function is used to check if the current page is a taxonomy archive page.

is_tax( string|string[] $taxonomy = '', int|string|int[]|string[] $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.


Top ↑

Parameters

$taxonomy

(string|string[])(Optional) Taxonomy slug or slugs to check against.

Default value: ''

$term

(int|string|int[]|string[])(Optional) Term ID, name, slug, or array of such to check against.

Default value: ''


Top ↑

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).


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.