Changeset 39629

Timestamp:

12/21/2016 05:18:24 AM (10 years ago)

Author:

pento

Message:

REST API: Add support for filename search in media endpoint.

In [38625], 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 [39598] to the 4.7 branch.

Props jblz, tyxla.
Fixes #39092.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/post.php (modified) (1 diff)
• src/wp-includes/post.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (1 diff)

branches/4.7/src/wp-admin/includes/post.php

@@ -1153 +1153 @@
 
         return $q;
-}
-
-/**
- * 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;
 }
 

branches/4.7/src/wp-includes/post.php

@@ -6189 +6189 @@
         return $post_name;
 }
+
+/**
+ * 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;
+}

branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -46 +46 @@
                                 $query_args['post_mime_type'] = $request['mime_type'];
                         }
+                }
+
+                // Filter query clauses to include filenames.
+                if ( isset( $query_args['s'] ) ) {
+                        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
                 }
 

branches/4.7/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -1157 +1157 @@
         }
 
+        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'] );
+        }
+
         public function additional_field_get_callback( $object, $request ) {
                 return 123;