Adds metadata to a term.
Parameters
$term_id
intrequired- Term ID.
$meta_key
stringrequired- Metadata name.
$meta_value
mixedrequired- Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database:
- false is stored and retrieved as an empty string (
''
) - true is stored and retrieved as
'1'
- numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.
- false is stored and retrieved as an empty string (
$unique
booloptional- Whether the same key should not be added.
Default:
false
Source
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 );
}
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |
Usage
Example
Adds a new custom field with a key name ‘my_term_key’ and value as ‘new_term’