add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false|WP_Error
Adds metadata to a term.
Parameters
-
$term_idint Required -
Term ID.
-
$meta_keystring Required -
Metadata name.
-
$meta_valuemixed Required -
Metadata value. Must be serializable if non-scalar.
-
$uniquebool Optional -
Whether the same key should not be added.
Default:
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.
View all references
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. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Usage
Example
Adds a new custom field with a key name ‘my_term_key’ and value as ‘new_term’