get_term_meta( int $term_id, string $key = '', bool $single = false ): mixed
Retrieves metadata for a term.
Parameters
-
$term_idint Required -
Term ID.
-
$keystring Optional -
The meta key to retrieve. By default, returns data for all keys.
Default:
'' -
$singlebool Optional -
Whether to return a single value.
This parameter has no effect if$keyis not specified.
Default:
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.
View all references
function get_term_meta( $term_id, $key = '', $single = false ) {
return get_metadata( 'term', $term_id, $key, $single );
}
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |
User Contributed Notes
-
Skip to note 1 content You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this noteContributed by Adil Elsaeed —
-
Skip to note 2 content You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this noteContributed by Daniyal Ahmed (a11n) —