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

Parameters

$term_idint

Term ID.

$meta_keystring

Metadata name.

$meta_valuemixed

Metadata value. Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added. Default false.Default: false

Return

int|false|WP_Error

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

Uses · 4

• wp_term_is_shared()Determines whether a term is shared between multiple taxonomies.
• __()Retrieves the translation of $text.
• add_metadata()Adds metadata for the specified object.
• WP_Error::__construct()Initializes the error.

Used by · 1

• wp_xmlrpc_server::set_term_custom_fields()Sets custom fields for a term.

Source

View on Trac ↗View on GitHub ↗

1395function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {1396	if ( wp_term_is_shared( $term_id ) ) {1397		return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id );1398	}1399 1400	return add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );1401}

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.