sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.


git-svn-id: https://develop.svn.wordpress.org/trunk@36676 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Weston Ruter 2016-02-24 05:56:40 +00:00
parent fa4cd9d5e0
commit 407a2bd076
2 changed files with 65 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/wp-includes/class-wp-customize-nav-menus.php
View File

@ -334,6 +334,16 @@ final class WP_Customize_Nav_Menus {
}
}
/**
* 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;
}

60
tests/phpunit/tests/customize/nav-menus.php
View File

@ -277,22 +277,22 @@ class Test_WP_Customize_Nav_Menus extends WP_UnitTestCase {
function test_search_available_items_query() {
$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(
'id' => 'post-' . $post_id,
@ -310,7 +310,7 @@ class Test_WP_Customize_Nav_Menus extends WP_UnitTestCase {
$this->assertEquals( $expected, $results[0] );
}
// Test terms
// Test terms.
foreach ( $term_ids as $term_id ) {
$term = get_term_by( 'id', $term_id, 'category' );
$expected = array(
@ -326,6 +326,56 @@ class Test_WP_Customize_Nav_Menus extends WP_UnitTestCase {
$results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => $s ) );
$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;
}
/**