From a5f05b68a39e95e71b5d6584b2b6b1740cfb16f6 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 6 Apr 2022 15:20:06 +0000 Subject: [PATCH] Docs: Adjust some deprecated function DocBlocks per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#1-2-deprecated-functions documentation standards]. This ensures the replacement functions are linked correctly in the WordPress Code Reference. Follow-up to [38515], [43548], [49992], [51348], [51586], [52757], [53082]. See #54729. Built from https://develop.svn.wordpress.org/trunk@53086 git-svn-id: http://core.svn.wordpress.org/trunk@52675 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/deprecated.php | 36 +++++++++++++++++++---------- wp-includes/ms-deprecated.php | 2 +- wp-includes/ms-load.php | 2 +- wp-includes/php-compat/readonly.php | 2 +- wp-includes/version.php | 2 +- 5 files changed, 28 insertions(+), 16 deletions(-) diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 7313f32a6e..d126a002ec 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -4182,6 +4182,8 @@ function wp_no_robots() { * @since 5.0.1 * @deprecated 5.7.0 Use wp_robots_sensitive_page() instead on 'wp_robots' filter * and wp_strict_cross_origin_referrer() on 'wp_head' action. + * + * @see wp_robots_sensitive_page() */ function wp_sensitive_page_meta() { _deprecated_function( __FUNCTION__, '5.7.0', 'wp_robots_sensitive_page()' ); @@ -4196,9 +4198,10 @@ function wp_sensitive_page_meta() { * Render inner blocks from the `core/columns` block for generating an excerpt. * * @since 5.2.0 - * @deprecated 5.8.0 - * * @access private + * @deprecated 5.8.0 Use _excerpt_render_inner_blocks() introduced in 5.8.0. + * + * @see _excerpt_render_inner_blocks() * * @param array $columns The parsed columns block. * @param array $allowed_blocks The list of allowed inner blocks. @@ -4206,6 +4209,7 @@ function wp_sensitive_page_meta() { */ function _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) { _deprecated_function( __FUNCTION__, '5.8.0', '_excerpt_render_inner_blocks()' ); + return _excerpt_render_inner_blocks( $columns, $allowed_blocks ); } @@ -4214,7 +4218,7 @@ function _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) { * reference the rendered SVG. * * @since 5.9.0 - * @deprecated 5.9.1 Use `wp_get_duotone_filter_property` introduced in 5.9.1. + * @deprecated 5.9.1 Use wp_get_duotone_filter_property() introduced in 5.9.1. * * @see wp_get_duotone_filter_property() * @@ -4223,16 +4227,18 @@ function _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) { */ function wp_render_duotone_filter_preset( $preset ) { _deprecated_function( __FUNCTION__, '5.9.1', 'wp_get_duotone_filter_property()' ); + return wp_get_duotone_filter_property( $preset ); } /** - * Checks whether serialization of the current block's border properties should - * occur. + * Checks whether serialization of the current block's border properties should occur. * * @since 5.8.0 * @access private - * @deprecated 6.0.0 Use `wp_should_skip_block_supports_serialization` introduced in 6.0.0. + * @deprecated 6.0.0 Use wp_should_skip_block_supports_serialization() introduced in 6.0.0. + * + * @see wp_should_skip_block_supports_serialization() * * @param WP_Block_Type $block_type Block type. * @return bool Whether serialization of the current block's border properties @@ -4240,6 +4246,7 @@ function wp_render_duotone_filter_preset( $preset ) { */ function wp_skip_border_serialization( $block_type ) { _deprecated_function( __FUNCTION__, '6.0.0', 'wp_should_skip_block_supports_serialization()' ); + $border_support = _wp_array_get( $block_type->supports, array( '__experimentalBorder' ), false ); return is_array( $border_support ) && @@ -4248,37 +4255,42 @@ function wp_skip_border_serialization( $block_type ) { } /** - * Checks whether serialization of the current block's dimensions properties - * should occur. + * Checks whether serialization of the current block's dimensions properties should occur. * * @since 5.9.0 * @access private - * @deprecated 6.0.0 Use `wp_should_skip_block_supports_serialization` introduced in 6.0.0. + * @deprecated 6.0.0 Use wp_should_skip_block_supports_serialization() introduced in 6.0.0. + * + * @see wp_should_skip_block_supports_serialization() * * @param WP_Block_type $block_type Block type. * @return bool Whether to serialize spacing support styles & classes. */ function wp_skip_dimensions_serialization( $block_type ) { _deprecated_function( __FUNCTION__, '6.0.0', 'wp_should_skip_block_supports_serialization()' ); + $dimensions_support = _wp_array_get( $block_type->supports, array( '__experimentalDimensions' ), false ); + return is_array( $dimensions_support ) && array_key_exists( '__experimentalSkipSerialization', $dimensions_support ) && $dimensions_support['__experimentalSkipSerialization']; } /** - * Checks whether serialization of the current block's spacing properties should - * occur. + * Checks whether serialization of the current block's spacing properties should occur. * * @since 5.9.0 * @access private - * @deprecated 6.0.0 Use `wp_should_skip_block_supports_serialization` introduced in 6.0.0. + * @deprecated 6.0.0 Use wp_should_skip_block_supports_serialization() introduced in 6.0.0. + * + * @see wp_should_skip_block_supports_serialization() * * @param WP_Block_Type $block_type Block type. * @return bool Whether to serialize spacing support styles & classes. */ function wp_skip_spacing_serialization( $block_type ) { _deprecated_function( __FUNCTION__, '6.0.0', 'wp_should_skip_block_supports_serialization()' ); + $spacing_support = _wp_array_get( $block_type->supports, array( 'spacing' ), false ); return is_array( $spacing_support ) && diff --git a/wp-includes/ms-deprecated.php b/wp-includes/ms-deprecated.php index 1897e0f77b..c06f35ddc5 100644 --- a/wp-includes/ms-deprecated.php +++ b/wp-includes/ms-deprecated.php @@ -559,7 +559,7 @@ function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) { * the new blog's ID. It is the first step in creating a new blog. * * @since MU (3.0.0) - * @deprecated 5.1.0 Use `wp_insert_site()` + * @deprecated 5.1.0 Use wp_insert_site() * @see wp_insert_site() * * @param string $domain The domain of the new site. diff --git a/wp-includes/ms-load.php b/wp-includes/ms-load.php index ac441085f0..140ad191d7 100644 --- a/wp-includes/ms-load.php +++ b/wp-includes/ms-load.php @@ -549,7 +549,7 @@ function wpmu_current_site() { * Retrieve an object containing information about the requested network. * * @since 3.9.0 - * @deprecated 4.7.0 Use `get_network()` + * @deprecated 4.7.0 Use get_network() * @see get_network() * * @internal In 4.6.0, converted to use get_network() diff --git a/wp-includes/php-compat/readonly.php b/wp-includes/php-compat/readonly.php index ff9631ec1b..cc9230e8a2 100644 --- a/wp-includes/php-compat/readonly.php +++ b/wp-includes/php-compat/readonly.php @@ -20,7 +20,7 @@ * This function is deprecated, and cannot be used on PHP >= 8.1. * * @since 4.9.0 - * @deprecated 5.9.0 Use `wp_readonly` introduced in 5.9.0. + * @deprecated 5.9.0 Use wp_readonly() introduced in 5.9.0. * * @see wp_readonly() * diff --git a/wp-includes/version.php b/wp-includes/version.php index f64dc122e8..400707b517 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.0-alpha-53085'; +$wp_version = '6.0-alpha-53086'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.