Changeset 52942

Timestamp:

03/17/2022 03:35:13 AM (3 years ago)

Author:

noisysocks

Message:

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 #55301.
Props talldanwp, gziolo, andraganescu.

Location:

trunk

Files:

• src/wp-admin/site-editor.php (modified) (1 diff)
• src/wp-admin/widgets-form-blocks.php (modified) (1 diff)
• src/wp-includes/class-wp-block-editor-context.php (modified) (3 diffs)
• src/wp-includes/class-wp-customize-widgets.php (modified) (1 diff)
• tests/phpunit/tests/blocks/editor.php (modified) (2 diffs)

trunk/src/wp-admin/site-editor.php

@@ -50 +50 @@
 }
 
-$block_editor_context = new WP_Block_Editor_Context();
+$block_editor_context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-site' ) );
 $custom_settings      = array(
     'siteUrl'                              => site_url(),

trunk/src/wp-admin/widgets-form-blocks.php

@@ -16 +16 @@
 $current_screen->is_block_editor( true );
 
-$block_editor_context = new WP_Block_Editor_Context();
+$block_editor_context = new WP_Block_Editor_Context( array( 'name' => 'core/edit-widgets' ) );
 
 $preload_paths = array(

trunk/src/wp-includes/class-wp-block-editor-context.php

@@ -8 +8 @@
 
 /**
- * Class representing a current block editor context.
- *
- * 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.
+ * Contains information about a block editor being rendered.
  *
  * @since 5.8.0
@@ -18 +14 @@
 final class WP_Block_Editor_Context {
     /**
-     * Post being edited. Optional.
+     * String that identifies the block editor being rendered. Can be one of:
+     *
+     * - `'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.
      *
      * @since 5.8.0
@@ -36 +48 @@
      */
     public function __construct( array $settings = array() ) {
+        if ( isset( $settings['name'] ) ) {
+            $this->name = $settings['name'];
+        }
         if ( isset( $settings['post'] ) ) {
             $this->post = $settings['post'];

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -839 +839 @@
 
         if ( wp_use_widgets_block_editor() ) {
-            $block_editor_context = new WP_Block_Editor_Context();
+            $block_editor_context = new WP_Block_Editor_Context(
+                array(
+                    'name' => 'core/customize-widgets',
+                )
+            );
 
             $editor_settings = get_block_editor_settings(

trunk/tests/phpunit/tests/blocks/editor.php

@@ -81 +81 @@
         $context = new WP_Block_Editor_Context();
 
+        $this->assertSame( 'core/edit-post', $context->name );
         $this->assertNull( $context->post );
     }
@@ -90 +91 @@
         $context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
 
+        $this->assertSame( 'core/edit-post', $context->name );
         $this->assertSame( get_post(), $context->post );
+    }
+
+    /**
+     * @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 );
     }