Retrieves metadata for a term.

$term_id int Required

Term ID.

$key string Optional

The meta key to retrieve. By default, returns data for all keys.

Default: ''

$single bool Optional

Whether to return a single value.
This parameter has no effect if $key is not specified.

Default: false

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.

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 );
}