Changeset 54776

Timestamp:

11/09/2022 09:49:51 AM (23 months ago)

Author:

audrasjb

Message:

Docs: Fix block_editor_rest_api_preload() parameter type.

This changeset fixes the $preload_paths parameter type for block_editor_rest_api_preload() and related hooks. This parameter expects an array of strings OR an array where the path is the first element (index 0) of this array.

Props chouby.
Fixes #56810.
See #56792.

File:

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

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

@@ -572 +572 @@
  * @global WP_Styles  $wp_styles  The WP_Styles object for printing styles.
  *
- * @param string[]                $preload_paths        List of paths to preload.
+ * @param (string|string[])[]     $preload_paths        List of paths to preload.
  * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
  */
@@ -583 +583 @@
      * @since 5.8.0
      *
-     * @param string[]                $preload_paths        Array of paths to preload.
+     * @param (string|string[])[]     $preload_paths        Array of paths to preload.
      * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
      */
@@ -599 +599 @@
          * @deprecated 5.8.0 Use the {@see 'block_editor_rest_api_preload_paths'} filter instead.
          *
-         * @param string[] $preload_paths Array of paths to preload.
-         * @param WP_Post  $selected_post Post being edited.
+         * @param (string|string[])[] $preload_paths Array of paths to preload.
+         * @param WP_Post             $selected_post Post being edited.
          */
         $preload_paths = apply_filters_deprecated( 'block_editor_preload_paths', array( $preload_paths, $selected_post ), '5.8.0', 'block_editor_rest_api_preload_paths' );