<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[41758] trunk: REST API: Support objects in settings schema.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/41758">41758</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/41758","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-05 00:18:44 +0000 (Thu, 05 Oct 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/38583">#38583</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestsettingscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestsettingscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2017-10-05 00:01:09 UTC (rev 41757)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2017-10-05 00:18:44 UTC (rev 41758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -545,7 +545,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $endpoint_args[ $field_id ]['required'] = true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'type', 'format', 'enum', 'items' ) as $schema_prop ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'type', 'format', 'enum', 'items', 'properties' ) as $schema_prop ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $params[ $schema_prop ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestsettingscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php 2017-10-05 00:01:09 UTC (rev 41757)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php 2017-10-05 00:18:44 UTC (rev 41758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,23 +119,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed The prepared value.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_value( $value, $schema ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the value is not a scalar, it's not possible to cast it to anything.
- if ( ! is_scalar( $value ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the value is not valid by the schema, set the value to null. Null
+ // values are specifcally non-destructive so this will not cause overwriting
+ // the current invalid value to null.
+ if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return null;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- 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;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return rest_sanitize_value_from_schema( $value, $schema );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,6 +138,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_item( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $options = $this->get_registered_options();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params = $request->get_params();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $options as $name => $args ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,12 +178,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * To protect clients from accidentally including the null
</span><span class="cx" style="display: block; padding: 0 10px"> * values from a response object in a request, we do not allow
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * options with non-scalar values to be updated to null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * options with values that don't pass validation to be updated to null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Without this added protection a client could mistakenly
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * delete all options that have non-scalar values from the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * delete all options that have invalid values from the
</ins><span class="cx" style="display: block; padding: 0 10px"> * database.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_scalar( get_option( $args['option_name'], false ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( rest_validate_value_from_schema( get_option( $args['option_name'], false ), $args['schema'] ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'rest_invalid_stored_value', sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ), array( 'status' => 500 )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,7 +244,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Whitelist the supported types for settings, as we don't want invalid types
</span><span class="cx" style="display: block; padding: 0 10px"> * to be updated with arbitrary values that we can't do decent sanitizing for.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'integer', 'string', 'boolean' ), true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! in_array( $rest_args['schema']['type'], array( 'number', 'integer', 'string', 'boolean', 'array', 'object' ), true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestsettingscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php 2017-10-05 00:01:09 UTC (rev 41757)
+++ trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php 2017-10-05 00:18:44 UTC (rev 41758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,6 +127,93 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_setting( 'somegroup', 'mycustomsetting' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_item_with_custom_array_setting() {
+ wp_set_current_user( self::$administrator );
+
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ ),
+ 'type' => 'array',
+ ) );
+
+ // Array is cast to correct types.
+ update_option( 'mycustomsetting', array( '1', '2' ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array( 1, 2 ), $data['mycustomsetting'] );
+
+ // Empty array works as expected.
+ update_option( 'mycustomsetting', array() );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array(), $data['mycustomsetting'] );
+
+ // Invalid value
+ update_option( 'mycustomsetting', array( array( 1 ) ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( null, $data['mycustomsetting'] );
+
+ // No option value
+ delete_option( 'mycustomsetting' );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( null, $data['mycustomsetting'] );
+
+ unregister_setting( 'somegroup', 'mycustomsetting' );
+ }
+
+ public function test_get_item_with_custom_object_setting() {
+ wp_set_current_user( self::$administrator );
+
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ ),
+ ),
+ 'type' => 'object',
+ ) );
+
+ // Object is cast to correct types.
+ update_option( 'mycustomsetting', array( 'a' => '1' ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array( 'a' => 1 ), $data['mycustomsetting'] );
+
+ // Empty array works as expected.
+ update_option( 'mycustomsetting', array() );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array(), $data['mycustomsetting'] );
+
+ // Invalid value
+ update_option( 'mycustomsetting', array( 'a' => 1, 'b' => 2 ) );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array( 'a' => 1 ), $data['mycustomsetting'] );
+
+ unregister_setting( 'somegroup', 'mycustomsetting' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function get_setting_custom_callback( $result, $name, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'mycustomsetting1':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -215,6 +302,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( null, $data['mycustomsettinginrest'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unregister_setting( 'somegroup', 'mycustomsetting' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -242,6 +330,91 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_update_item_with_array() {
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ ),
+ 'type' => 'array',
+ ) );
+
+ // We have to re-register the route, as the args changes based off registered settings.
+ $this->server->override_by_default = true;
+ $this->endpoint->register_routes();
+ wp_set_current_user( self::$administrator );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array( '1', '2' ) );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array( 1, 2 ), $data['mycustomsetting'] );
+ $this->assertEquals( array( 1, 2 ), get_option( 'mycustomsetting' ) );
+
+ // Setting an empty array.
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array() );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array(), $data['mycustomsetting'] );
+ $this->assertEquals( array(), get_option( 'mycustomsetting' ) );
+
+ // Setting an invalid array.
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array( 'invalid' ) );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ unregister_setting( 'somegroup', 'mycustomsetting' );
+ }
+
+ public function test_update_item_with_object() {
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ ),
+ ),
+ 'type' => 'object',
+ ) );
+
+ // We have to re-register the route, as the args changes based off registered settings.
+ $this->server->override_by_default = true;
+ $this->endpoint->register_routes();
+ wp_set_current_user( self::$administrator );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array( 'a' => 1 ) );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array( 'a' => 1 ), $data['mycustomsetting'] );
+ $this->assertEquals( array( 'a' => 1 ), get_option( 'mycustomsetting' ) );
+
+ // Setting an empty object.
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array() );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( array(), $data['mycustomsetting'] );
+ $this->assertEquals( array(), get_option( 'mycustomsetting' ) );
+
+ // Setting an invalid object.
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', array( 'a' => 'invalid' ) );
+ $response = $this->server->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ unregister_setting( 'somegroup', 'mycustomsetting' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_item_with_filter() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$administrator );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>