<!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>[43762] branches/5.0: Block Editor: Add helper functions for displaying the editor.</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/43762">43762</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/43762","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-19 08:43:25 +0000 (Fri, 19 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'>Block Editor: Add helper functions for displaying the editor.
`use_block_editor_for_post()` and `use_block_editor_for_post_type()` determine if the block editor should be loaded.
`get_block_categories()` and `get_block_editor_server_block_settings()` provide data be included while the block editor is loading.
See <a href="https://core.trac.wordpress.org/ticket/45110">#45110</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpadminincludespostphp">branches/5.0/src/wp-admin/includes/post.php</a></li>
<li><a href="#branches50testsphpunittestsadminincludesPostphp">branches/5.0/tests/phpunit/tests/admin/includesPost.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpadminincludespostphp"></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-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-admin/includes/post.php 2018-10-19 06:44:16 UTC (rev 43761)
+++ branches/5.0/src/wp-admin/includes/post.php 2018-10-19 08:43:25 UTC (rev 43762)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1874,3 +1874,146 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_redirect( apply_filters( 'redirect_post_location', $location, $post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Return whether the post can be edited in the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param int|WP_Post $post Post ID or WP_Post object.
+ * @return bool Whether the post can be edited in the block editor.
+ */
+function use_block_editor_for_post( $post ) {
+ $post = get_post( $post );
+
+ if ( ! $post ) {
+ return false;
+ }
+
+ $use_block_editor = use_block_editor_for_post_type( $post->post_type );
+
+ /**
+ * Filter whether a post is able to be edited in the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param bool $use_block_editor Whether the post can be edited or not.
+ * @param WP_Post $post The post being checked.
+ */
+ return apply_filters( 'use_block_editor_for_post', $use_block_editor, $post );
+}
+
+/**
+ * Return whether a post type is compatible with the block editor.
+ *
+ * The block editor depends on the REST API, and if the post type is not shown in the
+ * REST API, then it won't work with the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param string $post_type The post type.
+ * @return bool Whether the post type can be edited with the block editor.
+ */
+function use_block_editor_for_post_type( $post_type ) {
+ if ( ! post_type_exists( $post_type ) ) {
+ return false;
+ }
+
+ if ( ! post_type_supports( $post_type, 'editor' ) ) {
+ return false;
+ }
+
+ $post_type_object = get_post_type_object( $post_type );
+ if ( $post_type_object && ! $post_type_object->show_in_rest ) {
+ return false;
+ }
+
+ /**
+ * Filter whether a post is able to be edited in the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param bool $use_block_editor Whether the post type can be edited or not. Default true.
+ * @param string $post_type The post type being checked.
+ */
+ return apply_filters( 'use_block_editor_for_post_type', true, $post_type );
+}
+
+/**
+ * Returns all the block categories that will be shown in the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param WP_Post $post Post object.
+ * @return array Array of block categories.
+ */
+function get_block_categories( $post ) {
+ $default_categories = array(
+ array(
+ 'slug' => 'common',
+ 'title' => __( 'Common Blocks', 'gutenberg' ),
+ ),
+ array(
+ 'slug' => 'formatting',
+ 'title' => __( 'Formatting', 'gutenberg' ),
+ ),
+ array(
+ 'slug' => 'layout',
+ 'title' => __( 'Layout Elements', 'gutenberg' ),
+ ),
+ array(
+ 'slug' => 'widgets',
+ 'title' => __( 'Widgets', 'gutenberg' ),
+ ),
+ array(
+ 'slug' => 'embed',
+ 'title' => __( 'Embeds', 'gutenberg' ),
+ ),
+ array(
+ 'slug' => 'reusable',
+ 'title' => __( 'Reusable Blocks', 'gutenberg' ),
+ ),
+ );
+
+ /**
+ * Filter the default array of block categories.
+ *
+ * @since 5.0.0
+ *
+ * @param array $default_categories Array of block categories.
+ * @param WP_Post $post Post being loaded.
+ */
+ return apply_filters( 'block_categories', $default_categories, $post );
+}
+
+/**
+ * Prepares server-registered blocks for the block editor.
+ *
+ * Returns an associative array of registered block data keyed by block name. Data includes properties
+ * of a block relevant for client registration.
+ *
+ * @since 5.0.0
+ *
+ * @return array An associative array of registered block data.
+ */
+function get_block_editor_server_block_settings() {
+ $block_registry = WP_Block_Type_Registry::get_instance();
+ $blocks = array();
+ $keys_to_pick = array( 'title', 'description', 'icon', 'category', 'keywords', 'supports', 'attributes' );
+
+ foreach ( $block_registry->get_all_registered() as $block_name => $block_type ) {
+ foreach ( $keys_to_pick as $key ) {
+ if ( ! isset( $block_type->{ $key } ) ) {
+ continue;
+ }
+
+ if ( ! isset( $blocks[ $block_name ] ) ) {
+ $blocks[ $block_name ] = array();
+ }
+
+ $blocks[ $block_name ][ $key ] = $block_type->{ $key };
+ }
+ }
+
+ return $blocks;
+}
</ins></span></pre></div>
<a id="branches50testsphpunittestsadminincludesPostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/admin/includesPost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/admin/includesPost.php 2018-10-19 06:44:16 UTC (rev 43761)
+++ branches/5.0/tests/phpunit/tests/admin/includesPost.php 2018-10-19 08:43:25 UTC (rev 43762)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -658,4 +658,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $p, post_exists( $title, $content, $date ) );
</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">+ function test_use_block_editor_for_post() {
+ $this->assertFalse( use_block_editor_for_post( -1 ) );
+ $bogus_post_id = $this->factory()->post->create(
+ array(
+ 'post_type' => 'bogus',
+ )
+ );
+ $this->assertFalse( use_block_editor_for_post( $bogus_post_id ) );
+
+ register_post_type(
+ 'restless',
+ array(
+ 'show_in_rest' => false,
+ )
+ );
+ $restless_post_id = $this->factory()->post->create(
+ array(
+ 'post_type' => 'restless',
+ )
+ );
+ $this->assertFalse( use_block_editor_for_post( $restless_post_id ) );
+
+ $generic_post_id = $this->factory()->post->create();
+
+ add_filter( 'use_block_editor_for_post', '__return_false' );
+ $this->assertFalse( use_block_editor_for_post( $generic_post_id ) );
+ remove_filter( 'use_block_editor_for_post', '__return_false' );
+
+ add_filter( 'use_block_editor_for_post', '__return_true' );
+ $this->assertTrue( use_block_editor_for_post( $restless_post_id ) );
+ remove_filter( 'use_block_editor_for_post', '__return_true' );
+ }
+
+ function test_get_block_editor_server_block_settings() {
+ $name = 'core/test';
+ $settings = array(
+ 'icon' => 'text',
+ 'render_callback' => 'foo',
+ );
+
+ register_block_type( $name, $settings );
+
+ $blocks = get_block_editor_server_block_settings();
+
+ unregister_block_type( $name );
+
+ $this->assertArrayHasKey( $name, $blocks );
+ $this->assertSame( array( 'icon' => 'text' ), $blocks[ $name ] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>