A WordPress-centric search engine for devs and theme authors

update_term_meta ›

update_term_meta ( $term_id, $meta_key, $meta_value, $prev_value = '' )
Parameters: (4)
  • (int) $term_id Term ID.
    Required: Yes
  • (string) $meta_key Metadata key.
    Required: Yes
  • (mixed) $meta_value Metadata value. Must be serializable if non-scalar.
    Required: Yes
  • (mixed) $prev_value Optional. Previous value to check before updating. Default empty.
    Required: No
    Default: (empty)
  • (int|bool|WP_Error) Meta ID if the key didn't exist. true on successful update, false on failure. WP_Error when term_id is ambiguous between taxonomies.
Defined at:

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.


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