Changeset 53246

Timestamp:

04/24/2022 12:26:03 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in swp-includes/class-wp-customize-setting.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 $default parameter to $default_value in WP_Customize_Setting class methods.

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].

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

File:

• trunk/src/wp-includes/class-wp-customize-setting.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -548 +548 @@
      * @since 3.4.0
      *
-     * @param mixed $default A default value which is used as a fallback. Default null.
+     * @param mixed $default_value A default value which is used as a fallback. Default null.
      * @return mixed The default value on failure, otherwise the sanitized and validated value.
      */
-    final public function post_value( $default = null ) {
-        return $this->manager->post_value( $this, $default );
+    final public function post_value( $default_value = null ) {
+        return $this->manager->post_value( $this, $default_value );
     }
 
@@ -622 +622 @@
      * @since 4.4.0
      *
-     * @param mixed $default Value to return if root does not exist.
+     * @param mixed $default_value Value to return if root does not exist.
      * @return mixed
      */
-    protected function get_root_value( $default = null ) {
+    protected function get_root_value( $default_value = null ) {
         $id_base = $this->id_data['base'];
         if ( 'option' === $this->type ) {
-            return get_option( $id_base, $default );
+            return get_option( $id_base, $default_value );
         } elseif ( 'theme_mod' === $this->type ) {
-            return get_theme_mod( $id_base, $default );
+            return get_theme_mod( $id_base, $default_value );
         } else {
             /*
@@ -637 +637 @@
              * location.
              */
-            return $default;
+            return $default_value;
         }
     }
@@ -762 +762 @@
              * @since 4.6.0 Added the `$this` setting instance as the second parameter.
              *
-             * @param mixed                $default The setting default value. Default empty.
-             * @param WP_Customize_Setting $setting The setting instance.
+             * @param mixed                $default_value The setting default value. Default empty.
+             * @param WP_Customize_Setting $setting       The setting instance.
              */
             $value = apply_filters( "customize_value_{$id_base}", $value, $this );
@@ -931 +931 @@
      * @param array $root
      * @param array $keys
-     * @param mixed $default A default value which is used as a fallback. Default null.
+     * @param mixed $default_value A default value which is used as a fallback. Default null.
      * @return mixed The requested value or the default value.
      */
-    final protected function multidimensional_get( $root, $keys, $default = null ) {
+    final protected function multidimensional_get( $root, $keys, $default_value = null ) {
         if ( empty( $keys ) ) { // If there are no keys, test the root.
-            return isset( $root ) ? $root : $default;
+            return isset( $root ) ? $root : $default_value;
         }
 
         $result = $this->multidimensional( $root, $keys );
-        return isset( $result ) ? $result['node'][ $result['key'] ] : $default;
+        return isset( $result ) ? $result['node'][ $result['key'] ] : $default_value;
     }