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.


git-svn-id: https://develop.svn.wordpress.org/trunk@54776 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jb Audras 2022-11-09 09:49:51 +00:00
parent dec912b680
commit 74fb46b54d

View File

@ -571,7 +571,7 @@ function get_block_editor_settings( array $custom_settings, $block_editor_contex
* @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
* @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.
*/
function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) {
@ -582,7 +582,7 @@ function block_editor_rest_api_preload( array $preload_paths, $block_editor_cont
*
* @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.
*/
$preload_paths = apply_filters( 'block_editor_rest_api_preload_paths', $preload_paths, $block_editor_context );
@ -598,8 +598,8 @@ function block_editor_rest_api_preload( array $preload_paths, $block_editor_cont
* @since 5.0.0
* @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' );
}