<!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>[48437] trunk: REST API: Sanitize block renderer attributes.</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 { white-space: pre-line; 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/48437">48437</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/48437","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-11 20:32:19 +0000 (Sat, 11 Jul 2020)</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: Sanitize block renderer attributes.
In <a href="https://core.trac.wordpress.org/changeset/48069">[48069]</a> the Block Renderer was changed to register a single route for all dynamic blocks. Validation was dynamically applied based on the requested block, but sanitization was not. This commit adds the same sanitization back to the block attributes.
Props manooweb.
Fixes <a href="https://core.trac.wordpress.org/ticket/50620">#50620</a>. See <a href="https://core.trac.wordpress.org/ticket/48079">#48079</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkpackagelockjson">trunk/package-lock.json</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestblockrenderercontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestblockrenderercontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-block-renderer-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkpackagelockjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/package-lock.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/package-lock.json 2020-07-11 12:28:07 UTC (rev 48436)
+++ trunk/package-lock.json 2020-07-11 20:32:19 UTC (rev 48437)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5939,7 +5939,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "kind-of": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "6.0.2",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "resolved": "",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz",
+ "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==",
</ins><span class="cx" style="display: block; padding: 0 10px"> "dev": true
</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">@@ -10566,7 +10567,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "kind-of": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "6.0.2",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "resolved": "",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz",
+ "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==",
</ins><span class="cx" style="display: block; padding: 0 10px"> "dev": true
</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">@@ -23584,7 +23586,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "kind-of": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "6.0.2",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "resolved": "",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.2.tgz",
+ "integrity": "sha512-s5kLOcnH0XqDO+FvuaLX8DDjZ18CGFk7VygH40QoKPUQhW4e2rvM0rwUq0t8IQDOwYSeLK01U90OjzBTme2QqA==",
</ins><span class="cx" style="display: block; padding: 0 10px"> "dev": true
</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="trunksrcwpincludesrestapiendpointsclasswprestblockrenderercontrollerphp"></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-block-renderer-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-block-renderer-controller.php 2020-07-11 12:28:07 UTC (rev 48436)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php 2020-07-11 20:32:19 UTC (rev 48437)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,6 +70,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_validate_value_from_schema( $value, $schema );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'sanitize_callback' => static function ( $value, $request ) {
+ $block = WP_Block_Type_Registry::get_instance()->get_registered( $request['name'] );
+
+ if ( ! $block ) {
+ // This will get rejected in ::get_item().
+ return true;
+ }
+
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => $block->get_attributes(),
+ 'additionalProperties' => false,
+ );
+
+ 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"> 'post_id' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'ID of the post context.' ),
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestblockrenderercontrollerphp"></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-block-renderer-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-block-renderer-controller.php 2020-07-11 12:28:07 UTC (rev 48436)
+++ trunk/tests/phpunit/tests/rest-api/rest-block-renderer-controller.php 2020-07-11 20:32:19 UTC (rev 48437)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +56,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $non_dynamic_block_name = 'core/non-dynamic';
</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">+ * Dynamic block with boolean attributes block name.
+ *
+ * @since 5.5.0
+ *
+ * @var string
+ */
+ protected static $dynamic_block_with_boolean_attributes_block_name = 'core/dynamic-block-with-boolean-attributes';
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test API user's ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,6 +136,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_test_block();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_post_context_test_block();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->register_non_dynamic_block();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->register_dynamic_block_with_boolean_attributes();
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</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">@@ -139,6 +149,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Block_Type_Registry::get_instance()->unregister( self::$block_name );
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Block_Type_Registry::get_instance()->unregister( self::$context_block_name );
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Block_Type_Registry::get_instance()->unregister( self::$non_dynamic_block_name );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WP_Block_Type_Registry::get_instance()->unregister( self::$dynamic_block_with_boolean_attributes_block_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</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">@@ -196,6 +207,30 @@
</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">+ * Registers the dynamic with boolean attributes block name.
+ *
+ * @since 5.5.0
+ */
+ protected function register_dynamic_block_with_boolean_attributes() {
+ register_block_type(
+ self::$dynamic_block_with_boolean_attributes_block_name,
+ array(
+ 'attributes' => array(
+ 'boolean_true_attribute' => array(
+ 'type' => 'boolean',
+ 'default' => true,
+ ),
+ 'boolean_false_attribute' => array(
+ 'type' => 'boolean',
+ 'default' => false,
+ ),
+ ),
+ 'render_callback' => array( $this, 'render_test_block' ),
+ )
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test render callback.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -523,6 +558,33 @@
</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">+ * @ticket 50620
+ */
+ public function test_get_sanitized_attributes_for_dynamic_block_with_boolean_attributes() {
+ wp_set_current_user( self::$user_id );
+
+ $request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$dynamic_block_with_boolean_attributes_block_name );
+
+ $attributes = array(
+ 'boolean_true_attribute' => 'true',
+ 'boolean_false_attribute' => 'false',
+ );
+
+ $expected = array(
+ 'boolean_true_attribute' => true,
+ 'boolean_false_attribute' => false,
+ );
+
+ $request->set_param( 'context', 'edit' );
+ $request->set_param( 'attributes', $attributes );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+
+ $this->assertSame( $expected, json_decode( $data['rendered'], true ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get item schema.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 45098
</span></span></pre>
</div>
</div>
</body>
</html>