<!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>[41727] trunk: REST API: Support for objects in schema validation and sanitization.</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/41727">41727</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/41727","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joehoyle</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-04 08:26:44 +0000 (Wed, 04 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 for objects in schema validation and sanitization.
When registering routes developers can now define their complex objects in the schema and benefit from the automatic validation and sanitization in the REST API. This also paves the way for support for complex object registration via register_meta and register_setting.
See <a href="https://core.trac.wordpress.org/ticket/38583">#38583</a>.
Props TimothyBlynJacobs5.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemasanitizationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemavalidationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></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-attachments-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-attachments-controller.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -391,6 +391,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,6 +414,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp"></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-comments-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-comments-controller.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1200,6 +1200,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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-posts-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-posts-controller.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1846,6 +1846,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1870,6 +1871,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1908,6 +1910,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit', 'embed' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'arg_options' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => array(
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/src/wp-includes/rest-api.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1051,6 +1051,28 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( 'object' === $args['type'] ) {
+ if ( $value instanceof stdClass ) {
+ $value = (array) $value;
+ }
+ if ( ! is_array( $value ) ) {
+ /* translators: 1: parameter, 2: type name */
+ return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
+ }
+
+ foreach ( $value as $property => $v ) {
+ if ( ! isset( $args['properties'][ $property ] ) ) {
+ continue;
+ }
+ $is_valid = rest_validate_value_from_schema( $v, $args['properties'][ $property ], $param . '[' . $property . ']' );
+
+ if ( is_wp_error( $is_valid ) ) {
+ return $is_valid;
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $args['enum'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $value, $args['enum'], true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: 1: parameter, 2: list of valid values */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1170,6 +1192,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = array_values( $value );
</span><span class="cx" style="display: block; padding: 0 10px"> return $value;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( 'object' === $args['type'] ) {
+ if ( $value instanceof stdClass ) {
+ $value = (array) $value;
+ }
+ if ( ! is_array( $value ) ) {
+ return array();
+ }
+
+ foreach ( $value as $property => $v ) {
+ if ( ! isset( $args['properties'][ $property ] ) ) {
+ unset( $value[ $property ] );
+ continue;
+ }
+ $value[ $property ] = rest_sanitize_value_from_schema( $v, $args['properties'][ $property ] );
+ }
+
+ return $value;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'integer' === $args['type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return (int) $value;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemasanitizationphp"></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-schema-sanitization.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,6 +146,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( '1', '2' ), rest_sanitize_value_from_schema( array( 'first' => '1', 'second' => '2' ), $schema ) );
</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_type_object() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'number'
+ ),
+ ),
+ );
+ $this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => 1 ), $schema ) );
+ $this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => '1' ), $schema ) );
+ }
+
+ public function test_type_object_nested() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'b' => array( 'type' => 'number' ),
+ 'c' => array( 'type' => 'number' ),
+ )
+ )
+ ),
+ );
+
+ $this->assertEquals(
+ array(
+ 'a' => array(
+ 'b' => 1,
+ 'c' => 3,
+ ),
+ ),
+ rest_sanitize_value_from_schema(
+ array(
+ 'a' => array(
+ 'b' => '1',
+ 'c' => '3',
+ ),
+ ),
+ $schema
+ )
+ );
+ $this->assertEquals(
+ array(
+ 'a' => array(
+ 'b' => 1,
+ 'c' => 3,
+ ),
+ ),
+ rest_sanitize_value_from_schema(
+ array(
+ 'a' => array(
+ 'b' => '1',
+ 'c' => '3',
+ 'd' => '1',
+ ),
+ 'b' => 1,
+ ),
+ $schema
+ )
+ );
+ $this->assertEquals( array( 'a' => array() ), rest_sanitize_value_from_schema( array( 'a' => null ), $schema ) );
+ }
+
+ public function test_type_object_stdclass() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'number'
+ ),
+ ),
+ );
+ $this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( (object) array( 'a' => '1' ), $schema ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_type_unknown() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'lalala',
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemavalidationphp"></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-schema-validation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2017-10-04 06:47:37 UTC (rev 41726)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2017-10-04 08:26:44 UTC (rev 41727)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -181,6 +181,59 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( rest_validate_value_from_schema( array( 'first' => '1', 'second' => '2' ), $schema ) );
</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_type_object() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'number'
+ ),
+ ),
+ );
+ $this->assertTrue( rest_validate_value_from_schema( array( 'a' => 1 ), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( array( 'a' => 'invalid' ), $schema ) );
+ }
+
+ public function test_type_object_nested() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'b' => array( 'type' => 'number' ),
+ 'c' => array( 'type' => 'number' ),
+ )
+ )
+ ),
+ );
+ $this->assertTrue(
+ rest_validate_value_from_schema(
+ array(
+ 'a' => array(
+ 'b' => '1',
+ 'c' => 3,
+ ),
+ ),
+ $schema
+ )
+ );
+ $this->assertWPError( rest_validate_value_from_schema( array( 'a' => array( 'b' => 1, 'c' => 'invalid' ) ), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( array( 'a' => 1 ), $schema ) );
+ }
+
+ public function test_type_object_stdclass() {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'number'
+ ),
+ ),
+ );
+ $this->assertTrue( rest_validate_value_from_schema( (object) array( 'a' => 1 ), $schema ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_type_unknown() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'lalala',
</span></span></pre>
</div>
</div>
</body>
</html>