WP_REST_Meta_Fields::update_meta_value( int $object_id, string $meta_key, string $name, mixed $value )

Updates a meta value for an object.


Parameters 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.


Top ↑

Return Return

(bool|WP_Error) True if the meta field was updated, WP_Error otherwise.



Top ↑

Source Source

File: wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

	protected function update_meta_value( $object_id, $meta_key, $name, $value ) {
		$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(),
				)
			);
		}

		// 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 );
		$args      = $this->get_registered_fields()[ $meta_key ];

		if ( 1 === count( $old_value ) ) {
			$sanitized = sanitize_meta( $meta_key, $value, $meta_type, $subtype );

			if ( in_array( $args['type'], array( 'string', 'number', 'integer', 'boolean' ), true ) ) {
				// The return value of get_metadata will always be a string for scalar types.
				$sanitized = (string) $sanitized;
			}

			if ( $sanitized === $old_value[0] ) {
				return true;
			}
		}

		if ( ! update_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash_strings_only( $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;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.