get_term_meta( int $term_id, string $key = '', bool $single = false )
Retrieves metadata for a term.
Description
Parameters
- $term_id
-
(int) (Required) Term ID.
- $key
-
(string) (Optional) The meta key to retrieve. If no key is provided, fetches all metadata for the term.
Default value: ''
- $single
-
(bool) (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 ) { return get_metadata( 'term', $term_id, $key, $single ); }
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |