<!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>[BuddyPress][12498] trunk: Compat classes to handle `Walker_Nav_Menu::walk()` changes in WP 5.3</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="http://buddypress.trac.wordpress.org/changeset/12498">12498</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12498","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-11-29 03:46:56 +0000 (Fri, 29 Nov 2019)</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'>Compat classes to handle `Walker_Nav_Menu::walk()` changes in WP 5.3
WordPress 5.3 modified the `Walker_Nav_Menu::walk()` signature adding a third parameter to the method that is using the spread operator. johnjamesjacoby quickly fixed the issue in <a href="http://buddypress.trac.wordpress.org/changeset/12497">[12497]</a> when PHP >=5.6.
As our current PHP required version is 5.3, we need to provide a temporary compatibility mechanism to make sure our `BP_Walker_Nav_Menu` will not generate errors when the PHP version is lower than 5.6 before raising the PHP required version in our next major release.
props timothybjacobs, boonebgorges, imath
See <a href="http://buddypress.trac.wordpress.org/ticket/8163">#8163</a> (Trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpwalkernavmenuphp">trunk/src/bp-core/classes/class-bp-walker-nav-menu.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/src/bp-core/compat/</li>
<li>trunk/src/bp-core/compat/php53/</li>
<li><a href="#trunksrcbpcorecompatphp53classbpcompatwalkernavmenuphp">trunk/src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php</a></li>
<li>trunk/src/bp-core/compat/php56/</li>
<li><a href="#trunksrcbpcorecompatphp56classbpcompatwalkernavmenuphp">trunk/src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpwalkernavmenuphp">trunk/tests/phpunit/testcases/core/class-bp-walker-nav-menu.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpwalkernavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-walker-nav-menu.php 2019-11-13 02:25:01 UTC (rev 12497)
+++ trunk/src/bp-core/classes/class-bp-walker-nav-menu.php 2019-11-29 03:46:56 UTC (rev 12498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,12 +11,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'ABSPATH' ) || exit;
</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">- * Create HTML list of BP nav items.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Compatibility Class to make BP_Walker_Nav_Menu::walk() compatible
+ * from PHP 5.3 to 5.6 and up.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 1.7.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.1.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-class BP_Walker_Nav_Menu extends Walker_Nav_Menu {
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+class BP_Walker_Nav_Menu_Compat extends Walker_Nav_Menu {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Description of fields indexes for building markup.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,16 +47,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * those have ID/post_parent.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.0.0 Formalized the existing `...$args` parameter by adding it
- * to the function signature to match WordPress 5.3.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.1.0 Method was renamed from `walk` to `do_walk` to ensure PHP 5.3 compatibility
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see Walker::walk()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $elements See {@link Walker::walk()}.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $max_depth See {@link Walker::walk()}.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed ...$args Optional additional arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional additional arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string See {@link Walker::walk()}.
</span><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 walk( $elements, $max_depth, ...$args ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function do_walk( $elements, $max_depth, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $output = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $max_depth < -1 ) // Invalid parameter.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,3 +212,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $output .= apply_filters( 'bp_walker_nav_menu_start_el', $item_output, $item, $depth, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+if ( PHP_VERSION_ID >= 50600 ) {
+ require_once dirname( __DIR__ ) . '/compat/php56/class-bp-compat-walker-nav-menu.php';
+} else {
+ require_once dirname( __DIR__ ) . '/compat/php53/class-bp-compat-walker-nav-menu.php';
+}
</ins></span></pre></div>
<a id="trunksrcbpcorecompatphp53classbpcompatwalkernavmenuphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php (rev 0)
+++ trunk/src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php 2019-11-29 03:46:56 UTC (rev 12498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,32 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Walker_Nav_Menu Compat for PHP 5.3 and UP.
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ * @since 5.1.0
+ */
+
+ // Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Create HTML list of BP nav items.
+ *
+ * @since 1.7.0
+ */
+class BP_Walker_Nav_Menu extends BP_Walker_Nav_Menu_Compat {
+ /**
+ * Compat method to extend Walker_Nav_Menu::walk() in PHP < 5.6.
+ *
+ * @since 5.1.0
+ *
+ * @param array $elements See {@link Walker::walk()}.
+ * @param int $max_depth See {@link Walker::walk()}.
+ */
+ public function walk( $elements, $max_depth ) {
+ $args = array_slice( func_get_args(), 2 );
+
+ return $this->do_walk( $elements, $max_depth, $args );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunksrcbpcorecompatphp56classbpcompatwalkernavmenuphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php (rev 0)
+++ trunk/src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php 2019-11-29 03:46:56 UTC (rev 12498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,31 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Walker_Nav_Menu Compat for PHP 5.6 and UP.
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ * @since 5.1.0
+ */
+
+ // Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Create HTML list of BP nav items.
+ *
+ * @since 1.7.0
+ */
+class BP_Walker_Nav_Menu extends BP_Walker_Nav_Menu_Compat {
+ /**
+ * Compat method to extend Walker_Nav_Menu::walk() in PHP > 5.6.
+ *
+ * @since 5.1.0
+ *
+ * @param array $elements See {@link Walker::walk()}.
+ * @param int $max_depth See {@link Walker::walk()}.
+ * @param mixed ...$args See {@link Walker::walk()}.
+ */
+ public function walk( $elements, $max_depth, ...$args ) { // phpcs:ignore PHPCompatibility.LanguageConstructs.NewLanguageConstructs.t_ellipsisFound
+ return $this->do_walk( $elements, $max_depth, $args );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestcasescoreclassbpwalkernavmenuphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/core/class-bp-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-walker-nav-menu.php (rev 0)
+++ trunk/tests/phpunit/testcases/core/class-bp-walker-nav-menu.php 2019-11-29 03:46:56 UTC (rev 12498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,50 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group core
+ * @group BP_Walker_Nav_Menu
+ */
+class BP_Tests_Walker_Nav_Menu extends BP_UnitTestCase {
+ protected $reset_user_id;
+ protected $user_id;
+
+ public function setUp() {
+ parent::setUp();
+
+ $this->reset_user_id = get_current_user_id();
+
+ $this->user_id = self::factory()->user->create();
+ $this->set_current_user( $this->user_id );
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ $this->set_current_user( $this->reset_user_id );
+ }
+
+ public function test_walk_method() {
+ $expected = array( 'activity-class', 'xprofile-class' );
+ $items = array(
+ (object) array(
+ 'component_id' => 'activity',
+ 'name' => 'Activity',
+ 'slug' => 'activity',
+ 'link' => trailingslashit( bp_loggedin_user_domain() . bp_get_activity_slug() ),
+ 'css_id' => 'activity',
+ 'class' => array( $expected[0] ),
+ ),
+ (object) array(
+ 'component_id' => 'xprofile',
+ 'name' => 'Profile',
+ 'slug' => 'profile',
+ 'link' => trailingslashit( bp_loggedin_user_domain() . bp_get_profile_slug() ),
+ 'css_id' => 'xprofile',
+ 'class' => array( $expected[1] ),
+ ),
+ );
+ $args = (object) array( 'before' => '', 'link_before' => '', 'after' => '', 'link_after' => '' );
+ $walker = new BP_Walker_Nav_Menu();
+ $output = $walker->walk( $items, -1, $args );
+ preg_match_all( '/class=["\']?([^"\']*)["\' ]/is', $output, $classes );
+ $this->assertSame( $classes[1], $expected );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/testcases/core/class-bp-walker-nav-menu.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>