update_term_meta( int $term_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

Updates term metadata.

Description

Use the $prev_value parameter to differentiate between meta fields with the same key and term ID.

If the meta field for the term does not exist, it will be added.

Parameters

$term_id

(int) (Required) Term ID.

$meta_key

(string) (Required) Metadata key.

$meta_value

(mixed) (Required) Metadata value. Must be serializable if non-scalar.

$prev_value

(mixed) (Optional) Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries.

Default value: ''

Return

(int|bool|WP_Error) Meta ID if the key didn't exist. true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database. WP_Error when term_id is ambiguous between taxonomies.

Source

File: wp-includes/taxonomy.php 

function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
	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 update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
}

Uses

Uses Description
wp-includes/taxonomy.php: wp_term_is_shared()

Determine whether a term is shared between multiple taxonomies.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/meta.php: update_metadata()

Updates metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initializes the error.

Changelog

Version Description
4.4.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_term_meta