is_tag() WordPress Function

The is_tag() function is used to check whether a given string is a valid tag name in WordPress. It is useful for checking user-provided input, such as when adding new tags to a post.

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

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


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

$tag

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

Default value: ''


Top ↑

Return

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


Top ↑

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
VersionDescription
2.3.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.