Docs: Various docblock corrections and improvements for changes introduced in 6.0.

See #54729

Built from https://develop.svn.wordpress.org/trunk@53302


git-svn-id: http://core.svn.wordpress.org/trunk@52891 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-admin/includes/class-wp-media-list-table.php

@@ -509,12 +509,12 @@ class WP_Media_List_Table extends WP_List_Table {
 		}
 
 		/**
-		 * Filters the published time of the post.
+		 * Filters the published time of an attachment displayed in the Media list table.
 		 *
 		 * @since 6.0.0
 		 *
 		 * @param string  $h_time      The published time.
-		 * @param WP_Post $post        Post object.
+		 * @param WP_Post $post        Attachment object.
 		 * @param string  $column_name The column name.
 		 */
 		echo apply_filters( 'media_date_column_time', $h_time, $post, 'date' );

wp-admin/includes/image-edit.php

@@ -49,7 +49,7 @@ function wp_image_editor( $post_id, $msg = false ) {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @param bool|array $edit_custom_sizes True if custom sizes can be edited or array of custom sizes.
+	 * @param bool|string[] $edit_custom_sizes True if custom sizes can be edited or array of custom size names.
 	 */
 	$edit_custom_sizes = apply_filters( 'edit_custom_thumbnail_sizes', $edit_custom_sizes );
 	?>

wp-includes/block-editor.php

@@ -295,7 +295,12 @@ function get_legacy_widget_block_editor_settings() {
  *
  * @global string $pagenow The filename of the current screen.
  *
- * @return array The block editor assets: styles and scripts.
+ * @return array {
+ *     The block editor assets.
+ *
+ *     @type string|false $styles  String containing the HTML for styles.
+ *     @type string|false $scripts String containing the HTML for scripts.
+ * }
  */
 function _wp_get_iframed_editor_assets() {
 	global $pagenow;

wp-includes/blocks.php

@@ -1193,7 +1193,7 @@ function build_query_vars_from_query_block( $block, $page ) {
 }
 
 /**
- * Helper function that returns the proper pagination arrow html for
+ * Helper function that returns the proper pagination arrow HTML for
  * `QueryPaginationNext` and `QueryPaginationPrevious` blocks based
  * on the provided `paginationArrow` from `QueryPagination` context.
  *
@@ -1204,7 +1204,7 @@ function build_query_vars_from_query_block( $block, $page ) {
  * @param WP_Block $block   Block instance.
  * @param boolean  $is_next Flag for handling `next/previous` blocks.
  *
- * @return string|null Returns the constructed WP_Query arguments.
+ * @return string|null The pagination arrow HTML or null if there is none.
  */
 function get_query_pagination_arrow( $block, $is_next ) {
 	$arrow_map = array(
@@ -1282,7 +1282,7 @@ add_filter( 'block_type_metadata', '_wp_multiple_block_styles' );
  * @param WP_Block $block Block instance.
  *
  * @return array Returns the comment query parameters to use with the
- * WP_Comment_Query constructor.
+ *               WP_Comment_Query constructor.
  */
 function build_comment_query_vars_from_block( $block ) {
 
@@ -1339,7 +1339,7 @@ function build_comment_query_vars_from_block( $block ) {
 }
 
 /**
- * Helper function that returns the proper pagination arrow html for
+ * Helper function that returns the proper pagination arrow HTML for
  * `CommentsPaginationNext` and `CommentsPaginationPrevious` blocks based on the
  * provided `paginationArrow` from `CommentsPagination` context.
  *
@@ -1351,7 +1351,7 @@ function build_comment_query_vars_from_block( $block ) {
  * @param string   $pagination_type Type of the arrow we will be rendering.
  *                                  Default 'next'. Accepts 'next' or 'previous'.
  *
- * @return string|null Returns the constructed WP_Query arguments.
+ * @return string|null The pagination arrow HTML or null if there is none.
  */
 function get_comments_pagination_arrow( $block, $pagination_type = 'next' ) {
 	$arrow_map = array(

wp-includes/class-wp-term-query.php

@@ -951,7 +951,7 @@ class WP_Term_Query {
 	 * @since 6.0.0
 	 *
 	 * @param WP_Term[] $term_objects Array of term objects.
-	 * @param string $_fields Field to format.
+	 * @param string    $_fields      Field to format.
 	 *
 	 * @return WP_Term[]|int[]|string[] Array of terms / strings / ints depending on field requested.
 	 */

wp-includes/class-wp-theme-json-resolver.php

@@ -151,10 +151,14 @@ class WP_Theme_JSON_Resolver {
 	 *
 	 * @since 5.8.0
 	 * @since 5.9.0 Theme supports have been inlined and the `$theme_support_data` argument removed.
-	 * @since 6.0.0 Adds a second parameter to allow the theme data to be returned without theme supports.
+	 * @since 6.0.0 Added an `$options` parameter to allow the theme data to be returned without theme supports.
 	 *
 	 * @param array $deprecated Deprecated. Not used.
-	 * @param array $options Contains a key called with_supports to determine whether to include theme supports in the data.
+	 * @param array $options {
+	 *     Options arguments.
+	 *
+	 *     @type bool $with_supports Whether to include theme supports in the data. Default true.
+	 * }
 	 * @return WP_Theme_JSON Entity that holds theme data.
 	 */
 	public static function get_theme_data( $deprecated = array(), $options = array() ) {

wp-includes/class-wp-theme-json.php

@@ -1538,10 +1538,11 @@ class WP_Theme_JSON {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @param array      $data The data to inspect.
-	 * @param bool|array $path Boolean or path to a boolean.
+	 * @param array      $data    The data to inspect.
+	 * @param bool|array $path    Boolean or path to a boolean.
 	 * @param bool       $default Default value if the referenced path is missing.
-	 * @return boolean
+	 *                            Default false.
+	 * @return bool Value of boolean metadata.
 	 */
 	protected static function get_metadata_boolean( $data, $path, $default = false ) {
 		if ( is_bool( $path ) ) {

wp-includes/rest-api/endpoints/class-wp-rest-block-pattern-categories-controller.php

@@ -96,7 +96,7 @@ class WP_REST_Block_Pattern_Categories_Controller extends WP_REST_Controller {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @param object          $item    Raw category as registered, before any changes.
+	 * @param array           $item    Raw category as registered, before any changes.
 	 * @param WP_REST_Request $request Request object.
 	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 	 */

wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php

@@ -112,7 +112,7 @@ class WP_REST_Block_Patterns_Controller extends WP_REST_Controller {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @param object          $item    Raw pattern as registered, before any changes.
+	 * @param array           $item    Raw pattern as registered, before any changes.
 	 * @param WP_REST_Request $request Request object.
 	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 	 */

wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

@@ -118,7 +118,7 @@ class WP_Sitemaps_Taxonomies extends WP_Sitemaps_Provider {
 				 * Filters the sitemap entry for an individual term.
 				 *
 				 * @since 5.5.0
-				 * @since 6.0.0 Added fourth argument for the term object.
+				 * @since 6.0.0 Added `$term` argument containing the term object.
 				 *
 				 * @param array   $sitemap_entry Sitemap entry for the term.
 				 * @param int     $term_id       Term ID.

wp-includes/version.php

@@ -16,7 +16,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '6.0-beta3-53301';
+$wp_version = '6.0-beta3-53302';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

wp-includes/widgets/class-wp-widget-media.php

@@ -467,7 +467,7 @@ abstract class WP_Widget_Media extends WP_Widget {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @var string
+	 * @return string
 	 */
 	protected static function get_default_description() {
 		if ( self::$default_description ) {
@@ -483,7 +483,7 @@ abstract class WP_Widget_Media extends WP_Widget {
 	 *
 	 * @since 6.0.0
 	 *
-	 * @return string[]
+	 * @return (string|array)[]
 	 */
 	protected static function get_l10n_defaults() {
 		if ( ! empty( self::$l10n_defaults ) ) {