WP_REST_Meta_Fields::is_meta_value_same_as_stored_value( string $meta_key, string $subtype, mixed $stored_value, mixed $user_value ): bool

In this article

Checks if the user provided value is equivalent to a stored value for the given meta key.

Parameters

$meta_keystringrequired
The meta key being checked.
$subtypestringrequired
The object subtype.
$stored_valuemixedrequired
The currently stored value retrieved from get_metadata() .
$user_valuemixedrequired
The value provided by the user.

Return

bool

Source

protected function is_meta_value_same_as_stored_value( $meta_key, $subtype, $stored_value, $user_value ) {
	$args      = $this->get_registered_fields()[ $meta_key ];
	$sanitized = sanitize_meta( $meta_key, $user_value, $this->get_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;
	}

	return $sanitized === $stored_value;
}

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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