WordPress Developer Resources

get_tag( int|WP_Term|object $tag, string $output = OBJECT, string $filter = 'raw' ): WP_Term|array|WP_Error|null

Retrieves a post tag by tag ID or tag object.

Description

If you pass the $tag parameter an object, which is assumed to be the tag row object retrieved from the database, it will cache the tag data.

If you pass $tag an integer of the tag ID, then that tag will be retrieved from the database, if it isn’t already cached, and passed back.

If you look at get_term() , both types will be passed through several filters and finally sanitized based on the $filter parameter value.

Parameters

$tagint|WP_Term|objectrequired: A tag ID or object.
$outputstringoptional: The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively.
Default:OBJECT
$filterstringoptional: How to sanitize tag fields. Default 'raw'.
Default:'raw'

Return

WP_Term|array|WP_Error|null Tag data in type defined by $output parameter.
WP_Error if $tag is empty, null if it does not exist.

Source

 */
function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
	return get_term( $tag, 'post_tag', $output, $filter );

View all references View on Trac View on GitHub

Changelog

Version	Description
2.3.0	Introduced.

User Contributed Notes

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