Changeset 53086 for trunk/src/wp-includes/deprecated.php

Timestamp:

04/06/2022 03:18:08 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust some deprecated function DocBlocks per the ​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.

File:

• trunk/src/wp-includes/deprecated.php (modified) (10 diffs)

trunk/src/wp-includes/deprecated.php

@@ -4183 +4183 @@
  * @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() {
@@ -4197 +4199 @@
  *
  * @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.
@@ -4207 +4210 @@
 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 );
 }
@@ -4215 +4219 @@
  *
  * @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()
@@ -4224 +4228 @@
 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.
@@ -4241 +4247 @@
 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 );
 
@@ -4249 +4256 @@
 
 /**
- * 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.
@@ -4261 +4269 @@
 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 ) &&
@@ -4268 +4278 @@
 
 /**
- * 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.
@@ -4280 +4291 @@
 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 );