<!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>[39629] branches/4.7: REST API: Add support for filename search in media endpoint.</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/39629">39629</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/39629","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-12-21 05:18:24 +0000 (Wed, 21 Dec 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'>REST API: Add support for filename search in media endpoint.
In <a href="https://core.trac.wordpress.org/changeset/38625">[38625]</a>, the functionality to search for attachments by filename was added via the `posts_clauses` filter and the `_filter_query_attachment_filenames()` function. This moves `_filter_query_attachment_filenames()` from `wp-admin/includes/post.php` to `wp-includes/post.php` so that it can be applied in the same manner in the REST API media endpoint.
Merge of <a href="https://core.trac.wordpress.org/changeset/39598">[39598]</a> to the 4.7 branch.
Props jblz, tyxla.
Fixes <a href="https://core.trac.wordpress.org/ticket/39092">#39092</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches47srcwpadminincludespostphp">branches/4.7/src/wp-admin/includes/post.php</a></li>
<li><a href="#branches47srcwpincludespostphp">branches/4.7/src/wp-includes/post.php</a></li>
<li><a href="#branches47srcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#branches47testsphpunittestsrestapirestattachmentscontrollerphp">branches/4.7/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches47">branches/4.7/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.7
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.7 2016-12-21 05:12:06 UTC (rev 39628)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.7 2016-12-21 05:18:24 UTC (rev 39629)
</ins><a id="branches47"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.7</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,39365,39367,39369,39371,39373,39375-39376,39378,39380,39382,39384,39386,39388,39390,39392-39393,39396-39397,39400,39402,39404,39406,39409,39411,39413,39415,39417-39420,39424,39426,39428,39430,39432-39434,39436,39438,39440,39442-39444,39447,39449-39451,39453,39455-39457,39460,39462,39464,39466,39468,39470-39471,39475,39477-39478,39482-39483,39487-39488,39490,39495-39496,39499,39502,39504,39506,39508,39510,39512,39514,39517,39520,39522,39545-39547,39557-39562,39565,39578,39580-39581,39584,39586,39594-39595,39597,39599,39601,39603,39613,39626
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,39365,39367,39369,39371,39373,39375-39376,39378,39380,39382,39384,39386,39388,39390,39392-39393,39396-39397,39400,39402,39404,39406,39409,39411,39413,39415,39417-39420,39424,39426,39428,39430,39432-39434,39436,39438,39440,39442-39444,39447,39449-39451,39453,39455-39457,39460,39462,39464,39466,39468,39470-39471,39475,39477-39478,39482-39483,39487-39488,39490,39495-39496,39499,39502,39504,39506,39508,39510,39512,39514,39517,39520,39522,39545-39547,39557-39562,39565,39578,39580-39581,39584,39586,39594-39595,39597-39599,39601,39603,39613,39626
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches47srcwpadminincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/src/wp-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/src/wp-admin/includes/post.php 2016-12-21 05:12:06 UTC (rev 39628)
+++ branches/4.7/src/wp-admin/includes/post.php 2016-12-21 05:18:24 UTC (rev 39629)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1155,35 +1155,6 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the SQL clauses of an attachment query to include filenames.
- *
- * @since 4.7.0
- * @access private
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
- * DISTINCT, fields (SELECT), and LIMITS clauses.
- * @return array The modified clauses.
- */
-function _filter_query_attachment_filenames( $clauses ) {
- global $wpdb;
- remove_filter( 'posts_clauses', __FUNCTION__ );
-
- // Add a LEFT JOIN of the postmeta table so we don't trample existing JOINs.
- $clauses['join'] .= " LEFT JOIN {$wpdb->postmeta} AS sq1 ON ( {$wpdb->posts}.ID = sq1.post_id AND sq1.meta_key = '_wp_attached_file' )";
-
- $clauses['groupby'] = "{$wpdb->posts}.ID";
-
- $clauses['where'] = preg_replace(
- "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
- "$0 OR ( sq1.meta_value $1 $2 )",
- $clauses['where'] );
-
- return $clauses;
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Executes a query for attachments. An array of WP_Query arguments
</span><span class="cx" style="display: block; padding: 0 10px"> * can be passed in, which will override the arguments set by this function.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="branches47srcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/src/wp-includes/post.php 2016-12-21 05:12:06 UTC (rev 39628)
+++ branches/4.7/src/wp-includes/post.php 2016-12-21 05:18:24 UTC (rev 39629)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6188,3 +6188,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> clean_post_cache( $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px"> return $post_name;
</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 SQL clauses of an attachment query to include filenames.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
+ * DISTINCT, fields (SELECT), and LIMITS clauses.
+ * @return array The modified clauses.
+ */
+function _filter_query_attachment_filenames( $clauses ) {
+ global $wpdb;
+ remove_filter( 'posts_clauses', __FUNCTION__ );
+
+ // Add a LEFT JOIN of the postmeta table so we don't trample existing JOINs.
+ $clauses['join'] .= " LEFT JOIN {$wpdb->postmeta} AS sq1 ON ( {$wpdb->posts}.ID = sq1.post_id AND sq1.meta_key = '_wp_attached_file' )";
+
+ $clauses['groupby'] = "{$wpdb->posts}.ID";
+
+ $clauses['where'] = preg_replace(
+ "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
+ "$0 OR ( sq1.meta_value $1 $2 )",
+ $clauses['where'] );
+
+ return $clauses;
+}
</ins></span></pre></div>
<a id="branches47srcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2016-12-21 05:12:06 UTC (rev 39628)
+++ branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2016-12-21 05:18:24 UTC (rev 39629)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,6 +47,11 @@
</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 query clauses to include filenames.
+ if ( isset( $query_args['s'] ) ) {
+ add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $query_args;
</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="branches47testsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.7/tests/phpunit/tests/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.7/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2016-12-21 05:12:06 UTC (rev 39628)
+++ branches/4.7/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2016-12-21 05:18:24 UTC (rev 39629)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1156,6 +1156,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rest_additional_fields = array();
</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">+ public function test_search_item_by_filename() {
+ $id = $this->factory->attachment->create_object( $this->test_file, 0, array(
+ 'post_mime_type' => 'image/jpeg',
+ ) );
+ $id2 = $this->factory->attachment->create_object( $this->test_file2, 0, array(
+ 'post_mime_type' => 'image/png',
+ ) );
+
+ $filename = basename( $this->test_file2 );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/media' );
+ $request->set_param( 'search', $filename );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertCount( 1, $data );
+ $this->assertEquals( $id2, $data[0]['id'] );
+ $this->assertEquals( 'image/png', $data[0]['mime_type'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function additional_field_get_callback( $object, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return 123;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>