Changeset 53277

Timestamp:

04/26/2022 01:30:47 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/class-wp-query.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 $array parameter to $query_vars in WP_Query::fill_query_vars().
• Renames the $default parameter to $default_value in WP_Query::get().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276].

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

File:

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

trunk/src/wp-includes/class-wp-query.php

@@ -537 +537 @@
      * @since 4.5.0 Removed the `comments_popup` public query variable.
      *
-     * @param array $array Defined query variables.
+     * @param array $query_vars Defined query variables.
      * @return array Complete query variables with undefined ones filled in empty.
      */
-    public function fill_query_vars( $array ) {
+    public function fill_query_vars( $query_vars ) {
         $keys = array(
             'error',
@@ -581 +581 @@
 
         foreach ( $keys as $key ) {
-            if ( ! isset( $array[ $key ] ) ) {
-                $array[ $key ] = '';
+            if ( ! isset( $query_vars[ $key ] ) ) {
+                $query_vars[ $key ] = '';
             }
         }
@@ -605 +605 @@
 
         foreach ( $array_keys as $key ) {
-            if ( ! isset( $array[ $key ] ) ) {
-                $array[ $key ] = array();
-            }
-        }
-        return $array;
+            if ( ! isset( $query_vars[ $key ] ) ) {
+                $query_vars[ $key ] = array();
+            }
+        }
+
+        return $query_vars;
     }
 
@@ -1748 +1749 @@
      *
      * @since 1.5.0
-     * @since 3.9.0 The `$default` argument was introduced.
-     *
-     * @param string $query_var Query variable key.
-     * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty string.
+     * @since 3.9.0 The `$default_value` argument was introduced.
+     *
+     * @param string $query_var     Query variable key.
+     * @param mixed  $default_value Optional. Value to return if the query variable is not set. Default empty string.
      * @return mixed Contents of the query variable.
      */
-    public function get( $query_var, $default = '' ) {
+    public function get( $query_var, $default_value = '' ) {
         if ( isset( $this->query_vars[ $query_var ] ) ) {
             return $this->query_vars[ $query_var ];
         }
 
-        return $default;
+        return $default_value;
     }