<!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>[43743] branches/5.0: Blocks: Introduce `register_block_type()`, `unregister_block_type()`, and `get_dynamic_blocks()` functions.</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/43743">43743</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/43743","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-10-18 01:52:58 +0000 (Thu, 18 Oct 2018)</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'>Blocks: Introduce `register_block_type()`, `unregister_block_type()`, and `get_dynamic_blocks()` functions.
These helper functions allow easy access to the global block registry.
See <a href="https://core.trac.wordpress.org/ticket/45109">#45109</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesblocksphp">branches/5.0/src/wp-includes/blocks.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>branches/5.0/tests/phpunit/data/blocks/</li>
<li><a href="#branches50testsphpunitdatablocksdoblocksexpectedhtml">branches/5.0/tests/phpunit/data/blocks/do-blocks-expected.html</a></li>
<li><a href="#branches50testsphpunitdatablocksdoblocksoriginalhtml">branches/5.0/tests/phpunit/data/blocks/do-blocks-original.html</a></li>
<li><a href="#branches50testsphpunittestsblocksregisterphp">branches/5.0/tests/phpunit/tests/blocks/register.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludesblocksphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/blocks.php 2018-10-18 01:30:49 UTC (rev 43742)
+++ branches/5.0/src/wp-includes/blocks.php 2018-10-18 01:52:58 UTC (rev 43743)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,6 +8,39 @@
</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 a block type.
+ *
+ * @since 5.0.0
+ *
+ * @param string|WP_Block_Type $name Block type name including namespace, or alternatively a
+ * complete WP_Block_Type instance. In case a WP_Block_Type
+ * is provided, the $args parameter will be ignored.
+ * @param array $args {
+ * Optional. Array of block type arguments. Any arguments may be defined, however the
+ * ones described below are supported by default. Default empty array.
+ *
+ * @type callable $render_callback Callback used to render blocks of this block type.
+ * }
+ * @return WP_Block_Type|false The registered block type on success, or false on failure.
+ */
+function register_block_type( $name, $args = array() ) {
+ return WP_Block_Type_Registry::get_instance()->register( $name, $args );
+}
+
+/**
+ * Unregisters a block type.
+ *
+ * @since 5.0.0
+ *
+ * @param string|WP_Block_Type $name Block type name including namespace, or alternatively a
+ * complete WP_Block_Type instance.
+ * @return WP_Block_Type|false The unregistered block type on success, or false on failure.
+ */
+function unregister_block_type( $name ) {
+ return WP_Block_Type_Registry::get_instance()->unregister( $name );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determine whether a post or content string has blocks.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This test optimizes for performance rather than strict accuracy, detecting
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,3 +92,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false !== strpos( $post, '<!-- wp:' . $block_type . ' ' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Returns an array of the names of all registered dynamic block types.
+ *
+ * @since 5.0.0
+ *
+ * @return array Array of dynamic block names.
+ */
+function get_dynamic_block_names() {
+ $dynamic_block_names = array();
+
+ $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered();
+ foreach ( $block_types as $block_type ) {
+ if ( $block_type->is_dynamic() ) {
+ $dynamic_block_names[] = $block_type->name;
+ }
+ }
+
+ return $dynamic_block_names;
+}
</ins></span></pre></div>
<a id="branches50testsphpunitdatablocksdoblocksexpectedhtml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/5.0/tests/phpunit/data/blocks/do-blocks-expected.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/data/blocks/do-blocks-expected.html (rev 0)
+++ branches/5.0/tests/phpunit/data/blocks/do-blocks-expected.html 2018-10-18 01:52:58 UTC (rev 43743)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,17 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<p>First Auto Paragraph</p>
+
+<!--more-->
+
+<p>First Gutenberg Paragraph</p>
+
+<p>Second Auto Paragraph</p>
+
+
+<p>Third Gutenberg Paragraph</p>
+
+<p>Third Auto Paragraph</p>
+
+<p>[someshortcode]</p>
+<p>And some content?!</p>
+<p>[/someshortcode]</p>
+
</ins></span></pre></div>
<a id="branches50testsphpunitdatablocksdoblocksoriginalhtml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/5.0/tests/phpunit/data/blocks/do-blocks-original.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/data/blocks/do-blocks-original.html (rev 0)
+++ branches/5.0/tests/phpunit/data/blocks/do-blocks-original.html 2018-10-18 01:52:58 UTC (rev 43743)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,25 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<p>First Auto Paragraph</p>
+
+<!--more-->
+
+<!-- wp:core/paragraph -->
+<p>First Gutenberg Paragraph</p>
+<!-- /wp:core/paragraph -->
+
+<p>Second Auto Paragraph</p>
+
+<!-- wp:core/test-self-closing /-->
+
+<!-- wp:core/paragraph -->
+<p>Third Gutenberg Paragraph</p>
+<!-- /wp:core/paragraph -->
+
+<p>Third Auto Paragraph</p>
+
+<!-- wp:core/shortcode -->
+[someshortcode]
+
+And some content?!
+
+[/someshortcode]
+<!-- /wp:core/shortcode -->
</ins></span></pre></div>
<a id="branches50testsphpunittestsblocksregisterphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/5.0/tests/phpunit/tests/blocks/register.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/blocks/register.php (rev 0)
+++ branches/5.0/tests/phpunit/tests/blocks/register.php 2018-10-18 01:52:58 UTC (rev 43743)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,141 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Block registry tests.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @since 5.0.0
+ */
+
+/**
+ * Tests for register_block_type(), unregister_block_type(), get_dynamic_block_names()
+ *
+ * @since 5.0.0
+ *
+ * @group blocks
+ */
+class WP_Test_Block_Register extends WP_UnitTestCase {
+
+ /**
+ * ID for a test post.
+ *
+ * @since 5.0.0
+ * @var int
+ */
+ protected static $post_id;
+
+ /**
+ * Set up before class.
+ *
+ * @since 5.0.0
+ */
+ public static function wpSetUpBeforeClass( $factory ) {
+ self::$post_id = $factory->post->create(
+ array(
+ 'post_content' => file_get_contents( DIR_TESTDATA . '/blocks/do-blocks-original.html' ),
+ )
+ );
+ }
+
+ /**
+ * Tear down after class.
+ *
+ * @since 5.0.0
+ */
+ public static function wpTearDownAfterClass() {
+ // Also deletes revisions.
+ wp_delete_post( self::$post_id, true );
+ }
+
+ /**
+ * Empty render function for tests to use.
+ */
+ function render_stub() {}
+
+ /**
+ * Tear down after each test.
+ *
+ * @since 5.0.0
+ */
+ function tearDown() {
+ parent::tearDown();
+
+ $registry = WP_Block_Type_Registry::get_instance();
+
+ foreach ( array( 'test-static', 'test-dynamic' ) as $block_name ) {
+ $block_name = 'core/' . $block_name;
+
+ if ( $registry->is_registered( $block_name ) ) {
+ $registry->unregister( $block_name );
+ }
+ }
+ }
+
+ /**
+ * @ticket 45109
+ */
+ function test_register_affects_main_registry() {
+ $name = 'core/test-static';
+ $settings = array(
+ 'icon' => 'text',
+ );
+
+ register_block_type( $name, $settings );
+
+ $registry = WP_Block_Type_Registry::get_instance();
+ $this->assertTrue( $registry->is_registered( $name ) );
+ }
+
+ /**
+ * @ticket 45109
+ */
+ function test_unregister_affects_main_registry() {
+ $name = 'core/test-static';
+ $settings = array(
+ 'icon' => 'text',
+ );
+
+ register_block_type( $name, $settings );
+ unregister_block_type( $name );
+
+ $registry = WP_Block_Type_Registry::get_instance();
+ $this->assertFalse( $registry->is_registered( $name ) );
+ }
+
+ /**
+ * @ticket 45109
+ */
+ function test_get_dynamic_block_names() {
+ register_block_type( 'core/test-static', array() );
+ register_block_type( 'core/test-dynamic', array( 'render_callback' => array( $this, 'render_stub' ) ) );
+
+ $dynamic_block_names = get_dynamic_block_names();
+
+ $this->assertContains( 'core/test-dynamic', $dynamic_block_names );
+ $this->assertNotContains( 'core/test-static', $dynamic_block_names );
+ }
+
+ /**
+ * @ticket 45109
+ */
+ function test_has_blocks() {
+ // Test with passing post ID.
+ $this->assertTrue( has_blocks( self::$post_id ) );
+
+ // Test with passing WP_Post object.
+ $this->assertTrue( has_blocks( get_post( self::$post_id ) ) );
+
+ // Test with passing content string.
+ $this->assertTrue( has_blocks( get_post( self::$post_id ) ) );
+
+ // Test default.
+ $this->assertFalse( has_blocks() );
+ $query = new WP_Query( array( 'post__in' => array( self::$post_id ) ) );
+ $query->the_post();
+ $this->assertTrue( has_blocks() );
+
+ // Test string (without blocks).
+ $content = file_get_contents( DIR_TESTDATA . '/blocks/do-blocks-expected.html' );
+ $this->assertFalse( has_blocks( $content ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>