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

Timestamp:

07/10/2023 10:36:06 PM (2 years ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180].

Props costdev, audrasjb.
See #58459.

File:

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

trunk/src/wp-includes/functions.php

@@ -3798 +3798 @@
         $dir_attr       = "dir='$text_direction'";
 
-        // If `text_direction` was not explicitly passed,
-        // use get_language_attributes() if available.
+        /*
+         * If `text_direction` was not explicitly passed,
+         * use get_language_attributes() if available.
+         */
         if ( empty( $args['text_direction'] )
             && function_exists( 'language_attributes' ) && function_exists( 'is_rtl' )
@@ -5086 +5088 @@
  */
 function _wp_to_kebab_case( $input_string ) {
-    //phpcs:disable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
-    // ignore the camelCase names for variables so the names are the same as lodash
-    // so comparing and porting new changes is easier.
+    // Ignore the camelCase names for variables so the names are the same as lodash so comparing and porting new changes is easier.
+    // phpcs:disable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
 
     /*
@@ -6898 +6899 @@
     $return          = array();
 
-    // Set evanescent_hare to one past hare.
-    // Increment hare two steps.
+    // Set evanescent_hare to one past hare. Increment hare two steps.
     while (
         $tortoise
@@ -8350 +8350 @@
 function get_dirsize( $directory, $max_execution_time = null ) {
 
-    // Exclude individual site directories from the total when checking the main site of a network,
-    // as they are subdirectories and should not be counted.
+    /*
+     * Exclude individual site directories from the total when checking the main site of a network,
+     * as they are subdirectories and should not be counted.
+     */
     if ( is_multisite() && is_main_site() ) {
         $size = recurse_dirsize( $directory, $directory . '/sites', $max_execution_time );