A WordPress-centric search engine for devs and theme authors



add_term_meta ›

Since4.4.0
Deprecatedn/a
add_term_meta ( $term_id, $meta_key, $meta_value, $unique = false )
Parameters: (4)
  • (int) $term_id Term ID.
    Required: Yes
  • (string) $meta_key Metadata name.
    Required: Yes
  • (mixed) $meta_value Metadata value.
    Required: Yes
  • (bool) $unique Optional. Whether to bail if an entry with the same key is found for the term. Default false.
    Required: No
    Default: false
Returns:
  • (int|WP_Error|bool) Meta ID on success. WP_Error when term_id is ambiguous between taxonomies. False on failure.
Defined at:
Codex:

Adds metadata to a term.



Source

function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
	// 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 );
	}

	$added = add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );

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

	return $added;
}