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

Timestamp:

04/21/2021 09:30:40 AM (4 years ago)

Author:

gziolo

Message:

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 #52920.

File:

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

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

@@ -67 +67 @@
 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;
-    $default_categories = get_default_block_categories();
+    $editor_name      = is_object( $editor_name_or_post ) ? 'post-editor' : $editor_name_or_post;
+    $block_categories = get_default_block_categories();
 
     /**
@@ -75 +75 @@
      * @since 5.8.0
      *
-     * @param array[] $default_categories Array of categories for block types.
-     */
-    $block_categories = apply_filters( "block_categories_{$editor_name}", $default_categories );
+     * @param array[] $block_categories Array of categories for block types.
+     * @param string  $editor_name      The name of the editor, e.g. 'post-editor'.
+     */
+    $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();
@@ -90 +91 @@
          * @param WP_Post $post             Post being loaded.
          */
-        $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', "block_categories_{$editor_name}" );
+        $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', 'block_categories_all' );
     }
 
@@ -109 +110 @@
 
     /**
-     * Filters the allowed block types for the given editor, defaulting to true (all
-     * registered block types supported).
+     * Filters the allowed block types for all editor types, defaulting to `true`
+     * (all registered block types supported).
+     *
      *
      * @since 5.8.0
@@ -116 +118 @@
      * @param bool|array $allowed_block_types Array of block type slugs, or
      *                                        boolean to enable/disable all.
-     */
-    $allowed_block_types = apply_filters( "allowed_block_types_{$editor_name}", $allowed_block_types );
+     * @param string     $editor_name         The name of the editor, e.g. 'post-editor'.
+     */
+    $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 );
     if ( 'post-editor' === $editor_name ) {
         $post = get_post();
@@ -132 +150 @@
          * @param WP_Post    $post                The post resource data.
          */
-        $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', "allowed_block_types_{$editor_name}" );
+        $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' );
     }
 
@@ -242 +260 @@
 
     /**
+     * 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 );
+
+    /**
      * Filters the settings to pass to the block editor for a given editor type.
      *
-     * @since 5.8.0
-     *
-     * @param array $editor_settings Default editor settings.
-     */
-    $editor_settings = apply_filters( "block_editor_settings_{$editor_name}", $editor_settings );
+     * 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 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_{$editor_name}", $editor_settings, $editor_name );
     if ( 'post-editor' === $editor_name ) {
         $post = get_post();
@@ -261 +293 @@
          * @param WP_Post $post            Post being edited.
          */
-        $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', "block_editor_settings_{$editor_name}" );
+        $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', 'block_editor_settings_all' );
     }