Changeset 51237

Timestamp:

06/25/2021 02:39:13 PM (5 years ago)

Author:

desrosj

Message:

Docs: Various filter docblock improvements.

Follow up to [50776], [50956], [50983].

See #52920.

File:

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

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

@@ -91 +91 @@
                  *
                  * @since 5.0.0
-                 * @deprecated 5.8.0 The hook transitioned to support also screens that don't contain the $post instance.
+                 * @deprecated 5.8.0 Use the {@see 'block_categories_all'} filter instead.
                  *
                  * @param array[] $block_categories Array of categories for block types.
@@ -115 +115 @@
 
         /**
-         * Filters the allowed block types for all editor types, defaulting to `true`
-         * (all registered block types supported).
-         *
+         * Filters the allowed block types for all editor types.
          *
          * @since 5.8.0
          *
-         * @param bool|array              $allowed_block_types  Array of block type slugs, or
-         *                                                      boolean to enable/disable all.
+         * @param bool|array              $allowed_block_types  Array of block type slugs, or boolean to enable/disable all.
+         *                                                      Default true (all registered block types supported).
          * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
          */
@@ -130 +128 @@
 
                 /**
-                 * Filters the allowed block types for the editor, defaulting to true (all
-                 * block types supported).
+                 * Filters the allowed block types for the editor.
                  *
                  * @since 5.0.0
-                 * @deprecated 5.8.0 The hook transitioned to support also screens that don't contain $post instance.
-                 *
-                 * @param bool|array $allowed_block_types Array of block type slugs, or
-                 *                                        boolean to enable/disable all.
+                 * @deprecated 5.8.0 Use the {@see 'allowed_block_types_all'} filter instead.
+                 *
+                 * @param bool|array $allowed_block_types Array of block type slugs, or boolean to enable/disable all.
+                 *                                        Default true (all registered block types supported)
                  * @param WP_Post    $post                The post resource data.
                  */
@@ -379 +376 @@
                  *
                  * @since 5.0.0
-                 * @deprecated 5.8.0 The hook transitioned to support also screens that don't contain $post instance.
+                 * @deprecated 5.8.0 Use the {@see 'block_editor_settings_all'} filter instead.
                  *
                  * @param array   $editor_settings Default editor settings.
@@ -407 +404 @@
 
         /**
-         * Filters the array of REST API paths that will be used to preloaded common data
-         * to use with the block editor.
+         * Filters the array of REST API paths that will be used to preloaded common data for the block editor.
          *
          * @since 5.8.0
@@ -419 +415 @@
 
                 /**
+                 * Filters the array of paths that will be preloaded.
+                 *
                  * Preload common data by specifying an array of REST API paths that will be preloaded.
                  *
-                 * Filters the array of paths that will be preloaded.
-                 *
                  * @since 5.0.0
-                 * @deprecated 5.8.0 The hook transitioned to support also screens that don't contain $post instance.
+                 * @deprecated 5.8.0 Use the {@see 'block_editor_rest_api_preload_paths'} filter instead.
                  *
                  * @param string[] $preload_paths Array of paths to preload.