Changeset 53003 for trunk/src/wp-admin/includes/class-wp-debug-data.php

Timestamp:

03/28/2022 01:22:38 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-wp-debug-data.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $var parameter to $mysql_var in WP_Debug_Data::get_mysql_var().

Additionally, $type is renamed to $data_type in WP_Debug_Data::format() for clarity.

Follow-up to [51522], [52946], [52996], [52997], [52998].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.

File:

• trunk/src/wp-admin/includes/class-wp-debug-data.php (modified) (6 diffs)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -1472 +1472 @@
 
         /**
-         * Returns the value of a MySQL variable.
+         * Returns the value of a MySQL system variable.
          *
          * @since 5.9.0
@@ -1478 +1478 @@
          * @global wpdb $wpdb WordPress database abstraction object.
          *
-         * @param string $var Name of the MySQL variable.
+         * @param string $mysql_var Name of the MySQL system variable.
          * @return string|null The variable value on success. Null if the variable does not exist.
          */
-        public static function get_mysql_var( $var ) {
+        public static function get_mysql_var( $mysql_var ) {
                 global $wpdb;
 
                 $result = $wpdb->get_row(
-                        $wpdb->prepare( 'SHOW VARIABLES LIKE %s', $var ),
+                        $wpdb->prepare( 'SHOW VARIABLES LIKE %s', $mysql_var ),
                         ARRAY_A
                 );
@@ -1501 +1501 @@
          * @since 5.2.0
          *
-         * @param array  $info_array Information gathered from the `WP_Debug_Data::debug_data` function.
-         * @param string $type       The data type to return, either 'info' or 'debug'.
+         * @param array  $info_array Information gathered from the `WP_Debug_Data::debug_data()` function.
+         * @param string $data_type  The data type to return, either 'info' or 'debug'.
          * @return string The formatted data.
          */
-        public static function format( $info_array, $type ) {
+        public static function format( $info_array, $data_type ) {
                 $return = "`\n";
 
@@ -1514 +1514 @@
                         }
 
-                        $section_label = 'debug' === $type ? $section : $details['label'];
+                        $section_label = 'debug' === $data_type ? $section : $details['label'];
 
                         $return .= sprintf(
@@ -1527 +1527 @@
                                 }
 
-                                if ( 'debug' === $type && isset( $field['debug'] ) ) {
+                                if ( 'debug' === $data_type && isset( $field['debug'] ) ) {
                                         $debug_data = $field['debug'];
                                 } else {
@@ -1548 +1548 @@
                                 }
 
-                                if ( 'debug' === $type ) {
+                                if ( 'debug' === $data_type ) {
                                         $label = $field_name;
                                 } else {