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_idintrequired
Term ID.
$meta_keystringrequired
Metadata name.
$meta_valuemixedrequired
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.
$uniquebooloptional
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

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

VersionDescription
4.4.0Introduced.

User Contributed Notes

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