Changeset 51784

Timestamp:

09/09/2021 02:47:10 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_Customize_Setting::update().

In each child class: renames the parameter to match the parent's method signature.

Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Changes for readability:

• @since clearly specifies the original parameter name and its new name as well as why the change happened.

• In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.

Follow-up to [19995], [21037], [21053], [21354], [38829], [51298].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

Location:

trunk/src/wp-includes/customize

Files:

• class-wp-customize-background-image-setting.php (modified) (1 diff)
• class-wp-customize-custom-css-setting.php (modified) (1 diff)
• class-wp-customize-header-image-setting.php (modified) (1 diff)

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

@@ -21 +21 @@
      * @since 3.4.0
      *
-     * @param mixed $value
+     * @param mixed $value The value to update. Not used.
      */
     public function update( $value ) {

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

@@ -174 +174 @@
      *
      * @since 4.7.0
-     *
-     * @param string $css The input value.
+     * @since 5.9.0 Renamed `$css` to `$value` for PHP 8 named parameter support.
+     *
+     * @param string $value CSS to update.
      * @return int|false The post ID or false if the value could not be saved.
      */
-    public function update( $css ) {
+    public function update( $value ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $css = $value;
+
         if ( empty( $css ) ) {
             $css = '';

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

@@ -25 +25 @@
      * @global Custom_Image_Header $custom_image_header
      *
-     * @param mixed $value
+     * @param mixed $value The value to update.
      */
     public function update( $value ) {