<!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>[51780] trunk/src: Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in `Walker::end_el()`.</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/51780">51780</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/51780","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:02:46 +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 `Walker::end_el()`.
In the parent class, renames the parameter `$object` to `$data_object`.
Why? `object` is a PHP reserved keyword. The parameter name is selected for consistency with `Walker::start_el()`.
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/7737">[7737]</a>, <a href="https://core.trac.wordpress.org/changeset/8900">[8900]</a>, <a href="https://core.trac.wordpress.org/changeset/8970">[8970]</a>, <a href="https://core.trac.wordpress.org/changeset/14248">[14248]</a>, <a href="https://core.trac.wordpress.org/changeset/16100">[16100]</a>, <a href="https://core.trac.wordpress.org/changeset/25642">[25642]</a>, <a href="https://core.trac.wordpress.org/changeset/25644">[25644]</a>, <a href="https://core.trac.wordpress.org/changeset/37051">[37051]</a>, <a href="https://core.trac.wordpress.org/changeset/37056">[37056]</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="#trunksrcwpadminincludesclasswalkercategorychecklistphp">trunk/src/wp-admin/includes/class-walker-category-checklist.php</a></li>
<li><a href="#trunksrcwpincludesclasswalkercategoryphp">trunk/src/wp-includes/class-walker-category.php</a></li>
<li><a href="#trunksrcwpincludesclasswalkercommentphp">trunk/src/wp-includes/class-walker-comment.php</a></li>
<li><a href="#trunksrcwpincludesclasswalkernavmenuphp">trunk/src/wp-includes/class-walker-nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesclasswalkerpagephp">trunk/src/wp-includes/class-walker-page.php</a></li>
<li><a href="#trunksrcwpincludesclasswpwalkerphp">trunk/src/wp-includes/class-wp-walker.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswalkercategorychecklistphp"></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-walker-category-checklist.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-walker-category-checklist.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-admin/includes/class-walker-category-checklist.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,13 +125,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::end_el()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.1
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$category` to `$data_object` to match parent class 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 $output Used to append additional content (passed by reference).
- * @param WP_Term $category The current term object.
- * @param int $depth Depth of the term in reference to parents. Default 0.
- * @param array $args An array of arguments. @see wp_terms_checklist()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content (passed by reference).
+ * @param WP_Term $data_object The current term object.
+ * @param int $depth Depth of the term in reference to parents. Default 0.
+ * @param array $args An array of arguments. @see wp_terms_checklist()
</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 end_el( &$output, $category, $depth = 0, $args = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output .= "</li>\n";
</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="trunksrcwpincludesclasswalkercategoryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-walker-category.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-walker-category.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-includes/class-walker-category.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -254,16 +254,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Ends the element output, if needed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::end_el()
</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 $output Used to append additional content (passed by reference).
- * @param object $page Not used.
- * @param int $depth Optional. Depth of category. Not used.
- * @param array $args Optional. An array of arguments. Only uses 'list' for whether should append
- * to output. See wp_list_categories(). Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content (passed by reference).
+ * @param object $data_object Category data object. Not used.
+ * @param int $depth Optional. Depth of category. Not used.
+ * @param array $args Optional. An array of arguments. Only uses 'list' for whether should
+ * append to output. See wp_list_categories(). Default empty array.
</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 end_el( &$output, $page, $depth = 0, $args = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'list' !== $args['style'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesclasswalkercommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-walker-comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-walker-comment.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-includes/class-walker-comment.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,19 +213,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Ends the element output, if needed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$comment` to `$data_object` to match parent class for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::end_el()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_list_comments()
</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 $output Used to append additional content. Passed by reference.
- * @param WP_Comment $comment The current comment object. Default current comment.
- * @param int $depth Optional. Depth of the current comment. Default 0.
- * @param array $args Optional. An array of arguments. Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content. Passed by reference.
+ * @param WP_Comment $data_object Comment data object.
+ * @param int $depth Optional. Depth of the current comment. Default 0.
+ * @param array $args Optional. An array of arguments. Default empty array.
</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 end_el( &$output, $comment, $depth = 0, $args = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $args['end-callback'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- call_user_func( $args['end-callback'], $comment, $args, $depth );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ call_user_func(
+ $args['end-callback'],
+ $data_object, // The current comment object.
+ $args,
+ $depth
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> $output .= ob_get_clean();
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesclasswalkernavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-walker-nav-menu.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-includes/class-walker-nav-menu.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -256,15 +256,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Ends the element output, if needed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$item` to `$data_object` to match parent class for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::end_el()
</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 $output Used to append additional content (passed by reference).
- * @param WP_Post $item Page data object. Not used.
- * @param int $depth Depth of page. Not Used.
- * @param stdClass $args An object of wp_nav_menu() arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content (passed by reference).
+ * @param WP_Post $data_object Menu item data object. Not used.
+ * @param int $depth Depth of page. Not Used.
+ * @param stdClass $args An object of wp_nav_menu() arguments.
</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 end_el( &$output, $item, $depth = 0, $args = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $t = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $n = '';
</span></span></pre></div>
<a id="trunksrcwpincludesclasswalkerpagephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-walker-page.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-walker-page.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-includes/class-walker-page.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,15 +222,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Outputs the end of the current element in the tree.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::end_el()
</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 $output Used to append additional content. Passed by reference.
- * @param WP_Post $page Page data object. Not used.
- * @param int $depth Optional. Depth of page. Default 0 (unused).
- * @param array $args Optional. Array of arguments. Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content. Passed by reference.
+ * @param WP_Post $data_object Page data object. Not used.
+ * @param int $depth Optional. Depth of page. Default 0 (unused).
+ * @param array $args Optional. Array of arguments. Default empty array.
</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 end_el( &$output, $page, $depth = 0, $args = array() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $t = "\t";
</span><span class="cx" style="display: block; padding: 0 10px"> $n = "\n";
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpwalkerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-walker.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-walker.php 2021-09-09 12:38:36 UTC (rev 51779)
+++ trunk/src/wp-includes/class-wp-walker.php 2021-09-09 13:02:46 UTC (rev 51780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,14 +100,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The $args parameter holds additional values that may be used with the child class methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.9.0 Renamed `$object` (a PHP reserved keyword) to `$data_object` for PHP 8 named parameter support.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @abstract
</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 $output Used to append additional content (passed by reference).
- * @param object $object The data object.
- * @param int $depth Depth of the item.
- * @param array $args An array of additional arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $output Used to append additional content (passed by reference).
+ * @param object $data_object The data object.
+ * @param int $depth Depth of the item.
+ * @param array $args An array of additional arguments.
</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 end_el( &$output, $object, $depth = 0, $args = array() ) {}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {}
</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"> * Traverse elements to create list from elements.
</span></span></pre>
</div>
</div>
</body>
</html>