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 $key is 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 );
}

Uses

Uses Description
wp-includes/meta.php: get_metadata()

Retrieves the value of a metadata field for the specified object type and ID.

Changelog

Version Description
4.4.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_term_meta