Changeset 51781 for trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

Timestamp:

09/09/2021 01:47:17 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in WP_Upgrader_Skin::feedback().

In the parent class, renames the parameter $string to $feedback.
Why? string is a PHP reserved keyword.

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.

Follow-up to [11005], [25228], [30680], [32655], [38199], [49596].

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

File:

• trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

@@ -67 +67 @@
      *
      * @since 3.7.0
+     * @since 5.9.0 Renamed `$data` to `$feedback` for PHP 8 named parameter support.
      *
-     * @param string|array|WP_Error $data    Message data.
-     * @param mixed                 ...$args Optional text replacements.
+     * @param string|array|WP_Error $feedback Message data.
+     * @param mixed                 ...$args  Optional text replacements.
      */
-    public function feedback( $data, ...$args ) {
-        if ( is_wp_error( $data ) ) {
-            $string = $data->get_error_message();
-        } elseif ( is_array( $data ) ) {
+    public function feedback( $feedback, ...$args ) {
+        if ( is_wp_error( $feedback ) ) {
+            $string = $feedback->get_error_message();
+        } elseif ( is_array( $feedback ) ) {
             return;
         } else {
-            $string = $data;
+            $string = $feedback;
         }
+
         if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
             $string = $this->upgrader->strings[ $string ];