Changeset 36676

Timestamp:

02/24/2016 05:56:40 AM (4 years ago)

Author:

westonruter

Message:

Customize: Introduce customize_nav_menu_searched_items filter for modifying results of nav menu item searches.

This new filter can be used in conjunction with the customize_nav_menu_available_items and customize_nav_menu_available_item_types filters.

Props TimothyBlynJacobs, westonruter.
Fixes #34947.

Location:

trunk

Files:

• src/wp-includes/class-wp-customize-nav-menus.php (modified) (1 diff)
• tests/phpunit/tests/customize/nav-menus.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -334 +334 @@
             }
         }
+
+        /**
+         * Filter the available menu items during a search request.
+         *
+         * @since 4.5.0
+         *
+         * @param array $items The array of menu items.
+         * @param array $args  Includes 'pagenum' and 's' (search) arguments.
+         */
+        $items = apply_filters( 'customize_nav_menu_searched_items', $items, $args );
 
         return $items;

trunk/tests/phpunit/tests/customize/nav-menus.php

@@ -278 +278 @@
         $menus = new WP_Customize_Nav_Menus( $this->wp_customize );
 
-        // Create posts
+        // Create posts.
         $post_ids = array();
         $post_ids[] = self::factory()->post->create( array( 'post_title' => 'Search & Test' ) );
         $post_ids[] = self::factory()->post->create( array( 'post_title' => 'Some Other Title' ) );
 
-        // Create terms
+        // Create terms.
         $term_ids = array();
         $term_ids[] = self::factory()->category->create( array( 'name' => 'Dogs Are Cool' ) );
         $term_ids[] = self::factory()->category->create( array( 'name' => 'Cats Drool' ) );
 
-        // Test empty results
+        // Test empty results.
         $expected = array();
         $results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => 'This Does NOT Exist' ) );
         $this->assertEquals( $expected, $results );
 
-        // Test posts
+        // Test posts.
         foreach ( $post_ids as $post_id ) {
             $expected = array(
@@ -311 +311 @@
         }
 
-        // Test terms
+        // Test terms.
         foreach ( $term_ids as $term_id ) {
             $term = get_term_by( 'id', $term_id, 'category' );
@@ -327 +327 @@
             $this->assertEquals( $expected, $results[0] );
         }
+
+        // Test filtered results.
+        $results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => 'cat' ) );
+        $this->assertEquals( 1, count( $results ) );
+        $count = $this->filter_count_customize_nav_menu_searched_items;
+        add_filter( 'customize_nav_menu_searched_items', array( $this, 'filter_search' ), 10, 2 );
+        $results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => 'cat' ) );
+        $this->assertEquals( $count + 1, $this->filter_count_customize_nav_menu_searched_items );
+        $this->assertInternalType( 'array', $results );
+        $this->assertEquals( 2, count( $results ) );
+        remove_filter( 'customize_nav_menu_searched_items', array( $this, 'filter_search' ), 10 );
+    }
+
+    /**
+     * Count for number of times customize_nav_menu_searched_items filtered.
+     *
+     * @var int
+     */
+    protected $filter_count_customize_nav_menu_searched_items = 0;
+
+    /**
+     * Filter to search menu items.
+     *
+     * @param array $items Items.
+     * @param array $args {
+     *     Search args.
+     *
+     *     @type int    $pagenum Page number.
+     *     @type string $s       Search string.
+     * }
+     * @return array Items.
+     */
+    function filter_search( $items, $args ) {
+        $this->assertInternalType( 'array', $items );
+        $this->assertInternalType( 'array', $args );
+        $this->assertArrayHasKey( 's', $args );
+        $this->assertArrayHasKey( 'pagenum', $args );
+        $this->filter_count_customize_nav_menu_searched_items += 1;
+
+        if ( 'cat' === $args['s'] ) {
+            array_unshift( $items, array(
+                'id'         => 'home',
+                'title'      => 'COOL CAT!',
+                'type'       => 'custom',
+                'type_label' => __( 'Custom Link' ),
+                'object'     => '',
+                'url'        => home_url( '/cool-cat' ),
+            ) );
+        }
+        return $items;
     }