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

Is the query 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.


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)


Top ↑

Source Source

File: wp-includes/class-wp-query.php

	public function is_tag( $tag = '' ) {
		if ( ! $this->is_tag ) {
			return false;
		}

		if ( empty( $tag ) ) {
			return true;
		}

		$tag_obj = $this->get_queried_object();

		$tag = array_map( 'strval', (array) $tag );

		if ( in_array( (string) $tag_obj->term_id, $tag ) ) {
			return true;
		} elseif ( in_array( $tag_obj->name, $tag ) ) {
			return true;
		} elseif ( in_array( $tag_obj->slug, $tag ) ) {
			return true;
		}

		return false;
	}


Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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