<!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>[50777] trunk: Editor: Shape block editor filters to work better with the Gutenberg plugin</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/50777">50777</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/50777","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>2021-04-21 09:30:40 +0000 (Wed, 21 Apr 2021)</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'>Editor: Shape block editor filters to work better with the Gutenberg plugin
This should allow to use new filters in the Gutenberg plugin and therefore it prevents deprecation warnings when in the debug mode.
See <a href="https://core.trac.wordpress.org/ticket/52920">#52920</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockeditorphp">trunk/src/wp-includes/block-editor.php</a></li>
<li><a href="#trunktestsphpunittestsblocksblockeditorphp">trunk/tests/phpunit/tests/blocks/block-editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblockeditorphp"></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/block-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-editor.php 2021-04-21 05:10:56 UTC (rev 50776)
+++ trunk/src/wp-includes/block-editor.php 2021-04-21 09:30:40 UTC (rev 50777)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,8 +66,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_block_categories( $editor_name_or_post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Assume the post editor when the WP_Post object passed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $editor_name = is_object( $editor_name_or_post ) ? 'post-editor' : $editor_name_or_post;
- $default_categories = get_default_block_categories();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $editor_name = is_object( $editor_name_or_post ) ? 'post-editor' : $editor_name_or_post;
+ $block_categories = get_default_block_categories();
</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"> * Filters the default array of categories for block types.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,9 +74,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.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">- * @param array[] $default_categories Array of categories for block types.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array[] $block_categories Array of categories for block types.
+ * @param string $editor_name The name of the editor, e.g. 'post-editor'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_categories = apply_filters( "block_categories_{$editor_name}", $default_categories );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_categories = apply_filters( 'block_categories_all', $block_categories, $editor_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'post-editor' === $editor_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = is_object( $editor_name_or_post ) ? $editor_name_or_post : get_post();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,7 +90,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array[] $block_categories Array of categories for block types.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post being loaded.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', "block_categories_{$editor_name}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', 'block_categories_all' );
</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"> return $block_categories;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -108,15 +109,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $allowed_block_types = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the allowed block types for the given editor, defaulting to true (all
- * registered block types supported).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the allowed block types for all editor types, defaulting to `true`
+ * (all registered block types supported).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool|array $allowed_block_types Array of block type slugs, or
</span><span class="cx" style="display: block; padding: 0 10px"> * boolean to enable/disable all.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $editor_name The name of the editor, e.g. 'post-editor'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowed_block_types = apply_filters( "allowed_block_types_{$editor_name}", $allowed_block_types );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $editor_name );
+
+ /**
+ * Filters the allowed block types for the given editor, defaulting to `true`
+ * (all registered block types supported).
+ *
+ * The dynamic portion of the hook name, `$editor_name`, refers to the name
+ * of the editor type, e.g. 'post-editor', 'site-editor', etc.
+ *
+ * @since 5.8.0
+ *
+ * @param bool|array $allowed_block_types Array of block type slugs, or
+ * boolean to enable/disable all.
+ * @param string $editor_name The name of the editor, e.g. 'post-editor'.
+ */
+ $allowed_block_types = apply_filters( "allowed_block_types_{$editor_name}", $allowed_block_types, $editor_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'post-editor' === $editor_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,7 +149,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * boolean to enable/disable all.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The post resource data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', "allowed_block_types_{$editor_name}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' );
</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"> return $allowed_block_types;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,13 +259,27 @@
</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">+ * Filters the settings to pass to the block editor for all editor type.
+ *
+ * @since 5.8.0
+ *
+ * @param array $editor_settings Default editor settings.
+ * @param string $editor_name The name of the editor, e.g. 'post-editor'.
+ */
+ $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $editor_name );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Filters the settings to pass to the block editor for a given editor 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">+ * The dynamic portion of the hook name, `$editor_name`, refers to the name
+ * of the editor type, e.g. 'post-editor', 'site-editor', etc.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.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">- * @param array $editor_settings Default editor settings.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $editor_settings Default editor settings.
+ * @param string $editor_name The name of the editor, e.g. 'post-editor'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $editor_settings = apply_filters( "block_editor_settings_{$editor_name}", $editor_settings );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $editor_settings = apply_filters( "block_editor_settings_{$editor_name}", $editor_settings, $editor_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'post-editor' === $editor_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,7 +292,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $editor_settings Default editor settings.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post being edited.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', "block_editor_settings_{$editor_name}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', 'block_editor_settings_all' );
</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"> return $editor_settings;
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksblockeditorphp"></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-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/block-editor.php 2021-04-21 05:10:56 UTC (rev 50776)
+++ trunk/tests/phpunit/tests/blocks/block-editor.php 2021-04-21 09:30:40 UTC (rev 50777)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -252,15 +252,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_allowed_block_types_my_editor() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 'test/filtered-my-block' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function filter_block_categories_my_editor() {
- return array(
- array(
- 'slug' => 'filtered-my-category',
- 'title' => 'Filtered My Category',
- 'icon' => null,
- ),
- );
- }
</del><span class="cx" style="display: block; padding: 0 10px"> function filter_block_editor_settings_my_editor( $editor_settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $editor_settings['maxUploadFileSize'] = 12345;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -268,27 +259,61 @@
</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"> add_filter( 'allowed_block_types_my-editor', 'filter_allowed_block_types_my_editor', 10, 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'block_categories_my-editor', 'filter_block_categories_my_editor', 10, 1 );
</del><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'block_editor_settings_my-editor', 'filter_block_editor_settings_my_editor', 10, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = get_block_editor_settings( 'my-editor' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'allowed_block_types_my-editor', 'filter_allowed_block_types_my_editor' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'block_categories_my-editor', 'filter_block_categories_my_editor' );
</del><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'block_editor_settings_my-editor', 'filter_block_editor_settings_my_editor' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( array( 'test/filtered-my-block' ), $settings['allowedBlockTypes'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 12345, $settings['maxUploadFileSize'] );
+ }
+
+ /**
+ * @ticket 52920
+ */
+ function test_get_block_editor_settings_overrides_default_settings_any_editor() {
+ function filter_allowed_block_types_any_editor() {
+ return array( 'test/filtered-any-block' );
+ }
+ function filter_block_categories_any_editor() {
+ return array(
+ array(
+ 'slug' => 'filtered-any-category',
+ 'title' => 'Filtered Any Category',
+ 'icon' => null,
+ ),
+ );
+ }
+ function filter_block_editor_settings_any_editor( $editor_settings ) {
+ $editor_settings['maxUploadFileSize'] = 54321;
+
+ return $editor_settings;
+ }
+
+ add_filter( 'allowed_block_types_all', 'filter_allowed_block_types_any_editor', 10, 1 );
+ add_filter( 'block_categories_all', 'filter_block_categories_any_editor', 10, 1 );
+ add_filter( 'block_editor_settings_all', 'filter_block_editor_settings_any_editor', 10, 1 );
+
+ $settings = get_block_editor_settings( 'any-editor' );
+
+ remove_filter( 'allowed_block_types_all', 'filter_allowed_block_types_any_editor' );
+ remove_filter( 'block_categories_all', 'filter_block_categories_any_editor' );
+ remove_filter( 'block_editor_settings_all', 'filter_block_editor_settings_any_editor' );
+
+ $this->assertSameSets( array( 'test/filtered-any-block' ), $settings['allowedBlockTypes'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'slug' => 'filtered-my-category',
- 'title' => 'Filtered My Category',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'slug' => 'filtered-any-category',
+ 'title' => 'Filtered Any Category',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'icon' => null,
</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"> $settings['blockCategories']
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 12345, $settings['maxUploadFileSize'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 54321, $settings['maxUploadFileSize'] );
</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>
</div>
</body>
</html>