Changeset 54284

Timestamp:

09/21/2022 08:22:53 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Updates and corrections to various inline docs added in 6.1.

See #55646

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-site-health.php (modified) (4 diffs)
• wp-includes/blocks/comments.php (modified) (1 diff)
• wp-includes/class-wp-theme-json-resolver.php (modified) (1 diff)
• wp-includes/pluggable.php (modified) (3 diffs)
• wp-includes/post-template.php (modified) (1 diff)
• wp-includes/post.php (modified) (2 diffs)
• wp-includes/update.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2487 +2487 @@
                  * @since 6.1.0
                  *
-                 * @param string $notes              The notes appended to the health check description.
-                 * @param array  $available_services The list of available persistent object cache services.
+                 * @param string   $notes              The notes appended to the health check description.
+                 * @param string[] $available_services The list of available persistent object cache services.
                  */
                 $notes = apply_filters( 'site_status_persistent_object_cache_notes', $notes, $available_services );
@@ -3350 +3350 @@
                  * @since 6.1.0
                  *
-                 * @param array $thresholds The list of threshold names and numbers.
+                 * @param int[] $thresholds The list of threshold numbers keyed by threshold name.
                  */
                 $thresholds = apply_filters(
@@ -3409 +3409 @@
          * @since 6.1.0
          *
-         * @return array The list of available persistent object cache services.
+         * @return string[] The list of available persistent object cache services.
          */
         private function available_object_cache_services() {
@@ -3432 +3432 @@
                  * @since 6.1.0
                  *
-                 * @param array $services The list of available persistent object cache services.
+                 * @param string[] $services The list of available persistent object cache services.
                  */
                 return apply_filters( 'site_status_available_object_cache_services', $services );

trunk/src/wp-includes/blocks/comments.php

@@ -214 +214 @@
          * the block has multiple styles.
          */
+        /** This filter is documented in wp-includes/blocks.php */
         $metadata = apply_filters( 'block_type_metadata', $metadata );
 

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

@@ -435 +435 @@
                 }
 
-                /**
-                 * Filters the data provided by the user for global styles & settings.
-                 *
-                 * @since 6.1.0
-                 *
-                 * @param WP_Theme_JSON_Data Class to access and update the underlying data.
-                 */
+                /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
                 $theme_json   = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
                 $config       = $theme_json->get_data();

trunk/src/wp-includes/pluggable.php

@@ -2246 +2246 @@
          *
          * @since 2.5.0
-         * @since 6.1.0 Added `action` argument.
-         *
-         * @param string|int $action Optional. The current nonce action. Default -1.
+         * @since 6.1.0 Added `$action` argument.
+         *
+         * @param string|int $action Optional. The nonce action. Default -1.
          * @return float Float value rounded up to the next highest integer.
          */
@@ -2256 +2256 @@
                  *
                  * @since 2.5.0
-                 * @since 6.1.0 Added `action` argument to allow for more targeted filters.
+                 * @since 6.1.0 Added `$action` argument to allow for more targeted filters.
                  *
                  * @param int        $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
-                 * @param string|int $action   The current nonce action.
+                 * @param string|int $action   The nonce action, or -1 if none was provided.
                  */
                 $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS, $action );
@@ -2291 +2291 @@
                          * @since 3.5.0
                          *
-                         * @param int    $uid    ID of the nonce-owning user.
-                         * @param string $action The nonce action.
+                         * @param int        $uid    ID of the nonce-owning user.
+                         * @param string|int $action The nonce action, or -1 if none was provided.
                          */
                         $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );

trunk/src/wp-includes/post-template.php

@@ -556 +556 @@
          * @since 6.1.0
          *
-         * @param array    $taxonomies List of all public taxonomies to generate classes for.
+         * @param string[] $taxonomies List of all taxonomy names to generate classes for.
          * @param int      $post_id    The post ID.
          * @param string[] $classes    An array of post class names.

trunk/src/wp-includes/post.php

@@ -3386 +3386 @@
          * @since 4.4.0
          *
-         * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
+         * @param WP_Post|false|null $delete       Whether to go forward with deletion.
          * @param WP_Post            $post         Post object.
          * @param bool               $force_delete Whether to bypass the Trash.
@@ -6373 +6373 @@
          * @since 5.5.0
          *
-         * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
+         * @param WP_Post|false|null $delete       Whether to go forward with deletion.
          * @param WP_Post            $post         Post object.
          * @param bool               $force_delete Whether to bypass the Trash.

trunk/src/wp-includes/update.php

@@ -683 +683 @@
          * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
          *
-         * @param array $locales Theme locales. Default is all available locales of the site.
+         * @param string[] $locales Theme locales. Default is all available locales of the site.
          */
         $locales = apply_filters( 'themes_update_check_locales', $locales );
@@ -789 +789 @@
                  * @param array       $theme_data       Theme headers.
                  * @param string      $theme_stylesheet Theme stylesheet.
-                 * @param array       $locales          Installed locales to look up translations for.
+                 * @param string[]    $locales          Installed locales to look up translations for.
                  */
                 $update = apply_filters( "update_themes_{$hostname}", false, $theme_data, $theme_stylesheet, $locales );