get_term_meta( int $term_id, string $key = '', bool $single = false )

Retrieves metadata for a term.

Parameters

$term_id

(Required) Term ID.

$key

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

Default value: ''

$single

(Optional) Whether to return a single value.<br> This parameter has no effect if $key is not specified.<br>

Default value: false

Return

(mixed) An array of values if $single is false.<br> The value of the meta field if $single is true.<br> False for an invalid $term_id (non-numeric, zero, or negative value).<br> 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 ) {
	// Bail if term meta table is not installed.
	if ( get_option( 'db_version' ) < 34370 ) {
		return false;
	}

	return get_metadata( 'term', $term_id, $key, $single );
}

Expand Source Code View on GitHub

Changelog

Changelog
Version Description
4.4.0 Introduced.