<!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>[52942] trunk: Add WP_Block_Editor_Context::$name</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/52942">52942</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/52942","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>noisysocks</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-03-17 03:35:13 +0000 (Thu, 17 Mar 2022)</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 WP_Block_Editor_Context::$name
Adds a new `WP_Block_Editor_Context::$name` and field. This allows plugin
developers to tell which block editor is being loaded when using filters such as
`allowed_block_types_all` and `block_editor_rest_api_preload_paths`.
Fixes <a href="https://core.trac.wordpress.org/ticket/55301">#55301</a>.
Props talldanwp, gziolo, andraganescu.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminsiteeditorphp">trunk/src/wp-admin/site-editor.php</a></li>
<li><a href="#trunksrcwpadminwidgetsformblocksphp">trunk/src/wp-admin/widgets-form-blocks.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblockeditorcontextphp">trunk/src/wp-includes/class-wp-block-editor-context.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>
<li><a href="#trunktestsphpunittestsblockseditorphp">trunk/tests/phpunit/tests/blocks/editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminsiteeditorphp"></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/site-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/site-editor.php 2022-03-16 19:30:47 UTC (rev 52941)
+++ trunk/src/wp-admin/site-editor.php 2022-03-17 03:35:13 UTC (rev 52942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,7 +49,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $indexed_template_types[] = $template_type;
</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">-$block_editor_context = new WP_Block_Editor_Context();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$block_editor_context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-site' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $custom_settings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'siteUrl' => site_url(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'postsPerPage' => get_option( 'posts_per_page' ),
</span></span></pre></div>
<a id="trunksrcwpadminwidgetsformblocksphp"></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/widgets-form-blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/widgets-form-blocks.php 2022-03-16 19:30:47 UTC (rev 52941)
+++ trunk/src/wp-admin/widgets-form-blocks.php 2022-03-17 03:35:13 UTC (rev 52942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,7 +15,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $current_screen = get_current_screen();
</span><span class="cx" style="display: block; padding: 0 10px"> $current_screen->is_block_editor( true );
</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_editor_context = new WP_Block_Editor_Context();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$block_editor_context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-widgets' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $preload_paths = array(
</span><span class="cx" style="display: block; padding: 0 10px"> array( rest_get_route_for_post_type_items( 'attachment' ), 'OPTIONS' ),
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblockeditorcontextphp"></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-editor-context.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-editor-context.php 2022-03-16 19:30:47 UTC (rev 52941)
+++ trunk/src/wp-includes/class-wp-block-editor-context.php 2022-03-17 03:35:13 UTC (rev 52942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,18 +7,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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Class representing a current block editor context.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Contains information about a block editor being rendered.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The expectation is that block editor can have a different set
- * of requirements on every screen where it is used. This class
- * allows to define supporting settings that can be used with filters.
- *
</del><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"> final class WP_Block_Editor_Context {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Post being edited. Optional.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * String that identifies the block editor being rendered. Can be one of:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `'core/edit-post'` - The post editor at `/wp-admin/edit.php`.
+ * - `'core/edit-widgets'` - The widgets editor at `/wp-admin/widgets.php`.
+ * - `'core/customize-widgets'` - The widgets editor at `/wp-admin/customize.php`.
+ * - `'core/edit-site'` - The site editor at `/wp-admin/site-editor.php`.
+ *
+ * Defaults to 'core/edit-post'.
+ *
+ * @since 6.0.0
+ *
+ * @var string
+ */
+ public $name = 'core/edit-post';
+
+ /**
+ * The post being edited by the block editor. Optional.
+ *
</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"> * @var WP_Post|null
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +47,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $settings The list of optional settings to expose in a given context.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( array $settings = array() ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $settings['name'] ) ) {
+ $this->name = $settings['name'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $settings['post'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->post = $settings['post'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizewidgetsphp"></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-customize-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-widgets.php 2022-03-16 19:30:47 UTC (rev 52941)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php 2022-03-17 03:35:13 UTC (rev 52942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -838,7 +838,11 @@
</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"> if ( wp_use_widgets_block_editor() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $block_editor_context = new WP_Block_Editor_Context();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_editor_context = new WP_Block_Editor_Context(
+ array(
+ 'name' => 'core/customize-widgets',
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $editor_settings = get_block_editor_settings(
</span><span class="cx" style="display: block; padding: 0 10px"> get_legacy_widget_block_editor_settings(),
</span></span></pre></div>
<a id="trunktestsphpunittestsblockseditorphp"></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/editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/editor.php 2022-03-16 19:30:47 UTC (rev 52941)
+++ trunk/tests/phpunit/tests/blocks/editor.php 2022-03-17 03:35:13 UTC (rev 52942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,6 +80,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_block_editor_context_no_settings() {
</span><span class="cx" style="display: block; padding: 0 10px"> $context = new WP_Block_Editor_Context();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'core/edit-post', $context->name );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $context->post );
</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">@@ -89,10 +90,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_block_editor_context_post() {
</span><span class="cx" style="display: block; padding: 0 10px"> $context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'core/edit-post', $context->name );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( get_post(), $context->post );
</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 55301
+ */
+ public function test_block_editor_context_widgets() {
+ $context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-widgets' ) );
+
+ $this->assertSame( 'core/edit-widgets', $context->name );
+ $this->assertNull( $context->post );
+ }
+
+ /**
+ * @ticket 55301
+ */
+ public function test_block_editor_context_widgets_customizer() {
+ $context = new WP_Block_Editor_Context( array( 'name' => 'core/customize-widgets' ) );
+
+ $this->assertSame( 'core/customize-widgets', $context->name );
+ $this->assertNull( $context->post );
+ }
+
+ /**
+ * @ticket 55301
+ */
+ public function test_block_editor_context_site() {
+ $context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-site' ) );
+
+ $this->assertSame( 'core/edit-site', $context->name );
+ $this->assertNull( $context->post );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 52920
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated block_categories
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>