<!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>[47875] trunk: Add fields to WP_Block_Type</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/47875">47875</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/47875","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-01 12:25:34 +0000 (Mon, 01 Jun 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'>Add fields to WP_Block_Type
As part of <a href="https://core.trac.wordpress.org/ticket/47620">#47620</a> and the RFC for block registeration. Server registered blocks are missing some fields. These changeset includes them.
Props spacedmonkey, aduth.
Fixes <a href="https://core.trac.wordpress.org/ticket/48529">#48529</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespostphp">trunk/src/wp-admin/includes/post.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblocktypephp">trunk/src/wp-includes/class-wp-block-type.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesPostphp">trunk/tests/phpunit/tests/admin/includesPost.php</a></li>
<li><a href="#trunktestsphpunittestsblocksblocktypephp">trunk/tests/phpunit/tests/blocks/block-type.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/post.php 2020-06-01 11:20:16 UTC (rev 47874)
+++ trunk/src/wp-admin/includes/post.php 2020-06-01 12:25:34 UTC (rev 47875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2234,7 +2234,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function get_block_editor_server_block_settings() {
</span><span class="cx" style="display: block; padding: 0 10px"> $block_registry = WP_Block_Type_Registry::get_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> $blocks = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $keys_to_pick = array( 'title', 'description', 'icon', 'category', 'keywords', 'parent', 'supports', 'attributes', 'styles' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $keys_to_pick = array( 'title', 'description', 'icon', 'category', 'keywords', 'parent', 'supports', 'attributes', 'styles', 'textdomain', 'example' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $block_registry->get_all_registered() as $block_name => $block_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $keys_to_pick as $key ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblocktypephp"></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/class-wp-block-type.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-type.php 2020-06-01 11:20:16 UTC (rev 47874)
+++ trunk/src/wp-includes/class-wp-block-type.php 2020-06-01 12:25:34 UTC (rev 47875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,6 +15,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see register_block_type()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_Block_Type {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Block type key.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,20 +25,80 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $name;
</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">+ * @since 5.5.0
+ * @var string
+ */
+ public $title = '';
+
+ /**
+ * @since 5.5.0
+ * @var string
+ */
+ public $category = '';
+
+ /**
+ * @since 5.5.0
+ * @var array|null
+ */
+ public $parent = null;
+
+ /**
+ * @since 5.5.0
+ * @var string
+ */
+ public $icon = '';
+
+ /**
+ * @since 5.5.0
+ * @var string
+ */
+ public $description = '';
+
+ /**
+ * @since 5.5.0
+ * @var array
+ */
+ public $keywords = array();
+
+ /**
+ * @since 5.5.0
+ * @var string|null
+ */
+ public $textdomain = null;
+
+ /**
+ * @since 5.5.0
+ * @var array
+ */
+ public $styles = array();
+
+ /**
+ * @since 5.5.0
+ * @var array
+ */
+ public $supports = array();
+
+ /**
+ * @since 5.5.0
+ * @var array|null
+ */
+ public $example = null;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Block type 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="cx" style="display: block; padding: 0 10px"> * @var callable
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $render_callback;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $render_callback = null;
</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"> * Block type attributes property schemas.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var array|null
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $attributes;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $attributes = null;
</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"> * Block type editor script handle.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,7 +106,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $editor_script;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $editor_script = '';
</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"> * Block type front end script handle.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,7 +114,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $script;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $script = '';
</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"> * Block type editor style handle.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,7 +122,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $editor_style;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $editor_style = '';
</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"> * Block type front end style handle.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,7 +130,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $style;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $style = '';
</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"> * Constructor.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,13 +137,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Will populate object properties from the provided arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $block_type Block type name including namespace.
+ * @param array|string $args Optional. Array or string of arguments for registering a block type.
+ * Default empty array.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see register_block_type()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see register_block_type()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $block_type Block type name including namespace.
- * @param array|string $args Optional. Array or string of arguments for registering a block type.
- * Default empty array.
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $block_type, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->name = $block_type;
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesPostphp"></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/admin/includesPost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesPost.php 2020-06-01 11:20:16 UTC (rev 47874)
+++ trunk/tests/phpunit/tests/admin/includesPost.php 2020-06-01 12:25:34 UTC (rev 47875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -825,6 +825,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_get_block_editor_server_block_settings() {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = 'core/test';
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'category' => 'common',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'icon' => 'text',
</span><span class="cx" style="display: block; padding: 0 10px"> 'render_callback' => 'foo',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -836,7 +837,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_block_type( $name );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $name, $blocks );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( array( 'icon' => 'text' ), $blocks[ $name ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( array(
+ 'title' => '',
+ 'description' => '',
+ 'category' => 'common',
+ 'icon' => 'text',
+ 'keywords' => array(),
+ 'supports' => array(),
+ 'styles' => array(),
+ ), $blocks[ $name ] );
</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></pre></div>
<a id="trunktestsphpunittestsblocksblocktypephp"></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/blocks/block-type.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/block-type.php 2020-06-01 11:20:16 UTC (rev 47874)
+++ trunk/tests/phpunit/tests/blocks/block-type.php 2020-06-01 12:25:34 UTC (rev 47875)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -350,6 +350,31 @@
</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 48529
+ */
+ public function test_register_block() {
+ $block_type = new WP_Block_Type( 'core/fake', array(
+ 'title' => 'Test title',
+ 'category' => 'Test category',
+ 'parent' => array( 'core/third-party' ),
+ 'icon' => 'icon.png',
+ 'description' => 'test description',
+ 'keywords' => array( 'test keyword' ),
+ 'textdomain' => 'test_domain',
+ 'supports' => array( 'alignment' => true ),
+ ) );
+
+ $this->assertSame( 'Test title', $block_type->title );
+ $this->assertSame( 'Test category', $block_type->category );
+ $this->assertEqualSets( array( 'core/third-party' ), $block_type->parent );
+ $this->assertSame( 'icon.png', $block_type->icon );
+ $this->assertSame( 'test description', $block_type->description );
+ $this->assertEqualSets( array( 'test keyword' ), $block_type->keywords );
+ $this->assertSame( 'test_domain', $block_type->textdomain );
+ $this->assertEqualSets( array( 'alignment' => true ), $block_type->supports );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Testing the block version.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 43887
</span></span></pre>
</div>
</div>
</body>
</html>