is_tag( int|string|int[]|string[] $tag = '' )

Determines whether the query is for an existing tag archive page.


Description Description

If the $tag parameter is specified, this function will additionally check if the query is for one of the tags specified.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.


Top ↑

Parameters Parameters

$tag

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

Default value: ''


Top ↑

Return Return

(bool) Whether the query is for an existing tag archive page.


Top ↑

Source Source

File: wp-includes/query.php

function is_tag( $tag = '' ) {
	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_tag( $tag );
}


Top ↑

Changelog Changelog

Changelog
Version Description
2.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Examples

    // When any Tag archive page is being displayed.
    is_tag();
    
    // When the archive page for Tag 30 is being displayed.
    is_tag( '30' );
    
    // When the archive page for tag with the Slug of 'extreme' is being displayed.
    is_tag( 'extreme' );
    
    // When the archive page for tag with the Name of 'mild' is being displayed.
    is_tag( 'mild' );
    
    /*
     * Returns true when the tag of posts being displayed is either term_ID 30,
     * or slug "extreme", or name "mild". Note: the array ability was added
     * at Version 3.7.
     */
    is_tag( array( 30, 'mild', 'extreme' ) );
    
    

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