Changeset 51782 for trunk

Timestamp:

09/09/2021 01:58:25 PM (5 years ago)

Author:

hellofromTonya

Message:

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

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], [25806], [32655], [38199].

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

Location:

trunk/src/wp-admin/includes

Files:

• class-bulk-upgrader-skin.php (modified) (1 diff)
• class-language-pack-upgrader-skin.php (modified) (1 diff)
• class-wp-upgrader-skin.php (modified) (1 diff)

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

@@ -90 +90 @@
 
         /**
-         * @param string|WP_Error $error
+         * @since 5.9.0 Renamed `$error` to `$errors` for PHP 8 named parameter support.
+         *
+         * @param string|WP_Error $errors Errors.
          */
-        public function error( $error ) {
-                if ( is_string( $error ) && isset( $this->upgrader->strings[ $error ] ) ) {
-                        $this->error = $this->upgrader->strings[ $error ];
+        public function error( $errors ) {
+                if ( is_string( $errors ) && isset( $this->upgrader->strings[ $errors ] ) ) {
+                        $this->error = $this->upgrader->strings[ $errors ];
                 }
 
-                if ( is_wp_error( $error ) ) {
+                if ( is_wp_error( $errors ) ) {
                         $messages = array();
-                        foreach ( $error->get_error_messages() as $emessage ) {
-                                if ( $error->get_error_data() && is_string( $error->get_error_data() ) ) {
-                                        $messages[] = $emessage . ' ' . esc_html( strip_tags( $error->get_error_data() ) );
+                        foreach ( $errors->get_error_messages() as $emessage ) {
+                                if ( $errors->get_error_data() && is_string( $errors->get_error_data() ) ) {
+                                        $messages[] = $emessage . ' ' . esc_html( strip_tags( $errors->get_error_data() ) );
                                 } else {
                                         $messages[] = $emessage;

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

@@ -53 +53 @@
 
         /**
-         * @param string|WP_Error $error
+         * @since 5.9.0 Renamed `$error` to `$errors` for PHP 8 named parameter support.
+         *
+         * @param string|WP_Error $errors Errors.
          */
-        public function error( $error ) {
+        public function error( $errors ) {
                 echo '<div class="lp-error">';
-                parent::error( $error );
+                parent::error( $errors );
                 echo '</div>';
         }

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

@@ -166 +166 @@
          * @since 2.8.0
          *
-         * @param string|WP_Error $errors
+         * @param string|WP_Error $errors Errors.
          */
         public function error( $errors ) {