Changeset 56067 for trunk/tests/phpunit/tests/menu/walker-nav-menu.php

Timestamp:

06/27/2023 03:25:00 PM (3 years ago)

Author:

audrasjb

Message:

Menus: Allow themes and plugins to pass HTML attributes to various Nav Walker outputs.

This introduces a new set of hooks that can be used to filter various HTML elements of the Nav Walker, in order to output the desired HTML attributes:

• List items: nav_menu_item_attributes
• Submenu <ul> element: nav_menu_submenu_attributes

Props davidwebca, danyk4, costdev, peterwilsoncc, audrasjb, oglekler.
Fixes #57140.

File:

• trunk/tests/phpunit/tests/menu/walker-nav-menu.php (modified) (1 diff)

trunk/tests/phpunit/tests/menu/walker-nav-menu.php

@@ -366 +366 @@
         $this->assertStringContainsString( 'rel="privacy-policy"', $output );
     }
+
+    /**
+     * Tests that `Walker_Nav_Menu::start_lvl()` applies 'nav_menu_submenu_attributes' filters.
+     *
+     * @ticket 57278
+     *
+     * @covers Walker_Nav_Menu::start_lvl
+     */
+    public function test_start_lvl_should_apply_nav_menu_submenu_attributes_filters() {
+        $output = '';
+        $args   = (object) array(
+            'before'      => '',
+            'after'       => '',
+            'link_before' => '',
+            'link_after'  => '',
+        );
+
+        $filter = new MockAction();
+        add_filter( 'nav_menu_submenu_attributes', array( $filter, 'filter' ) );
+
+        $this->walker->start_lvl( $output, 0, $args );
+
+        $this->assertSame( 1, $filter->get_call_count() );
+    }
+
+    /**
+     * Tests that `Walker_Nav_Menu::start_el()` applies 'nav_menu_item_attributes' filters.
+     *
+     * @ticket 57278
+     *
+     * @covers Walker_Nav_Menu::start_el
+     */
+    public function test_start_el_should_apply_nav_menu_item_attributes_filters() {
+        $output  = '';
+        $post_id = self::factory()->post->create();
+        $item    = (object) array(
+            'ID'        => $post_id,
+            'object_id' => $post_id,
+            'title'     => get_the_title( $post_id ),
+            'target'    => '',
+            'xfn'       => '',
+            'current'   => false,
+        );
+        $args    = (object) array(
+            'before'      => '',
+            'after'       => '',
+            'link_before' => '',
+            'link_after'  => '',
+        );
+
+        $filter = new MockAction();
+        add_filter( 'nav_menu_item_attributes', array( $filter, 'filter' ) );
+
+        $this->walker->start_el( $output, $item, 0, $args );
+
+        $this->assertSame( 1, $filter->get_call_count() );
+    }
+
+    /**
+     * Tests that `Walker_Nav_Menu::build_atts()` builds attributes correctly.
+     *
+     * @ticket 57278
+     *
+     * @covers Walker_Nav_Menu::build_atts
+     *
+     * @dataProvider data_build_atts_should_build_attributes
+     *
+     * @param array  $atts     An array of HTML attribute key/value pairs.
+     * @param string $expected The expected built attributes.
+     */
+    public function test_build_atts_should_build_attributes( $atts, $expected ) {
+        $build_atts_reflection = new ReflectionMethod( $this->walker, 'build_atts' );
+
+        $build_atts_reflection->setAccessible( true );
+        $actual = $build_atts_reflection->invoke( $this->walker, $atts );
+        $build_atts_reflection->setAccessible( false );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[]
+     */
+    public function data_build_atts_should_build_attributes() {
+        return array(
+            'an empty attributes array'                   => array(
+                'atts'     => array(),
+                'expected' => '',
+            ),
+            'attributes containing a (bool) false value'  => array(
+                'atts'     => array( 'disabled' => false ),
+                'expected' => '',
+            ),
+            'attributes containing an empty string value' => array(
+                'atts'     => array( 'id' => '' ),
+                'expected' => '',
+            ),
+            'attributes containing a non-scalar value'    => array(
+                'atts'     => array( 'data-items' => new stdClass() ),
+                'expected' => '',
+            ),
+            'attributes containing a "href" -> should escape the URL' => array(
+                'atts'     => array( 'href' => 'https://example.org/A File With Spaces.pdf' ),
+                'expected' => ' href="https://example.org/A%20File%20With%20Spaces.pdf"',
+            ),
+            'attributes containing a non-"href" attribute -> should escape the value' => array(
+                'atts'     => array( 'id' => 'hello&goodbye' ),
+                'expected' => ' id="hello&goodbye"',
+            ),
+        );
+    }
 }