W3cubDocs

/WordPress

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

Adds metadata to a term.

Description

Parameters

$term_id

(int) (Required) Term ID.

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Required) Metadata value.

$unique

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

Default value: false

Return

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

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

Changelog

Version Description
4.4.0 Introduced.

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