is_tax( string|array $taxonomy = '', int|string|array $term = '' )

Determines whether the query is for an existing custom taxonomy archive page.

Contents

Description 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 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: ''

Top ↑

Return Return

(bool) True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).

Top ↑

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/class-wp-query.php: WP_Query::is_tax()

Is the query for an existing custom taxonomy archive page?
wp-includes/functions.php: _doing_it_wrong()

Mark something as being incorrectly called.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/general-template.php: wp_get_document_title()

Returns document title for the current page.
wp-includes/general-template.php: get_the_archive_title()

Retrieve the archive title based on the queried object.
wp-includes/category-template.php: term_description()

Retrieve term description.
wp-includes/category-template.php: wp_list_categories()

Display or retrieve the HTML list of categories.
wp-includes/general-template.php: feed_links_extra()

Display the links to the extra feeds such as category feeds.
wp-includes/general-template.php: wp_title()

Display or retrieve page title for all areas of blog.
wp-includes/general-template.php: single_term_title()

Display or retrieve page title for taxonomy term archive.
wp-includes/class-wp.php: WP::handle_404()

Set the Headers for 404, if nothing is found for requested URL.
wp-includes/post-template.php: get_body_class()

Retrieves an array of the class names for the body element.
wp-includes/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
Show 5 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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'.
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

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

You must log in before being able to contribute a note or feedback.