add_term_meta() WordPress Function
The add_term_meta() function allows you to add meta data to a term. This is useful for storing extra data related to a term, such as a custom field. The first parameter is the term ID, and the second parameter is the meta key. The third parameter is the meta value, which can be either a string or an array.
add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false ) #
Adds metadata to a term.
Parameters
- $term_id
(int)(Required)Term ID.
- $meta_key
(string)(Required)Metadata name.
- $meta_value
(mixed)(Required)Metadata value. Must be serializable if non-scalar.
- $unique
(bool)(Optional) Whether the same key should not be added.
Default value: false
Return
(int|false|WP_Error) Meta ID on success, false on failure. WP_Error when term_id is ambiguous between taxonomies.
Source
File: wp-includes/taxonomy.php
function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
if ( wp_term_is_shared( $term_id ) ) {
return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id );
}
return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |