Changeset 50983 for trunk/src/wp-includes/block-editor.php

Timestamp:

05/24/2021 09:20:31 PM (5 years ago)

Author:

gziolo

Message:

Editor: Use the block editor context in filters that used the editor name

Follow-up for [50956].
Props azaozz, chrisvanpatten, timothyblynjacobs, youknowriad.
Fixes #52920.

File:

• trunk/src/wp-includes/block-editor.php (modified) (6 diffs)

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

@@ -59 +59 @@
  *
  * @since 5.0.0
- *
- * @param string|WP_Post $editor_name_or_post The name of the editor (e.g. 'post-editor')
- *                                            or the post object.
+ * @since 5.8.0 It is possible to pass the block editor context as param.
+ *
+ * @param WP_Post|WP_Block_Editor_Context $post_or_block_editor_context The current post object or
+ *                                                                      the block editor context.
  *
  * @return array[] Array of categories for block types.
  */
-function get_block_categories( $editor_name_or_post ) {
-    // Assume the post editor when the WP_Post object passed.
-    $editor_name      = is_object( $editor_name_or_post ) ? 'post-editor' : $editor_name_or_post;
-    $block_categories = get_default_block_categories();
+function get_block_categories( $post_or_block_editor_context ) {
+    $block_categories     = get_default_block_categories();
+    $block_editor_context = $post_or_block_editor_context instanceof WP_Post ?
+        new WP_Block_Editor_Context(
+            array(
+                'post' => $post_or_block_editor_context,
+            )
+        ) : $post_or_block_editor_context;
 
     /**
@@ -75 +80 @@
      * @since 5.8.0
      *
-     * @param array[] $block_categories Array of categories for block types.
-     * @param string  $editor_name      The name of the editor, e.g. 'post-editor'.
+     * @param array[]                 $block_categories     Array of categories for block types.
+     * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
      */
-    $block_categories = apply_filters( 'block_categories_all', $block_categories, $editor_name );
-    if ( 'post-editor' === $editor_name ) {
-        $post = is_object( $editor_name_or_post ) ? $editor_name_or_post : get_post();
+    $block_categories = apply_filters( 'block_categories_all', $block_categories, $block_editor_context );
+    if ( ! empty( $block_editor_context->post ) ) {
+        $post = $block_editor_context->post;
 
         /**
@@ -102 +107 @@
  * @since 5.8.0
  *
- * @param string $editor_name The name of the editor (e.g. 'post-editor').
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
  *
  * @return bool|array Array of block type slugs, or boolean to enable/disable all.
  */
-function get_allowed_block_types( $editor_name ) {
+function get_allowed_block_types( $block_editor_context ) {
     $allowed_block_types = true;
 
@@ -116 +121 @@
      * @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'.
+     * @param bool|array              $allowed_block_types  Array of block type slugs, or
+     *                                                      boolean to enable/disable all.
+     * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
      */
-    $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $editor_name );
-    if ( 'post-editor' === $editor_name ) {
-        $post = get_post();
+    $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $block_editor_context );
+    if ( ! empty( $block_editor_context->post ) ) {
+        $post = $block_editor_context->post;
 
         /**
@@ -225 +230 @@
 
 /**
- * Returns the contextualized block editor settings settings for a selected editor type.
+ * Returns the contextualized block editor settings settings for a selected editor context.
  *
  * @since 5.8.0
  *
- * @param string $editor_name     The name of the editor (e.g. 'post-editor').
- * @param array  $custom_settings Optional custom settings to use with the editor type.
+ * @param array                   $custom_settings      Custom settings to use with the given editor type.
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
  *
  * @return array The contextualized block editor settings.
  */
-function get_block_editor_settings( $editor_name, $custom_settings = array() ) {
+function get_block_editor_settings( array $custom_settings, $block_editor_context ) {
     $editor_settings = array_merge(
         get_default_block_editor_settings(),
         array(
-            'allowedBlockTypes' => get_allowed_block_types( $editor_name ),
-            'blockCategories'   => get_block_categories( $editor_name ),
+            'allowedBlockTypes' => get_allowed_block_types( $block_editor_context ),
+            'blockCategories'   => get_block_categories( $block_editor_context ),
         ),
         $custom_settings
@@ -302 +307 @@
      * @since 5.8.0
      *
-     * @param array  $editor_settings Default editor settings.
-     * @param string $editor_name     The name of the editor, e.g. 'post-editor'.
+     * @param array                   $editor_settings      Default editor settings.
+     * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
      */
-    $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $editor_name );
-    if ( 'post-editor' === $editor_name ) {
-        $post = get_post();
+    $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $block_editor_context );
+    if ( ! empty( $block_editor_context->post ) ) {
+        $post = $block_editor_context->post;
 
         /**