Docs: Miscellaneous inline documentation improvements.

See #55646

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


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

wp-includes/blocks/search.php

@@ -180,7 +180,7 @@ function classnames_for_block_core_search( $attributes ) {
  *
  * @param  array $attributes The block attributes.
  *
- * @return string[] Style HTML attributes.
+ * @return array Style HTML attribute.
  */
 function styles_for_block_core_search( $attributes ) {
 	$wrapper_styles   = array();

wp-includes/blocks/template-part.php

@@ -159,9 +159,9 @@ function render_block_core_template_part( $attributes ) {
 }
 
 /**
- * Returns an array of variation arrays for the template part block.
+ * Returns an array of variation objects for the template part block.
  *
- * @return array[] Array containing the block variation data in an array.
+ * @return array Array containing the block variation objects.
  */
 function build_template_part_block_variations() {
 	$variations    = array();

wp-includes/class-wp-block-supports.php

@@ -72,6 +72,8 @@ class WP_Block_Supports {
 	 *
 	 * @since 5.6.0
 	 *
+	 * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/
+	 *
 	 * @param string $block_support_name   Block support name.
 	 * @param array  $block_support_config Array containing the properties of the block support.
 	 */

wp-includes/class-wp-customize-control.php

@@ -167,7 +167,7 @@ class WP_Customize_Control {
 	 *
 	 * Supplied `$args` override class property defaults.
 	 *
-	 * If `$args['settings']` is not defined, use the $id as the setting ID.
+	 * If `$args['settings']` is not defined, use the `$id` as the setting ID.
 	 *
 	 * @since 3.4.0
 	 *

wp-includes/cron.php

@@ -1205,15 +1205,15 @@ function _set_cron_array( $cron, $wp_error = false ) {
 }
 
 /**
- * Upgrade a Cron info array.
+ * Upgrade a cron info array.
  *
- * This function upgrades the Cron info array to version 2.
+ * This function upgrades the cron info array to version 2.
  *
  * @since 2.1.0
  * @access private
  *
  * @param array $cron Cron info array from _get_cron_array().
- * @return array An upgraded Cron info array.
+ * @return array An upgraded cron info array.
  */
 function _upgrade_cron_array( $cron ) {
 	if ( isset( $cron['version'] ) && 2 == $cron['version'] ) {

wp-includes/functions.php

@@ -4894,8 +4894,8 @@ function wp_array_slice_assoc( $array, $keys ) {
  *
  * @param array $array   An array from which we want to retrieve some information.
  * @param array $path    An array of keys describing the path with which to retrieve information.
- * @param mixed $default The return value if the path does not exist within the array,
+ * @param mixed $default Optional. The return value if the path does not exist within the array,
- *                       or if `$array` or `$path` are not arrays.
+ *                       or if `$array` or `$path` are not arrays. Default null.
  * @return mixed The value from the path specified.
  */
 function _wp_array_get( $array, $path, $default = null ) {

wp-includes/https-detection.php

@@ -178,8 +178,8 @@ function wp_schedule_https_detection() {
  * @since 5.7.0
  * @access private
  *
- * @param array $request The Cron request arguments.
+ * @param array $request The cron request arguments.
- * @return array The filtered Cron request arguments.
+ * @return array The filtered cron request arguments.
  */
 function wp_cron_conditionally_prevent_sslverify( $request ) {
 	if ( 'https' === wp_parse_url( $request['url'], PHP_URL_SCHEME ) ) {

wp-includes/link-template.php

@@ -4161,7 +4161,7 @@ function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
  * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
  *                           user email, WP_User object, WP_Post object, or WP_Comment object.
  * @param array $args {
- *     Optional. Arguments to return instead of the default arguments.
+ *     Optional. Arguments to use instead of the default arguments.
  *
  *     @type int    $size           Height and width of the avatar in pixels. Default 96.
  *     @type string $default        URL for the default image or a default type. Accepts '404' (return
@@ -4213,10 +4213,10 @@ function is_avatar_comment_type( $comment_type ) {
  *
  * @since 4.2.0
  *
- * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
+ * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
  *                           user email, WP_User object, WP_Post object, or WP_Comment object.
  * @param array $args {
- *     Optional. Arguments to return instead of the default arguments.
+ *     Optional. Arguments to use instead of the default arguments.
  *
  *     @type int    $size           Height and width of the avatar image file in pixels. Default 96.
  *     @type int    $height         Display height of the avatar in pixels. Defaults to $size.
@@ -4318,7 +4318,7 @@ function get_avatar_data( $id_or_email, $args = null ) {
 	 * @since 4.2.0
 	 *
 	 * @param array $args        Arguments passed to get_avatar_data(), after processing.
-	 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
+	 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
 	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
 	 */
 	$args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email );
@@ -4409,7 +4409,7 @@ function get_avatar_data( $id_or_email, $args = null ) {
 	 * @since 4.2.0
 	 *
 	 * @param string $url         The URL of the avatar.
-	 * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
+	 * @param mixed  $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
 	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
 	 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
 	 */
@@ -4421,7 +4421,7 @@ function get_avatar_data( $id_or_email, $args = null ) {
 	 * @since 4.2.0
 	 *
 	 * @param array $args        Arguments passed to get_avatar_data(), after processing.
-	 * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
+	 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
 	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
 	 */
 	return apply_filters( 'get_avatar_data', $args, $id_or_email );

wp-includes/ms-blogs.php

@@ -75,7 +75,7 @@ function get_blogaddress_by_name( $blogname ) {
 }
 
 /**
- * Retrieves a sites ID given its (subdomain or directory) slug.
+ * Retrieves a site's ID given its (subdomain or directory) slug.
  *
  * @since MU (3.0.0)
  * @since 4.7.0 Converted to use `get_sites()`.

wp-includes/post.php

@@ -3217,14 +3217,14 @@ function get_post_mime_types() {
 /**
  * Checks a MIME-Type against a list.
  *
- * If the wildcard_mime_types parameter is a string, it must be comma separated
+ * If the `$wildcard_mime_types` parameter is a string, it must be comma separated
- * list. If the real_mime_types is a string, it is also comma separated to
+ * list. If the `$real_mime_types` is a string, it is also comma separated to
  * create the list.
  *
  * @since 2.5.0
  *
- * @param string|string[] $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
+ * @param string|string[] $wildcard_mime_types Mime types, e.g. `audio/mpeg`, `image` (same as `image/*`),
- *                                             or flash (same as *flash*).
+ *                                             or `flash` (same as `*flash*`).
  * @param string|string[] $real_mime_types     Real post mime type values.
  * @return array array(wildcard=>array(real types)).
  */

wp-includes/version.php

@@ -16,7 +16,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '6.1-alpha-53877';
+$wp_version = '6.1-alpha-53878';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.