mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-27 14:53:08 +02:00
REST API: Support 'object' and 'array' types in register_meta() schemas.
Extends meta registration to support complex schema values, mirroring the functionality in the settings controller. Error when trying to modify a meta key containing schema-nonconformant data. Props @TimothyBlynJacobs, @birgire, @mnelson4, @flixos90. Fixes #43392. Built from https://develop.svn.wordpress.org/trunk@45807 git-svn-id: http://core.svn.wordpress.org/trunk@45618 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
ab0b860db9
commit
5b318f1dda
@ -1159,6 +1159,11 @@ function rest_validate_value_from_schema( $value, $args, $param = '' ) {
|
|||||||
if ( $value instanceof stdClass ) {
|
if ( $value instanceof stdClass ) {
|
||||||
$value = (array) $value;
|
$value = (array) $value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ( $value instanceof JsonSerializable ) {
|
||||||
|
$value = $value->jsonSerialize();
|
||||||
|
}
|
||||||
|
|
||||||
if ( ! is_array( $value ) ) {
|
if ( ! is_array( $value ) ) {
|
||||||
/* translators: 1: parameter, 2: type name */
|
/* translators: 1: parameter, 2: type name */
|
||||||
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
|
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
|
||||||
@ -1170,9 +1175,18 @@ function rest_validate_value_from_schema( $value, $args, $param = '' ) {
|
|||||||
if ( is_wp_error( $is_valid ) ) {
|
if ( is_wp_error( $is_valid ) ) {
|
||||||
return $is_valid;
|
return $is_valid;
|
||||||
}
|
}
|
||||||
} elseif ( isset( $args['additionalProperties'] ) && false === $args['additionalProperties'] ) {
|
} elseif ( isset( $args['additionalProperties'] ) ) {
|
||||||
|
if ( false === $args['additionalProperties'] ) {
|
||||||
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not a valid property of Object.' ), $property ) );
|
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not a valid property of Object.' ), $property ) );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ( is_array( $args['additionalProperties'] ) ) {
|
||||||
|
$is_valid = rest_validate_value_from_schema( $v, $args['additionalProperties'], $param . '[' . $property . ']' );
|
||||||
|
if ( is_wp_error( $is_valid ) ) {
|
||||||
|
return $is_valid;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1298,6 +1312,11 @@ function rest_sanitize_value_from_schema( $value, $args ) {
|
|||||||
if ( $value instanceof stdClass ) {
|
if ( $value instanceof stdClass ) {
|
||||||
$value = (array) $value;
|
$value = (array) $value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ( $value instanceof JsonSerializable ) {
|
||||||
|
$value = $value->jsonSerialize();
|
||||||
|
}
|
||||||
|
|
||||||
if ( ! is_array( $value ) ) {
|
if ( ! is_array( $value ) ) {
|
||||||
return array();
|
return array();
|
||||||
}
|
}
|
||||||
@ -1305,8 +1324,12 @@ function rest_sanitize_value_from_schema( $value, $args ) {
|
|||||||
foreach ( $value as $property => $v ) {
|
foreach ( $value as $property => $v ) {
|
||||||
if ( isset( $args['properties'][ $property ] ) ) {
|
if ( isset( $args['properties'][ $property ] ) ) {
|
||||||
$value[ $property ] = rest_sanitize_value_from_schema( $v, $args['properties'][ $property ] );
|
$value[ $property ] = rest_sanitize_value_from_schema( $v, $args['properties'][ $property ] );
|
||||||
} elseif ( isset( $args['additionalProperties'] ) && false === $args['additionalProperties'] ) {
|
} elseif ( isset( $args['additionalProperties'] ) ) {
|
||||||
|
if ( false === $args['additionalProperties'] ) {
|
||||||
unset( $value[ $property ] );
|
unset( $value[ $property ] );
|
||||||
|
} elseif ( is_array( $args['additionalProperties'] ) ) {
|
||||||
|
$value[ $property ] = rest_sanitize_value_from_schema( $v, $args['additionalProperties'] );
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -143,6 +143,21 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
* from the database and then relying on the default value.
|
* from the database and then relying on the default value.
|
||||||
*/
|
*/
|
||||||
if ( is_null( $meta[ $name ] ) ) {
|
if ( is_null( $meta[ $name ] ) ) {
|
||||||
|
$args = $this->get_registered_fields()[ $meta_key ];
|
||||||
|
|
||||||
|
if ( $args['single'] ) {
|
||||||
|
$current = get_metadata( $this->get_meta_type(), $object_id, $meta_key, true );
|
||||||
|
|
||||||
|
if ( is_wp_error( rest_validate_value_from_schema( $current, $args['schema'] ) ) ) {
|
||||||
|
return new WP_Error(
|
||||||
|
'rest_invalid_stored_value',
|
||||||
|
/* translators: %s: custom field key */
|
||||||
|
sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ),
|
||||||
|
array( 'status' => 500 )
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$result = $this->delete_meta_value( $object_id, $meta_key, $name );
|
$result = $this->delete_meta_value( $object_id, $meta_key, $name );
|
||||||
if ( is_wp_error( $result ) ) {
|
if ( is_wp_error( $result ) ) {
|
||||||
return $result;
|
return $result;
|
||||||
@ -150,13 +165,24 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
$is_valid = rest_validate_value_from_schema( $meta[ $name ], $args['schema'], 'meta.' . $name );
|
$value = $meta[ $name ];
|
||||||
|
|
||||||
|
if ( ! $args['single'] && is_array( $value ) && count( array_filter( $value, 'is_null' ) ) ) {
|
||||||
|
return new WP_Error(
|
||||||
|
'rest_invalid_stored_value',
|
||||||
|
/* translators: %s: custom field key */
|
||||||
|
sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ),
|
||||||
|
array( 'status' => 500 )
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
$is_valid = rest_validate_value_from_schema( $value, $args['schema'], 'meta.' . $name );
|
||||||
if ( is_wp_error( $is_valid ) ) {
|
if ( is_wp_error( $is_valid ) ) {
|
||||||
$is_valid->add_data( array( 'status' => 400 ) );
|
$is_valid->add_data( array( 'status' => 400 ) );
|
||||||
return $is_valid;
|
return $is_valid;
|
||||||
}
|
}
|
||||||
|
|
||||||
$value = rest_sanitize_value_from_schema( $meta[ $name ], $args['schema'] );
|
$value = rest_sanitize_value_from_schema( $value, $args['schema'] );
|
||||||
|
|
||||||
if ( $args['single'] ) {
|
if ( $args['single'] ) {
|
||||||
$result = $this->update_meta_value( $object_id, $meta_key, $name, $value );
|
$result = $this->update_meta_value( $object_id, $meta_key, $name, $value );
|
||||||
@ -260,8 +286,10 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
unset( $to_add[ $add_key ] );
|
unset( $to_add[ $add_key ] );
|
||||||
}
|
}
|
||||||
|
|
||||||
// `delete_metadata` removes _all_ instances of the value, so only call once.
|
// `delete_metadata` removes _all_ instances of the value, so only call once. Otherwise,
|
||||||
$to_remove = array_unique( $to_remove );
|
// `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 ) {
|
foreach ( $to_remove as $value ) {
|
||||||
if ( ! delete_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash( $value ) ) ) {
|
if ( ! delete_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash( $value ) ) ) {
|
||||||
@ -393,15 +421,21 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
$type = ! empty( $rest_args['type'] ) ? $rest_args['type'] : null;
|
$type = ! empty( $rest_args['type'] ) ? $rest_args['type'] : null;
|
||||||
$type = ! empty( $rest_args['schema']['type'] ) ? $rest_args['schema']['type'] : $type;
|
$type = ! empty( $rest_args['schema']['type'] ) ? $rest_args['schema']['type'] : $type;
|
||||||
|
|
||||||
if ( ! in_array( $type, array( 'string', 'boolean', 'integer', 'number' ) ) ) {
|
if ( null === $rest_args['schema']['default'] ) {
|
||||||
|
$rest_args['schema']['default'] = $this->get_default_for_type( $type );
|
||||||
|
}
|
||||||
|
|
||||||
|
$rest_args['schema'] = $this->default_additional_properties_to_false( $rest_args['schema'] );
|
||||||
|
|
||||||
|
if ( ! in_array( $type, array( 'string', 'boolean', 'integer', 'number', 'array', 'object' ) ) ) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if ( empty( $rest_args['single'] ) ) {
|
if ( empty( $rest_args['single'] ) ) {
|
||||||
$rest_args['schema']['items'] = array(
|
$rest_args['schema'] = array(
|
||||||
'type' => $rest_args['type'],
|
'type' => 'array',
|
||||||
|
'items' => $rest_args['schema'],
|
||||||
);
|
);
|
||||||
$rest_args['schema']['type'] = 'array';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$registered[ $name ] = $rest_args;
|
$registered[ $name ] = $rest_args;
|
||||||
@ -452,34 +486,18 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
* @return mixed Value prepared for output. If a non-JsonSerializable object, null.
|
* @return mixed Value prepared for output. If a non-JsonSerializable object, null.
|
||||||
*/
|
*/
|
||||||
public static function prepare_value( $value, $request, $args ) {
|
public static function prepare_value( $value, $request, $args ) {
|
||||||
$type = $args['schema']['type'];
|
|
||||||
|
|
||||||
// For multi-value fields, check the item type instead.
|
if ( $args['single'] ) {
|
||||||
if ( 'array' === $type && ! empty( $args['schema']['items']['type'] ) ) {
|
$schema = $args['schema'];
|
||||||
$type = $args['schema']['items']['type'];
|
} else {
|
||||||
|
$schema = $args['schema']['items'];
|
||||||
}
|
}
|
||||||
|
|
||||||
switch ( $type ) {
|
if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
|
||||||
case 'string':
|
|
||||||
$value = (string) $value;
|
|
||||||
break;
|
|
||||||
case 'integer':
|
|
||||||
$value = (int) $value;
|
|
||||||
break;
|
|
||||||
case 'number':
|
|
||||||
$value = (float) $value;
|
|
||||||
break;
|
|
||||||
case 'boolean':
|
|
||||||
$value = (bool) $value;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't allow objects to be output.
|
|
||||||
if ( is_object( $value ) && ! ( $value instanceof JsonSerializable ) ) {
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
return $value;
|
return rest_sanitize_value_from_schema( $value, $schema );
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -499,4 +517,63 @@ abstract class WP_REST_Meta_Fields {
|
|||||||
|
|
||||||
return $value;
|
return $value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting
|
||||||
|
* is specified.
|
||||||
|
*
|
||||||
|
* This is needed to restrict properties of objects in meta values to only
|
||||||
|
* registered items, as the REST API will allow additional properties by
|
||||||
|
* default.
|
||||||
|
*
|
||||||
|
* @since 5.3.0
|
||||||
|
*
|
||||||
|
* @param array $schema The schema array.
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function default_additional_properties_to_false( $schema ) {
|
||||||
|
switch ( $schema['type'] ) {
|
||||||
|
case 'object':
|
||||||
|
foreach ( $schema['properties'] as $key => $child_schema ) {
|
||||||
|
$schema['properties'][ $key ] = $this->default_additional_properties_to_false( $child_schema );
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( ! isset( $schema['additionalProperties'] ) ) {
|
||||||
|
$schema['additionalProperties'] = false;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'array':
|
||||||
|
$schema['items'] = $this->default_additional_properties_to_false( $schema['items'] );
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $schema;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the default value for a schema type.
|
||||||
|
*
|
||||||
|
* @since 5.3.0
|
||||||
|
*
|
||||||
|
* @param string $type
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
protected function get_default_for_type( $type ) {
|
||||||
|
switch ( $type ) {
|
||||||
|
case 'string':
|
||||||
|
return '';
|
||||||
|
case 'boolean':
|
||||||
|
return false;
|
||||||
|
case 'integer':
|
||||||
|
return 0;
|
||||||
|
case 'number':
|
||||||
|
return 0.0;
|
||||||
|
case 'array':
|
||||||
|
return array();
|
||||||
|
case 'object':
|
||||||
|
return array();
|
||||||
|
default:
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -13,7 +13,7 @@
|
|||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '5.3-alpha-45806';
|
$wp_version = '5.3-alpha-45807';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
Loading…
Reference in New Issue
Block a user