update_metadata
Update metadata for the specified object.
Description
(int|bool) update_metadata( (string) $meta_type, (int) $object_id, (string) $meta_key, (mixed) $meta_value, (string) $prev_value = '' );
If no value already exists for the specified object ID and metadata key, the metadata will be added.
Returns (int|bool)
Meta ID if the key didn't exist, true on successful update, false on failure.
Parameters (5)
- 0. $meta_type (string)
- Type of object metadata is for (e.g., comment, post, or user)
- 1. $object_id (int)
- ID of the object metadata is for
- 2. $meta_key (string)
- The meta key.
- 3. $meta_value (mixed)
- Metadata value. Must be serializable if non-scalar.
- 4. $prev_value — Optional. (string) =>
''
- If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.
Usage
if ( !function_exists( 'update_metadata' ) ) { require_once ABSPATH . WPINC . '/meta.php'; } // Type of object metadata is for (e.g., comment, post, or user) $meta_type = ''; // ID of the object metadata is for $object_id = -1; // The meta key. $meta_key = ''; // Metadata value. Must be serializable if non-scalar. $meta_value = null; // Optional. If specified, only update existing metadata entries with // the specified value. Otherwise, update all entries. $prev_value = ''; // NOTICE! Understand what this does before running. $result = update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/meta.php
- function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
- global $wpdb;
- if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) {
- return false;
- }
- $object_id = absint( $object_id );
- if ( ! $object_id ) {
- return false;
- }
- $table = _get_meta_table( $meta_type );
- if ( ! $table ) {
- return false;
- }
- $column = sanitize_key($meta_type . '_id');
- $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
- // expected_slashed ($meta_key)
- $raw_meta_key = $meta_key;
- $meta_key = wp_unslash($meta_key);
- $passed_value = $meta_value;
- $meta_value = wp_unslash($meta_value);
- $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
- /**
- * Filters whether to update metadata of a specific type.
- *
- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, or user). Returning a non-null value
- * will effectively short-circuit the function.
- *
- * @since 3.1.0
- *
- * @param null|bool $check Whether to allow updating metadata for the given type.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value. Must be serializable if non-scalar.
- * @param mixed $prev_value Optional. If specified, only update existing
- * metadata entries with the specified value.
- * Otherwise, update all entries.
- */
- $check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );
- if ( null !== $check )
- return (bool) $check;
- // Compare existing value to new value if no prev value given and the key exists only once.
- if ( empty($prev_value) ) {
- $old_value = get_metadata($meta_type, $object_id, $meta_key);
- if ( count($old_value) == 1 ) {
- if ( $old_value[0] === $meta_value )
- return false;
- }
- }
- $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) );
- if ( empty( $meta_ids ) ) {
- return add_metadata( $meta_type, $object_id, $raw_meta_key, $passed_value );
- }
- $_meta_value = $meta_value;
- $meta_value = maybe_serialize( $meta_value );
- $data = compact( 'meta_value' );
- $where = array( $column => $object_id, 'meta_key' => $meta_key );
- if ( !empty( $prev_value ) ) {
- $prev_value = maybe_serialize($prev_value);
- $where['meta_value'] = $prev_value;
- }
- foreach ( $meta_ids as $meta_id ) {
- /**
- * Fires immediately before updating metadata of a specific type.
- *
- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, or user).
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of the metadata entry to update.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
- if ( 'post' == $meta_type ) {
- /**
- * Fires immediately before updating a post's metadata.
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of metadata entry to update.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
- }
- }
- $result = $wpdb->update( $table, $data, $where );
- if ( ! $result )
- return false;
- wp_cache_delete($object_id, $meta_type . '_meta');
- foreach ( $meta_ids as $meta_id ) {
- /**
- * Fires immediately after updating metadata of a specific type.
- *
- * The dynamic portion of the hook, `$meta_type`, refers to the meta
- * object type (comment, post, or user).
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of updated metadata entry.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
- if ( 'post' == $meta_type ) {
- /**
- * Fires immediately after updating a post's metadata.
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of updated metadata entry.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
- }
- }
- return true;
- }