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

Adds metadata to a term.

Description Description

Parameters Parameters


(int) (Required) Term ID.


(string) (Required) Metadata name.


(mixed) (Required) Metadata value.


(bool) (Optional) Whether to bail if an entry with the same key is found for the term.

Default value: false

Top ↑

Return Return

(int|WP_Error|bool) Meta ID on success. WP_Error when term_id is ambiguous between taxonomies. False on failure.

Top ↑

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

Top ↑

Changelog Changelog

Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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