Changeset 52997 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

03/27/2022 02:43:25 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-plugin-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 Plugin_Upgrader class methods to $response and updates the documentation accordingly.

Follow-up to [47409], [52946], [52996].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (2 diffs)

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

@@ -478 +478 @@
 
                 /**
-                 * Filters the install response before the installation has started.
+                 * Filters the installation response before the installation has started.
                  *
                  * Returning a value that could be evaluated as a `WP_Error` will effectively
@@ -485 +485 @@
                  * @since 2.8.0
                  *
-                 * @param bool|WP_Error $response   Response.
+                 * @param bool|WP_Error $response   Installation response.
                  * @param array         $hook_extra Extra arguments passed to hooked filters.
                  */