Changeset 51789

Timestamp:

09/09/2021 08:12:58 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_Widget::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.

Adds @since to clearly specify why the change happened.

Replaces the original with the variable name with within each method.
Why? The new name is more specific and descriptive, which improves readability.

Follow-up to [10782], [25090], [26556], [40640].

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

Location:

trunk/src

Files:

• wp-content/themes/twentyfourteen/inc/widgets.php (modified) (1 diff)
• wp-includes/widgets/class-wp-widget-media.php (modified) (3 diffs)

trunk/src/wp-content/themes/twentyfourteen/inc/widgets.php

@@ -263 +263 @@
      *
      * @since Twenty Fourteen 1.0
+     * @since Twenty Fourteen 3.3 Renamed `$instance` to `$old_instance` to match
+     *                            parent class for PHP 8 named parameter support.
      *
      * @param array $new_instance New widget instance.
-     * @param array $instance     Original widget instance.
+     * @param array $old_instance Original widget instance.
      * @return array Updated widget instance.
      */
-    function update( $new_instance, $instance ) {
-        $instance['title']  = strip_tags( $new_instance['title'] );
-        $instance['number'] = empty( $new_instance['number'] ) ? 2 : absint( $new_instance['number'] );
+    function update( $new_instance, $old_instance ) {
+        $old_instance['title']  = strip_tags( $new_instance['title'] );
+        $old_instance['number'] = empty( $new_instance['number'] ) ? 2 : absint( $new_instance['number'] );
 
         if ( in_array( $new_instance['format'], $this->formats, true ) ) {
-            $instance['format'] = $new_instance['format'];
-        }
-
-        return $instance;
+            $old_instance['format'] = $new_instance['format'];
+        }
+
+        return $old_instance;
     }
 

trunk/src/wp-includes/widgets/class-wp-widget-media.php

@@ -260 +260 @@
      *
      * @since 4.8.0
+     * @since 5.9.0 Renamed `$instance` to `$old_instance` to match parent class
+     *              for PHP 8 named parameter support.
      *
      * @see WP_Widget::update()
@@ -266 +268 @@
      *
      * @param array $new_instance Values just sent to be saved.
-     * @param array $instance     Previously saved values from database.
+     * @param array $old_instance Previously saved values from database.
      * @return array Updated safe values to be saved.
      */
-    public function update( $new_instance, $instance ) {
+    public function update( $new_instance, $old_instance ) {
 
         $schema = $this->get_instance_schema();
@@ -304 +306 @@
                 continue;
             }
-            $instance[ $field ] = $value;
-        }
-
-        return $instance;
+            $old_instance[ $field ] = $value;
+        }
+
+        return $old_instance;
     }