Changeset 51781

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.

Location:

trunk/src/wp-admin/includes

Files:

• class-automatic-upgrader-skin.php (modified) (1 diff)
• class-bulk-upgrader-skin.php (modified) (1 diff)
• class-wp-ajax-upgrader-skin.php (modified) (1 diff)
• class-wp-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 ];

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

@@ -50 +50 @@
 
     /**
-     * @param string $string
-     * @param mixed  ...$args Optional text replacements.
+     * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.
+     *
+     * @param string $feedback Message data.
+     * @param mixed  ...$args  Optional text replacements.
      */
-    public function feedback( $string, ...$args ) {
-        if ( isset( $this->upgrader->strings[ $string ] ) ) {
-            $string = $this->upgrader->strings[ $string ];
+    public function feedback( $feedback, ...$args ) {
+        if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
+            $feedback = $this->upgrader->strings[ $feedback ];
         }
 
-        if ( strpos( $string, '%' ) !== false ) {
+        if ( strpos( $feedback, '%' ) !== false ) {
             if ( $args ) {
-                $args   = array_map( 'strip_tags', $args );
-                $args   = array_map( 'esc_html', $args );
-                $string = vsprintf( $string, $args );
+                $args     = array_map( 'strip_tags', $args );
+                $args     = array_map( 'esc_html', $args );
+                $feedback = vsprintf( $feedback, $args );
             }
         }
-        if ( empty( $string ) ) {
+        if ( empty( $feedback ) ) {
             return;
         }
         if ( $this->in_loop ) {
-            echo "$string<br />\n";
+            echo "$feedback<br />\n";
         } else {
-            echo "<p>$string</p>\n";
+            echo "<p>$feedback</p>\n";
         }
     }

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

@@ -122 +122 @@
      * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
      *              to the function signature.
+     * @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 ) ) {
-            foreach ( $data->get_error_codes() as $error_code ) {
-                $this->errors->add( $error_code, $data->get_error_message( $error_code ), $data->get_error_data( $error_code ) );
+    public function feedback( $feedback, ...$args ) {
+        if ( is_wp_error( $feedback ) ) {
+            foreach ( $feedback->get_error_codes() as $error_code ) {
+                $this->errors->add( $error_code, $feedback->get_error_message( $error_code ), $feedback->get_error_data( $error_code ) );
             }
         }
 
-        parent::feedback( $data, ...$args );
+        parent::feedback( $feedback, ...$args );
     }
 }

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

@@ -187 +187 @@
     /**
      * @since 2.8.0
-     *
-     * @param string $string
-     * @param mixed  ...$args Optional text replacements.
-     */
-    public function feedback( $string, ...$args ) {
-        if ( isset( $this->upgrader->strings[ $string ] ) ) {
-            $string = $this->upgrader->strings[ $string ];
-        }
-
-        if ( strpos( $string, '%' ) !== false ) {
+     * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.
+     *
+     * @param string $feedback Message data.
+     * @param mixed  ...$args  Optional text replacements.
+     */
+    public function feedback( $feedback, ...$args ) {
+        if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
+            $feedback = $this->upgrader->strings[ $feedback ];
+        }
+
+        if ( strpos( $feedback, '%' ) !== false ) {
             if ( $args ) {
-                $args   = array_map( 'strip_tags', $args );
-                $args   = array_map( 'esc_html', $args );
-                $string = vsprintf( $string, $args );
+                $args     = array_map( 'strip_tags', $args );
+                $args     = array_map( 'esc_html', $args );
+                $feedback = vsprintf( $feedback, $args );
             }
         }
-        if ( empty( $string ) ) {
-            return;
-        }
-        show_message( $string );
+        if ( empty( $feedback ) ) {
+            return;
+        }
+        show_message( $feedback );
     }