update_term_meta() – Updates term metadata.
You appear to be a bot. Output may be restricted
Description
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.
Usage
$int|bool|WP_Error = update_term_meta( $term_id, $meta_key, $meta_value, $prev_value );
Parameters
- $term_id
- ( int ) required – Term ID.
- $meta_key
- ( string ) required – Metadata key.
- $meta_value
- ( mixed ) required – Metadata value. Must be serializable if non-scalar.
- $prev_value
- ( mixed ) optional – Optional. Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries. Default empty.
Returns
int|bool|WP_Error Meta ID if the key didn't exist. true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database. WP_Error when term_id is ambiguous between taxonomies.
Source
File name: wordpress/wp-includes/taxonomy.php
Lines:
1 to 7 of 7
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 ); }