mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-07 08:04:27 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

REST API: Add support for settings to specify their own additionalProperties.

Browse Source 
This switches the Settings Controller to use `rest_default_additional_properties_to_false` and deprecates its own method.

Props anna.bansaghi.
Fixes #56493.


git-svn-id: https://develop.svn.wordpress.org/trunk@54131 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2022-09-11 23:28:39 +00:00
parent 244a209480
commit b80ba269f6
2 changed files with 53 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -258,7 +258,7 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
continue;
}
$rest_args['schema'] = $this->set_additional_properties_to_false( $rest_args['schema'] );
$rest_args['schema'] = rest_default_additional_properties_to_false( $rest_args['schema'] );
$rest_options[ $rest_args['name'] ] = $rest_args;
}
@ -322,31 +322,22 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
}
/**
* Recursively add additionalProperties = false to all objects in a schema.
* Recursively add additionalProperties = false to all objects in a schema
* if no additionalProperties setting is specified.
*
* This is need to restrict properties of objects in settings values to only
* This is needed to restrict properties of objects in settings values to only
* registered items, as the REST API will allow additional properties by
* default.
*
* @since 4.9.0
* @deprecated 6.1.0 Use {@see rest_default_additional_properties_to_false()} instead.
*
* @param array $schema The schema array.
* @return array
*/
protected function set_additional_properties_to_false( $schema ) {
switch ( $schema['type'] ) {
case 'object':
foreach ( $schema['properties'] as $key => $child_schema ) {
$schema['properties'][ $key ] = $this->set_additional_properties_to_false( $child_schema );
}
_deprecated_function( __METHOD__, '6.1.0', 'rest_default_additional_properties_to_false()' );
$schema['additionalProperties'] = false;
break;
case 'array':
$schema['items'] = $this->set_additional_properties_to_false( $schema['items'] );
break;
}
return $schema;
return rest_default_additional_properties_to_false( $schema );
}
}

46
tests/phpunit/tests/rest-api/rest-settings-controller.php
View File

@ -737,4 +737,50 @@ class WP_Test_REST_Settings_Controller extends WP_Test_REST_Controller_Testcase
)
);
}
/**
* @ticket 56493
*/
public function test_register_setting_with_custom_additional_properties_value() {
wp_set_current_user( self::$administrator );
register_setting(
'somegroup',
'mycustomsetting',
array(
'type' => 'object',
'show_in_rest' => array(
'schema' => array(
'type' => 'object',
'properties' => array(
'test1' => array(
'type' => 'string',
),
),
'additionalProperties' => array(
'type' => 'integer',
),
),
),
)
);
$data = array(
'mycustomsetting' => array(
'test1' => 'my-string',
'test2' => '2',
'test3' => 3,
),
);
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
$request->add_header( 'content-type', 'application/json' );
$request->set_body( wp_json_encode( $data ) );
$response = rest_do_request( $request );
$this->assertSame( 200, $response->get_status() );
$this->assertSame( 'my-string', $response->data['mycustomsetting']['test1'] );
$this->assertSame( 2, $response->data['mycustomsetting']['test2'] );
$this->assertSame( 3, $response->data['mycustomsetting']['test3'] );
}
}