Changeset 38625

Timestamp:

09/20/2016 01:44:07 AM (8 years ago)

Author:

joemcgill

Message:

Media: Make media library searchable by filename.

This applies a new private function, _filter_query_attachment_filenames(),
to the post_clauses filter hook during wp_ajax_query_attachments() and
wp_edit_attachments_query_vars() to include _wp_attached_file post meta
in search queries performed from the media library or in a WP_Media_List_Table.

Props wonderboymusic, DrewAPicture, joemcgill, swissspidy.
Fixes #22744.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (1 diff)
• src/wp-admin/includes/post.php (modified) (1 diff)
• tests/phpunit/tests/query/search.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -2398 +2398 @@
         $query['post_status'] .= ',private';
 
+    // Filter query clauses to include filenames.
+    add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
     /**
      * Filters the arguments passed to WP_Query during an Ajax

trunk/src/wp-admin/includes/post.php

@@ -1145 +1145 @@
     }
 
+    // Filter query clauses to include filenames.
+    add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
     return $q;
+}
+
+/**
+ * Filter the SQL clauses of an attachment query to include filenames.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @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__ );
+
+    $clauses['join'] = " INNER JOIN {$wpdb->postmeta} ON ( {$wpdb->posts}.ID = {$wpdb->postmeta}.post_id )";
+    $clauses['groupby'] = "{$wpdb->posts}.ID";
+
+    $clauses['where'] = preg_replace(
+        "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
+        "$0 OR ( {$wpdb->postmeta}.meta_key = '_wp_attached_file' AND {$wpdb->postmeta}.meta_value $1 $2 )",
+        $clauses['where'] );
+
+    return $clauses;
 }
 

trunk/tests/phpunit/tests/query/search.php

@@ -281 +281 @@
     }
 
+    /**
+     * Unfiltered search queries for attachment post types should not inlcude
+     * filenames to ensure the postmeta JOINs don't happen on the front end.
+     *
+     * @ticket 22744
+     */
+    public function test_exclude_file_names_in_attachment_search_by_default() {
+        $attachment = self::factory()->post->create( array(
+            'post_type'    => 'attachment',
+            'post_status'  => 'publish',
+            'post_title'   => 'bar foo',
+            'post_content' => 'foo bar',
+            'post_excerpt' => 'This post has foo',
+        ) );
+
+        add_post_meta( $attachment, '_wp_attached_file', 'some-image2.png', true );
+
+        // Pass post_type an array value.
+        $q = new WP_Query( array(
+            's'           => 'image2',
+            'fields'      => 'ids',
+            'post_type'   => 'attachment',
+            'post_status' => 'inherit',
+        ) );
+
+        $this->assertNotEquals( array( $attachment ), $q->posts );
+    }
+
+    /**
+     * @ticket 22744
+     */
+    public function test_include_file_names_in_attachment_search_as_string() {
+        $attachment = self::factory()->post->create( array(
+            'post_type'    => 'attachment',
+            'post_status'  => 'publish',
+            'post_title'   => 'bar foo',
+            'post_content' => 'foo bar',
+            'post_excerpt' => 'This post has foo',
+        ) );
+
+        add_post_meta( $attachment, '_wp_attached_file', 'some-image1.png', true );
+        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
+        // Pass post_type a string value.
+        $q = new WP_Query( array(
+            's'           => 'image1',
+            'fields'      => 'ids',
+            'post_type'   => 'attachment',
+            'post_status' => 'inherit',
+        ) );
+
+        $this->assertSame( array( $attachment ), $q->posts );
+    }
+
+    /**
+     * @ticket 22744
+     */
+    public function test_include_file_names_in_attachment_search_as_array() {
+        $attachment = self::factory()->post->create( array(
+            'post_type'    => 'attachment',
+            'post_status'  => 'publish',
+            'post_title'   => 'bar foo',
+            'post_content' => 'foo bar',
+            'post_excerpt' => 'This post has foo',
+        ) );
+
+        add_post_meta( $attachment, '_wp_attached_file', 'some-image2.png', true );
+        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
+        // Pass post_type an array value.
+        $q = new WP_Query( array(
+            's'           => 'image2',
+            'fields'      => 'ids',
+            'post_type'   => array( 'attachment' ),
+            'post_status' => 'inherit',
+        ) );
+
+        $this->assertSame( array( $attachment ), $q->posts );
+    }
+
+    /**
+     * @ticket 22744
+     */
+    public function test_exclude_attachment_file_names_in_general_searches() {
+        $attachment = self::factory()->post->create( array(
+            'post_type'    => 'attachment',
+            'post_status'  => 'publish',
+            'post_title'   => 'bar foo',
+            'post_content' => 'foo bar',
+            'post_excerpt' => 'This post has foo',
+        ) );
+
+        add_post_meta( $attachment, '_wp_attached_file', 'some-image3.png', true );
+
+        $q = new WP_Query( array(
+            's'           => 'image3',
+            'fields'      => 'ids',
+            'post_type'   => array( 'post', 'page', 'attachment' ),
+            'post_status' => 'inherit',
+        ) );
+
+        $this->assertNotEquals( array( $attachment ), $q->posts );
+    }
+
     public function filter_posts_search( $sql ) {
         return $sql . ' /* posts_search */';