From d5b7d494fc7ede3d3fb36544967268d98fa6bec9 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sun, 27 Mar 2022 14:53:21 +0000 Subject: [PATCH] Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-theme-upgrader.php`. While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names. This commit renames the `$return` variable in `Theme_Upgrader` class methods to `$response` and updates the documentation accordingly. Follow-up to [47409], [52946], [52996], [52997]. Props jrf, aristath, poena, justinahinon, SergeyBiryukov. See #55327. git-svn-id: https://develop.svn.wordpress.org/trunk@52998 602fd350-edb4-49c9-b593-d223f7449a82 --- .../includes/class-theme-upgrader.php | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/src/wp-admin/includes/class-theme-upgrader.php b/src/wp-admin/includes/class-theme-upgrader.php index 8f24d1aa59..0a73f4b86c 100644 --- a/src/wp-admin/includes/class-theme-upgrader.php +++ b/src/wp-admin/includes/class-theme-upgrader.php @@ -616,20 +616,20 @@ class Theme_Upgrader extends WP_Upgrader { * * @since 2.8.0 * - * @param bool|WP_Error $return Upgrade offer return. - * @param array $theme Theme arguments. - * @return bool|WP_Error The passed in $return param or WP_Error. + * @param bool|WP_Error $response The installation response before the installation has started. + * @param array $theme Theme arguments. + * @return bool|WP_Error The original `$response` parameter or WP_Error. */ - public function current_before( $return, $theme ) { - if ( is_wp_error( $return ) ) { - return $return; + public function current_before( $response, $theme ) { + if ( is_wp_error( $response ) ) { + return $response; } $theme = isset( $theme['theme'] ) ? $theme['theme'] : ''; - // Only run if active theme + // Only run if active theme. if ( get_stylesheet() !== $theme ) { - return $return; + return $response; } // Change to maintenance mode. Bulk edit handles this separately. @@ -637,7 +637,7 @@ class Theme_Upgrader extends WP_Upgrader { $this->maintenance_mode( true ); } - return $return; + return $response; } /** @@ -648,20 +648,20 @@ class Theme_Upgrader extends WP_Upgrader { * * @since 2.8.0 * - * @param bool|WP_Error $return Upgrade offer return. - * @param array $theme Theme arguments. - * @return bool|WP_Error The passed in $return param or WP_Error. + * @param bool|WP_Error $response The installation response after the installation has finished. + * @param array $theme Theme arguments. + * @return bool|WP_Error The original `$response` parameter or WP_Error. */ - public function current_after( $return, $theme ) { - if ( is_wp_error( $return ) ) { - return $return; + public function current_after( $response, $theme ) { + if ( is_wp_error( $response ) ) { + return $response; } $theme = isset( $theme['theme'] ) ? $theme['theme'] : ''; // Only run if active theme. if ( get_stylesheet() !== $theme ) { - return $return; + return $response; } // Ensure stylesheet name hasn't changed after the upgrade: @@ -675,7 +675,7 @@ class Theme_Upgrader extends WP_Upgrader { if ( ! $this->bulk ) { $this->maintenance_mode( false ); } - return $return; + return $response; } /**