WP_REST_Meta_Fields::update_multi_meta_value( int $object_id, string $meta_key, string $name, array $values ): true|WP_Error
- Since
- 4.7.0, 6.7.0
- Source
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php:279
Description
Alters the list of values in the database to match the list of provided values.
Compatibility
- WordPress
- since 6.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$object_idint- Object ID to update.
$meta_keystring- Key for the custom field.
$namestring- Name for the field that is exposed in the REST API.
$valuesarray- List of values to update to.
Return value
true|WP_Error- True if meta fields are updated, WP_Error otherwise.
Performance profile
How much work a call to WP_REST_Meta_Fields::update_multi_meta_value() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 11
- Plugin surface
- None
- Called by
- 1
Reaches the database via get_term().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 166.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below WP_REST_Meta_Fields::update_multi_meta_value() - cacheobject cache
wp_cache_get()one call below WP_REST_Meta_Fields::update_multi_meta_value() - serializeserialisation
maybe_unserialize()one call below WP_REST_Meta_Fields::update_multi_meta_value() - querycontent query
get_term()one call below WP_REST_Meta_Fields::update_multi_meta_value()
Further down the call graph this can also reach option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Meta_Fields::update_multi_meta_value() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11 | ->is_meta_value_same_as_stored_value() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 166 | 11 | 12 | |
| 8.5 | 166 | 11 | 12 | |
| 8.4 | 166 | 11 | 12 | 1 fewer instruction than PHP 8.3 |
| 8.3 | 167 | 12 | 12 | |
| 8.2 | 167 | 12 | 12 | |
| 8.1 | 167 | 12 | 12 | 12 more instructions than PHP 7.4 |
| 7.4 | 155 | 33–83 | 12 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 11
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
- get_metadata_raw()Retrieves raw metadata value for the specified object.
- get_object_subtype()Returns the object subtype for a given object ID of a specific type.
- delete_metadata()Deletes metadata for the specified object.
- wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
- add_metadata()Adds metadata for the specified object.
- WP_REST_Meta_Fields::get_meta_type()Retrieves the object meta type.
- WP_Error::__construct()Initializes the error.
- WP_REST_Meta_Fields::is_meta_value_same_as_stored_value()Checks if the user provided value is equivalent to a stored value for the given meta key.
Used by · 1
- WP_REST_Meta_Fields::update_value()Updates meta values.
Source code
protected function update_multi_meta_value( $object_id, $meta_key, $name, $values ) { $meta_type = $this->get_meta_type(); if ( ! current_user_can( "edit_{$meta_type}_meta", $object_id, $meta_key ) ) { return new WP_Error( 'rest_cannot_update', /* translators: %s: Custom field key. */ sprintf( __( 'Sorry, you are not allowed to edit the %s custom field.' ), $name ), array( 'key' => $name, 'status' => rest_authorization_required_code(), ) ); } $current_values = get_metadata_raw( $meta_type, $object_id, $meta_key, false ); $subtype = get_object_subtype( $meta_type, $object_id ); if ( ! is_array( $current_values ) ) { $current_values = array(); } $to_remove = $current_values; $to_add = $values; foreach ( $to_add as $add_key => $value ) { $remove_keys = array_keys( array_filter( $current_values, function ( $stored_value ) use ( $meta_key, $subtype, $value ) { return $this->is_meta_value_same_as_stored_value( $meta_key, $subtype, $stored_value, $value ); } ) ); if ( empty( $remove_keys ) ) { continue; } if ( count( $remove_keys ) > 1 ) { // To remove, we need to remove first, then add, so don't touch. continue; } $remove_key = $remove_keys[0]; unset( $to_remove[ $remove_key ] ); unset( $to_add[ $add_key ] ); } /* * `delete_metadata` removes _all_ instances of the value, so only call once. Otherwise, * `delete_metadata` will return false for subsequent calls of the same value. * Use serialization to produce a predictable string that can be used by array_unique. */ $to_remove = array_map( 'maybe_unserialize', array_unique( array_map( 'maybe_serialize', $to_remove ) ) ); foreach ( $to_remove as $value ) { if ( ! delete_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash( $value ) ) ) { return new WP_Error( 'rest_meta_database_error', /* translators: %s: Custom field key. */ sprintf( __( 'Could not update the meta value of %s in database.' ), $meta_key ), array( 'key' => $name, 'status' => WP_Http::INTERNAL_SERVER_ERROR, ) ); } } foreach ( $to_add as $value ) { if ( ! add_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash( $value ) ) ) { return new WP_Error( 'rest_meta_database_error', /* translators: %s: Custom field key. */ sprintf( __( 'Could not update the meta value of %s in database.' ), $meta_key ), array( 'key' => $name, 'status' => WP_Http::INTERNAL_SERVER_ERROR,Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.