get_term_meta() WordPress Function
The get_term_meta() function is used to retrieve metadata for a given term. This function can be used to retrieve metadata for terms in any taxonomy. The first parameter is the term ID, and the second parameter is the key for the metadata you wish to retrieve.
get_term_meta( int $term_id, string $key = '', bool $single = false ) #
Retrieves metadata for a term.
Parameters
- $term_id
(int)(Required)Term ID.
- $key
(string)(Optional) The meta key to retrieve. By default, returns data for all keys.
Default value: ''
- $single
(bool)(Optional) Whether to return a single value. This parameter has no effect if
$keyis not specified.Default value: false
Return
(mixed) An array of values if $single is false. The value of the meta field if $single is true. False for an invalid $term_id (non-numeric, zero, or negative value). An empty string if a valid but non-existing term ID is passed.
Source
File: wp-includes/taxonomy.php
function get_term_meta( $term_id, $key = '', $single = false ) {
return get_metadata( 'term', $term_id, $key, $single );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |