WP_REST_Meta_Fields::update_meta_value( int $object_id, string $meta_key, string $name, mixed $value ): true|WP_Error
Updates a meta value for an object.
Parameters
-
$object_id
int Required -
Object ID to update.
-
$meta_key
string Required -
Key for the custom field.
-
$name
string Required -
Name for the field that is exposed in the REST API.
-
$value
mixed Required -
Updated value.
Return
true|WP_Error True if the meta field was updated, WP_Error otherwise.
Source
File: wp-includes/rest-api/fields/class-wp-rest-meta-fields.php
.
View all references
protected function update_meta_value( $object_id, $meta_key, $name, $value ) {
$meta_type = $this->get_meta_type();
// Do the exact same check for a duplicate value as in update_metadata() to avoid update_metadata() returning false.
$old_value = get_metadata( $meta_type, $object_id, $meta_key );
$subtype = get_object_subtype( $meta_type, $object_id );
if ( is_array( $old_value ) && 1 === count( $old_value )
&& $this->is_meta_value_same_as_stored_value( $meta_key, $subtype, $old_value[0], $value )
) {
return true;
}
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(),
)
);
}
if ( ! update_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,
)
);
}
return true;
}
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |