<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[51781] trunk/src/wp-admin/includes: Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `WP_Upgrader_Skin::feedback()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/51781">51781</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51781","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-09-09 13:47:17 +0000 (Thu, 09 Sep 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/11005">[11005]</a>, <a href="https://core.trac.wordpress.org/changeset/25228">[25228]</a>, <a href="https://core.trac.wordpress.org/changeset/30680">[30680]</a>, <a href="https://core.trac.wordpress.org/changeset/32655">[32655]</a>, <a href="https://core.trac.wordpress.org/changeset/38199">[38199]</a>, <a href="https://core.trac.wordpress.org/changeset/49596">[49596]</a>.
Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See <a href="https://core.trac.wordpress.org/ticket/51553">#51553</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclassautomaticupgraderskinphp">trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php</a></li>
<li><a href="#trunksrcwpadminincludesclassbulkupgraderskinphp">trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpajaxupgraderskinphp">trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpupgraderskinphp">trunk/src/wp-admin/includes/class-wp-upgrader-skin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclassautomaticupgraderskinphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php 2021-09-09 13:02:46 UTC (rev 51780)
+++ trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php 2021-09-09 13:47:17 UTC (rev 51781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,18 +66,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Stores a message about the upgrade.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$data` to `$feedback` for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array|WP_Error $data Message data.
- * @param mixed ...$args Optional text replacements.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array|WP_Error $feedback Message data.
+ * @param mixed ...$args Optional text replacements.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function feedback( $data, ...$args ) {
- if ( is_wp_error( $data ) ) {
- $string = $data->get_error_message();
- } elseif ( is_array( $data ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function feedback( $feedback, ...$args ) {
+ if ( is_wp_error( $feedback ) ) {
+ $string = $feedback->get_error_message();
+ } elseif ( is_array( $feedback ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $string = $data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $string = $feedback;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $string = $this->upgrader->strings[ $string ];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesclassbulkupgraderskinphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php 2021-09-09 13:02:46 UTC (rev 51780)
+++ trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php 2021-09-09 13:47:17 UTC (rev 51781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,28 +49,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string
- * @param mixed ...$args Optional text replacements.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function feedback( $string, ...$args ) {
- if ( isset( $this->upgrader->strings[ $string ] ) ) {
- $string = $this->upgrader->strings[ $string ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function feedback( $feedback, ...$args ) {
+ if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
+ $feedback = $this->upgrader->strings[ $feedback ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( strpos( $string, '%' ) !== false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( strpos( $feedback, '%' ) !== false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = array_map( 'strip_tags', $args );
- $args = array_map( 'esc_html', $args );
- $string = vsprintf( $string, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array_map( 'strip_tags', $args );
+ $args = array_map( 'esc_html', $args );
+ $feedback = vsprintf( $feedback, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $string ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $feedback ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->in_loop ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo "$string<br />\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "$feedback<br />\n";
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo "<p>$string</p>\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo "<p>$feedback</p>\n";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpajaxupgraderskinphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php 2021-09-09 13:02:46 UTC (rev 51780)
+++ trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php 2021-09-09 13:47:17 UTC (rev 51781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,17 +121,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
</span><span class="cx" style="display: block; padding: 0 10px"> * to the function signature.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$data` to `$feedback` for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array|WP_Error $data Message data.
- * @param mixed ...$args Optional text replacements.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array|WP_Error $feedback Message data.
+ * @param mixed ...$args Optional text replacements.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- parent::feedback( $data, ...$args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ parent::feedback( $feedback, ...$args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpupgraderskinphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader-skin.php 2021-09-09 13:02:46 UTC (rev 51780)
+++ trunk/src/wp-admin/includes/class-wp-upgrader-skin.php 2021-09-09 13:47:17 UTC (rev 51781)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,26 +186,27 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $string
- * @param mixed ...$args Optional text replacements.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $feedback Message data.
+ * @param mixed ...$args Optional text replacements.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function feedback( $string, ...$args ) {
- if ( isset( $this->upgrader->strings[ $string ] ) ) {
- $string = $this->upgrader->strings[ $string ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function feedback( $feedback, ...$args ) {
+ if ( isset( $this->upgrader->strings[ $feedback ] ) ) {
+ $feedback = $this->upgrader->strings[ $feedback ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( strpos( $string, '%' ) !== false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( strpos( $feedback, '%' ) !== false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = array_map( 'strip_tags', $args );
- $args = array_map( 'esc_html', $args );
- $string = vsprintf( $string, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array_map( 'strip_tags', $args );
+ $args = array_map( 'esc_html', $args );
+ $feedback = vsprintf( $feedback, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $string ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $feedback ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- show_message( $string );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ show_message( $feedback );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>