Changeset 12498

Timestamp:

11/29/2019 03:46:56 AM (5 years ago)

Author:

imath

Message:

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 [12497] 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 #8163 (Trunk)

Location:

trunk

Files:

• src/bp-core/classes/class-bp-walker-nav-menu.php (modified) (3 diffs)
• src/bp-core/compat (added)
• src/bp-core/compat/php53 (added)
• src/bp-core/compat/php53/class-bp-compat-walker-nav-menu.php (added)
• src/bp-core/compat/php56 (added)
• src/bp-core/compat/php56/class-bp-compat-walker-nav-menu.php (added)
• tests/phpunit/testcases/core/class-bp-walker-nav-menu.php (added)

trunk/src/bp-core/classes/class-bp-walker-nav-menu.php

@@ -12 +12 @@
 
 /**
- * Create HTML list of BP nav items.
+ * Compatibility Class to make BP_Walker_Nav_Menu::walk() compatible
+ * from PHP 5.3 to 5.6 and up.
  *
- * @since 1.7.0
+ * @since 5.1.0
  */
-class BP_Walker_Nav_Menu extends Walker_Nav_Menu {
-
+class BP_Walker_Nav_Menu_Compat extends Walker_Nav_Menu {
     /**
      * Description of fields indexes for building markup.
@@ -48 +48 @@
      *
      * @since 1.7.0
-     * @since 6.0.0 Formalized the existing `...$args` parameter by adding it
-     *              to the function signature to match WordPress 5.3.
+     * @since 5.1.0 Method was renamed from `walk` to `do_walk` to ensure PHP 5.3 compatibility
+     *
      * @see Walker::walk()
      *
      * @param array $elements  See {@link Walker::walk()}.
      * @param int   $max_depth See {@link Walker::walk()}.
-     * @param mixed ...$args   Optional additional arguments.
+     * @param array $args      Optional additional arguments.
      * @return string See {@link Walker::walk()}.
      */
-    public function walk( $elements, $max_depth, ...$args ) {
+    public function do_walk( $elements, $max_depth, $args = array() ) {
         $output = '';
 
@@ -213 +213 @@
     }
 }
+
+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';
+}