<!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>[41346] trunk: Editor: In `_WP_Editors::wp_link_query`, allow filtering empty results.</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/41346">41346</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/41346","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-09-08 14:02:43 +0000 (Fri, 08 Sep 2017)</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'>Editor: In `_WP_Editors::wp_link_query`, allow filtering empty results.

Previously, it was not possible to hook into the `wp_link_query` filter to add custom entries when the 
query returned no posts.

Props mitraval192, msebel.
Fixes <a href="https://core.trac.wordpress.org/ticket/41825">#41825</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpeditorphp">trunk/src/wp-includes/class-wp-editor.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/tests/editor/</li>
<li><a href="#trunktestsphpunittestseditorwpEditorsphp">trunk/tests/phpunit/tests/editor/wpEditors.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpeditorphp"></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-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-editor.php 2017-09-08 12:30:03 UTC (rev 41345)
+++ trunk/src/wp-includes/class-wp-editor.php   2017-09-08 14:02:43 UTC (rev 41346)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1623,9 +1623,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">                // Do main query.
</span><span class="cx" style="display: block; padding: 0 10px">                $get_posts = new WP_Query;
</span><span class="cx" style="display: block; padding: 0 10px">                $posts = $get_posts->query( $query );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                // Check if any posts were found.
-               if ( ! $get_posts->post_count )
-                       return false;
</del><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // Build results.
</span><span class="cx" style="display: block; padding: 0 10px">                $results = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1665,7 +1662,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">                 * }
</span><span class="cx" style="display: block; padding: 0 10px">                 * @param array $query  An array of WP_Query arguments.
</span><span class="cx" style="display: block; padding: 0 10px">                 */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                return apply_filters( 'wp_link_query', $results, $query );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $results = apply_filters( 'wp_link_query', $results, $query );
+
+               return ! empty( $results ) ? $results : false;
</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></span></pre></div>
<a id="trunktestsphpunittestseditorwpEditorsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/editor/wpEditors.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/editor/wpEditors.php                            (rev 0)
+++ trunk/tests/phpunit/tests/editor/wpEditors.php      2017-09-08 14:02:43 UTC (rev 41346)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,82 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+if ( ! class_exists( '_WP_Editors', false ) ) {
+       require_once ABSPATH . WPINC . '/class-wp-editor.php';
+}
+
+/**
+ * @group editor
+ */
+class Tests_WP_Editors extends WP_UnitTestCase {
+       public function wp_link_query_callback( $results ) {
+               return array_merge( $results, array(
+                       array(
+                               'ID'        => 123,
+                               'title'     => 'foo',
+                               'permalink' => 'bar',
+                               'info'      => 'baz',
+                       ),
+               ) );
+       }
+
+       public function test_wp_link_query_returns_false_when_nothing_found() {
+               $actual = _WP_Editors::wp_link_query( array( 's' => 'foobarbaz' ) );
+
+               $this->assertFalse( $actual );
+       }
+
+       public function test_wp_link_query_returns_search_results() {
+               $post   = self::factory()->post->create_and_get( array( 'post_status' => 'publish' ) );
+               $actual = _WP_Editors::wp_link_query( array( 's' => $post->post_title ) );
+
+               $this->assertEqualSets( array(
+                       array(
+                               'ID'        => $post->ID,
+                               'title'     => $post->post_title,
+                               'permalink' => get_permalink( $post->ID ),
+                               'info'      => mysql2date( __( 'Y/m/d' ), $post->post_date ),
+                       ),
+               ), $actual );
+       }
+
+       /**
+        * @ticket 41825
+        */
+       public function test_wp_link_query_returns_filtered_result_when_nothing_found() {
+               add_filter( 'wp_link_query', array( $this, 'wp_link_query_callback' ) );
+               $actual = _WP_Editors::wp_link_query( array( 's' => 'foobarbaz' ) );
+               remove_filter( 'wp_link_query', array( $this, 'wp_link_query_callback' ) );
+
+               $this->assertEqualSets( array(
+                       array(
+                               'ID'        => 123,
+                               'title'     => 'foo',
+                               'permalink' => 'bar',
+                               'info'      => 'baz',
+                       ),
+               ), $actual );
+       }
+
+       public function test_wp_link_query_returns_filtered_search_results() {
+               $post = self::factory()->post->create_and_get( array( 'post_status' => 'publish' ) );
+
+               add_filter( 'wp_link_query', array( $this, 'wp_link_query_callback' ) );
+               $actual = _WP_Editors::wp_link_query( array( 's' => $post->post_title ) );
+               remove_filter( 'wp_link_query', array( $this, 'wp_link_query_callback' ) );
+
+               $this->assertEqualSets( array(
+                       array(
+                               'ID'        => $post->ID,
+                               'title'     => $post->post_title,
+                               'permalink' => get_permalink( $post->ID ),
+                               'info'      => mysql2date( __( 'Y/m/d' ), $post->post_date ),
+                       ),
+                       array(
+                               'ID'        => 123,
+                               'title'     => 'foo',
+                               'permalink' => 'bar',
+                               'info'      => 'baz',
+                       ),
+               ), $actual );
+       }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/editor/wpEditors.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>

</body>
</html>