<!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>[36676] trunk: Customize: Introduce `customize_nav_menu_searched_items` filter for modifying results of nav menu item searches.</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 { 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="https://core.trac.wordpress.org/changeset/36676">36676</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/36676","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-02-24 05:56:40 +0000 (Wed, 24 Feb 2016)</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'>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 <a href="https://core.trac.wordpress.org/ticket/34947">#34947</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizenavmenusphp">trunk/src/wp-includes/class-wp-customize-nav-menus.php</a></li>
<li><a href="#trunktestsphpunittestscustomizenavmenusphp">trunk/tests/phpunit/tests/customize/nav-menus.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizenavmenusphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-nav-menus.php 2016-02-24 05:37:04 UTC (rev 36675)
+++ trunk/src/wp-includes/class-wp-customize-nav-menus.php 2016-02-24 05:56:40 UTC (rev 36676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -334,6 +334,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">+ /**
+ * 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $items;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizenavmenusphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/customize/nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/nav-menus.php 2016-02-24 05:37:04 UTC (rev 36675)
+++ trunk/tests/phpunit/tests/customize/nav-menus.php 2016-02-24 05:56:40 UTC (rev 36676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -277,22 +277,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_search_available_items_query() {
</span><span class="cx" style="display: block; padding: 0 10px"> $menus = new WP_Customize_Nav_Menus( $this->wp_customize );
</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 posts
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_ids = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $post_ids[] = self::factory()->post->create( array( 'post_title' => 'Search & Test' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $post_ids[] = self::factory()->post->create( array( 'post_title' => 'Some Other Title' ) );
</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 terms
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create terms.
</ins><span class="cx" style="display: block; padding: 0 10px"> $term_ids = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids[] = self::factory()->category->create( array( 'name' => 'Dogs Are Cool' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids[] = self::factory()->category->create( array( 'name' => 'Cats Drool' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Test empty results
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Test empty results.
</ins><span class="cx" style="display: block; padding: 0 10px"> $expected = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => 'This Does NOT Exist' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $results );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Test posts
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Test posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $post_ids as $post_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => 'post-' . $post_id,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -310,7 +310,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $results[0] );
</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">- // Test terms
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Test terms.
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $term_ids as $term_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term = get_term_by( 'id', $term_id, 'category' );
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -326,9 +326,59 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $results = $menus->search_available_items_query( array( 'pagenum' => 1, 's' => $s ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $results[0] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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">+ * 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test the enqueue method.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Customize_Nav_Menus::enqueue_scripts()
</span></span></pre>
</div>
</div>
</body>
</html>