Changeset 49628 for trunk/src/wp-includes/functions.php

Timestamp:

11/17/2020 03:36:02 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust comments for recurse_dirsize() and related tests per the documentation standards.

Follow-up to [49212], [49616].

See #19879.

File:

• trunk/src/wp-includes/functions.php (modified) (4 diffs)

trunk/src/wp-includes/functions.php

@@ -7608 +7608 @@
  * Get the size of a directory recursively.
  *
- * Used by get_dirsize() to get a directory's size when it contains
- * other directories.
+ * Used by get_dirsize() to get a directory size when it contains other directories.
  *
  * @since MU (3.0.0)
- * @since 4.3.0 $exclude parameter added.
- * @since 5.2.0 $max_execution_time parameter added.
- * @since 5.6.0 $directory_cache parameter added.
+ * @since 4.3.0 The `$exclude` parameter was added.
+ * @since 5.2.0 The `$max_execution_time` parameter was added.
+ * @since 5.6.0 The `$directory_cache` parameter was added.
  *
  * @param string       $directory          Full path of a directory.
@@ -7669 +7668 @@
 
     /**
-    * Filters the amount of storage space used by one directory and all it's children, in megabytes.
-    * Return the actual used space to shortcircuit the recursive PHP file size calculation and use something else
-    * like a CDN API or native operating system tools for better performance
-    *
-    * @since 5.6.0
-    *
-    * @param int|false $space_used The amount of used space, in bytes. Default 0.
-    */
+     * Filters the amount of storage space used by one directory and all its children, in megabytes.
+     *
+     * Return the actual used space to short-circuit the recursive PHP file size calculation
+     * and use something else, like a CDN API or native operating system tools for better performance.
+     *
+     * @since 5.6.0
+     *
+     * @param int|false $space_used The amount of used space, in bytes. Default 0.
+     */
     $size = apply_filters( 'calculate_current_dirsize', $size, $directory, $exclude, $max_execution_time, $directory_cache );
 
@@ -7706 +7706 @@
     $directory_cache[ $cache_path ] = $size;
 
-    // Only write the transient on the top level call and not on recursive calls
+    // Only write the transient on the top level call and not on recursive calls.
     if ( $save_cache ) {
         set_transient( 'dirsize_cache', $directory_cache );
@@ -7715 +7715 @@
 
 /**
- * Invalidates entries within the dirsize_cache
- *
- * Remove the current directory and all parent directories
- * from the dirsize_cache transient.
+ * Cleans directory size cache used by recurse_dirsize().
+ *
+ * Removes the current directory and all parent directories from the `dirsize_cache` transient.
  *
  * @since 5.6.0