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. If no key is provided, fetches all metadata for the term.

Default value: ''

$single

(Optional) Whether to return a single value. If false, an array of all values matching the $term_id/$key pair will be returned. Default: false.

Default value: false

Return

(mixed) If $single is false, an array of metadata values. If $single is true, a single metadata value.

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

Related

Uses

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

Retrieve metadata for the specified object.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Changelog

Changelog
Version Description
WP-4.4.0 Introduced.