wpseek.com
A WordPress-centric search engine for devs and theme authors



add_term_meta › WordPress Function

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. Must be serializable if non-scalar.
    Required: Yes
  • (bool) $unique Optional. Whether the same key should not be added. Default false.
    Required: No
    Default: false
Returns:
  • (int|false|WP_Error) Meta ID on success, false on failure. WP_Error when term_id is ambiguous between taxonomies.
Defined at:
Codex:

Adds metadata to a term.



Related Functions: add_site_meta, add_user_meta, has_term_meta, add_post_meta, get_term_meta

Source 

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