WordPress at a glance

update_term_meta() WP 1.0

Updates term metadata.

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.

No Hooks.

Return

Int/WP_Error/true/false. Meta ID if the key didn't previously exist. True on successful update. WP_Error when term_id is ambiguous between taxonomies. False on failure.

Usage

update_term_meta( $term_id, $meta_key, $meta_value, $prev_value );
$term_id(int) (required)
Term ID.
$meta_key(string) (required)
Metadata key.
$meta_value(mixed) (required)
Metadata value.
$prev_value(mixed)
Previous value to check before removing.
Default: ''

Code of update_term_meta: wp-includes/taxonomy.php VER 4.9.8

<?php
function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
	// Bail if term meta table is not installed.
	if ( get_option( 'db_version' ) < 34370 ) {
		return 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 );
	}

	$updated = update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );

	// Bust term query cache.
	if ( $updated ) {
		wp_cache_set( 'last_changed', microtime(), 'terms' );
	}

	return $updated;
}

Related Functions

From tag: Metadatas (any)

No comments
    Hello, !     Log In . Register