add_term_meta( int $term_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false|WP_Error

Adds metadata to a term.


$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: false

Top ↑


int|false|WP_Error Meta ID on success, false on failure.
WP_Error when term_id is ambiguous between taxonomies.

Top ↑


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 );

Top ↑


Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.