get_tag() WordPress Function
The get_tag() function in WordPress is used to retrieve a given tag object. A tag object is an instance of the class Tag_Cloud which represents a tag.
get_tag( int|WP_Term|object $tag, string $output = OBJECT, string $filter = 'raw' ) #
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
- $tag
(int|WP_Term|object)(Required)A tag ID or object.
- $output
(string)(Optional) 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 value: OBJECT
- $filter
(string)(Optional) How to sanitize tag fields.
Default value: '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
File: wp-includes/category.php
function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
return get_term( $tag, 'post_tag', $output, $filter );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.3.0 | Introduced. |