WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

REST API: Support objects in settings schema. 

Enables register_setting to accept an object as its schema value, allowing settings to accept non-scalar values through the REST API.
This whitelists the added type in the settings controller, and passes properties from argument registration into the validation functions.

Props joehoyle.
See #38583.


Built from https://develop.svn.wordpress.org/trunk@41758


git-svn-id: http://core.svn.wordpress.org/trunk@41592 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
K. Adam White 2017-10-05 00:19:49 +00:00
parent 9319a9cec9
commit 704fb3900b
3 changed files with 12 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/rest-api/endpoints/class-wp-rest-controller.php
View File

@ -545,7 +545,7 @@ abstract class WP_REST_Controller {
$endpoint_args[ $field_id ]['required'] = true; $endpoint_args[ $field_id ]['required'] = true;
} }
foreach ( array( 'type', 'format', 'enum', 'items' ) as $schema_prop ) { foreach ( array( 'type', 'format', 'enum', 'items', 'properties' ) as $schema_prop ) {
if ( isset( $params[ $schema_prop ] ) ) { if ( isset( $params[ $schema_prop ] ) ) {
$endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ]; $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
} }

29
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php
View File

@ -119,23 +119,13 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
* @return mixed The prepared value. * @return mixed The prepared value.
*/ */
protected function prepare_value( $value, $schema ) { protected function prepare_value( $value, $schema ) {
// If the value is not a scalar, it's not possible to cast it to anything. // If the value is not valid by the schema, set the value to null. Null
if ( ! is_scalar( $value ) ) { // values are specifcally non-destructive so this will not cause overwriting
return null; // the current invalid value to null.
} if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
switch ( $schema['type'] ) {
case 'string':
return (string) $value;
case 'integer':
return (int) $value;
case 'number':
return (float) $value;
case 'boolean':
return (bool) $value;
default:
return null; return null;
} }
return rest_sanitize_value_from_schema( $value, $schema );
} }
/** /**
@ -148,6 +138,7 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
*/ */
public function update_item( $request ) { public function update_item( $request ) {
$options = $this->get_registered_options(); $options = $this->get_registered_options();
$params = $request->get_params(); $params = $request->get_params();
foreach ( $options as $name => $args ) { foreach ( $options as $name => $args ) {
@ -187,12 +178,12 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
* *
* To protect clients from accidentally including the null * To protect clients from accidentally including the null
* values from a response object in a request, we do not allow * values from a response object in a request, we do not allow
* options with non-scalar values to be updated to null. * options with values that don't pass validation to be updated to null.
* Without this added protection a client could mistakenly * Without this added protection a client could mistakenly
* delete all options that have non-scalar values from the * delete all options that have invalid values from the
* database. * database.
*/ */
if ( ! is_scalar( get_option( $args['option_name'], false ) ) ) { if ( is_wp_error( rest_validate_value_from_schema( get_option( $args['option_name'], false ), $args['schema'] ) ) ) {
return new WP_Error( return new WP_Error(
'rest_invalid_stored_value', sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ), array( 'status' => 500 ) 'rest_invalid_stored_value', sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ), array( 'status' => 500 )
); );
@ -253,7 +244,7 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
* Whitelist the supported types for settings, as we don't want invalid types * Whitelist the supported types for settings, as we don't want invalid types
* to be updated with arbitrary values that we can't do decent sanitizing for. * to be updated with arbitrary values that we can't do decent sanitizing for.
*/ */
if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'integer', 'string', 'boolean' ), true ) ) { if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'integer', 'string', 'boolean', 'array', 'object' ), true ) ) {
continue; continue;
} }

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-41757'; $wp_version = '4.9-alpha-41758';
/** /**
* 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.