From 03331f52fffe8ff686af15b12af49e9d0ba5ab4f Mon Sep 17 00:00:00 2001 From: hellofromTonya Date: Thu, 9 Sep 2021 13:48:56 +0000 Subject: [PATCH] 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. Built from https://develop.svn.wordpress.org/trunk@51781 git-svn-id: http://core.svn.wordpress.org/trunk@51388 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- .../class-automatic-upgrader-skin.php | 16 +++++++----- .../includes/class-bulk-upgrader-skin.php | 26 ++++++++++--------- .../includes/class-wp-ajax-upgrader-skin.php | 15 ++++++----- wp-admin/includes/class-wp-upgrader-skin.php | 23 ++++++++-------- wp-includes/version.php | 2 +- 5 files changed, 44 insertions(+), 38 deletions(-) diff --git a/wp-admin/includes/class-automatic-upgrader-skin.php b/wp-admin/includes/class-automatic-upgrader-skin.php index 686f95dd84..15ea79f5f4 100644 --- a/wp-admin/includes/class-automatic-upgrader-skin.php +++ b/wp-admin/includes/class-automatic-upgrader-skin.php @@ -66,18 +66,20 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin { * Stores a message about the upgrade. * * @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 ]; } diff --git a/wp-admin/includes/class-bulk-upgrader-skin.php b/wp-admin/includes/class-bulk-upgrader-skin.php index c5cbcd487e..d09b0e9fcc 100644 --- a/wp-admin/includes/class-bulk-upgrader-skin.php +++ b/wp-admin/includes/class-bulk-upgrader-skin.php @@ -49,28 +49,30 @@ class Bulk_Upgrader_Skin extends WP_Upgrader_Skin { } /** - * @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
\n"; + echo "$feedback
\n"; } else { - echo "

$string

\n"; + echo "

$feedback

\n"; } } diff --git a/wp-admin/includes/class-wp-ajax-upgrader-skin.php b/wp-admin/includes/class-wp-ajax-upgrader-skin.php index 27d8beb740..bb5a961251 100644 --- a/wp-admin/includes/class-wp-ajax-upgrader-skin.php +++ b/wp-admin/includes/class-wp-ajax-upgrader-skin.php @@ -121,17 +121,18 @@ class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin { * @since 4.6.0 * @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 ); } } diff --git a/wp-admin/includes/class-wp-upgrader-skin.php b/wp-admin/includes/class-wp-upgrader-skin.php index 33f083a3e7..40053df1bc 100644 --- a/wp-admin/includes/class-wp-upgrader-skin.php +++ b/wp-admin/includes/class-wp-upgrader-skin.php @@ -186,26 +186,27 @@ class WP_Upgrader_Skin { /** * @since 2.8.0 + * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support. * - * @param string $string - * @param mixed ...$args Optional text replacements. + * @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; } - show_message( $string ); + show_message( $feedback ); } /** diff --git a/wp-includes/version.php b/wp-includes/version.php index cf8a23499f..8ed66486df 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.9-alpha-51780'; +$wp_version = '5.9-alpha-51781'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.