Changeset 44452

Timestamp:

01/08/2019 03:32:04 AM (6 years ago)

Author:

boonebgorges

Message:

Query: Standardize treatment of 'orderby' values post__in, post_parent__in, and post_name__in.

Ordering by post__in was introduced in [21776], but the code assumed that
post__in would be a comma-separated string listing post IDs. When an array
of post IDs was passed to the post__in query var, 'orderby=postin' was
not respected. This changeset changes this behavior by handling
'orderby=postin' in the same way as most other values of 'orderby',
which ensures that arrays as well as strings can be properly parsed.

The same treatment is given to the similar post_name__in and
post_parent__in options of 'orderby', so that most query generation for
orderby clauses happens in the same place, instead of in special cases.

A slight change in the resulting SQL (related to the whitespace around
parentheses and commas) necessitates a change to an existing REST API test
that does a string comparison against the SQL query.

Props mgibbs189, kelvink.
Fixes #38034.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (5 diffs)
• tests/phpunit/tests/post/query.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-query.php

@@ -1547 +1547 @@
             'comment_count',
             'rand',
+            'post__in',
+            'post_parent__in',
+            'post_name__in',
         );
 
@@ -1576 +1579 @@
             return false;
         }
+
+        $orderby_clause = '';
 
         switch ( $orderby ) {
@@ -1604 +1609 @@
                 $orderby_clause = "{$primary_meta_query['alias']}.meta_value+0";
                 break;
+            case 'post__in':
+                if ( ! empty( $this->query_vars['post__in'] ) ) {
+                    $orderby_clause = "FIELD({$wpdb->posts}.ID," . implode( ',', array_map( 'absint', $this->query_vars['post__in'] ) ) . ')';
+                }
+                break;
+            case 'post_parent__in':
+                if ( ! empty( $this->query_vars['post_parent__in'] ) ) {
+                    $orderby_clause = "FIELD( {$wpdb->posts}.post_parent," . implode( ', ', array_map( 'absint', $this->query_vars['post_parent__in'] ) ) . ' )';
+                }
+                break;
+            case 'post_name__in':
+                if ( ! empty( $this->query_vars['post_name__in'] ) ) {
+                    $post_name__in = array_map( 'sanitize_title_for_query', $this->query_vars['post_name__in'] );
+                    $post_name__in_string = "'" . implode( "','", $post_name__in ) . "'";
+                    $orderby_clause = "FIELD( {$wpdb->posts}.post_name," . $post_name__in_string . ' )';
+                }
+                break;
             default:
                 if ( array_key_exists( $orderby, $meta_clauses ) ) {
@@ -2240 +2262 @@
         }
 
+        // These values of orderby should ignore the 'order' parameter.
+        $force_asc = array( 'post__in', 'post_name__in', 'post_parent__in' );
+        if ( isset( $q['orderby'] ) && in_array( $q['orderby'], $force_asc, true ) ) {
+            $q['order'] = '';
+        }
+
         // Order by.
         if ( empty( $q['orderby'] ) ) {
@@ -2253 +2281 @@
         } elseif ( 'none' == $q['orderby'] ) {
             $orderby = '';
-        } elseif ( $q['orderby'] == 'post__in' && ! empty( $post__in ) ) {
-            $orderby = "FIELD( {$wpdb->posts}.ID, $post__in )";
-        } elseif ( $q['orderby'] == 'post_parent__in' && ! empty( $post_parent__in ) ) {
-            $orderby = "FIELD( {$wpdb->posts}.post_parent, $post_parent__in )";
-        } elseif ( $q['orderby'] == 'post_name__in' && ! empty( $post_name__in ) ) {
-            $orderby = "FIELD( {$wpdb->posts}.post_name, $post_name__in )";
         } else {
             $orderby_array = array();

trunk/tests/phpunit/tests/post/query.php

@@ -172 +172 @@
             )
         );
+        $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
+    }
+
+    /**
+     * @ticket 38034
+     */
+    public function test_orderby_post__in_array() {
+        $posts = self::factory()->post->create_many( 4 );
+
+        $ordered = array( $posts[2], $posts[0], $posts[3] );
+
+        $q = new WP_Query( array(
+            'post_type' => 'any',
+            'post__in' => $ordered,
+            'orderby' => array( 'post__in' => 'ASC' ),
+        ) );
+        $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
+    }
+
+    /**
+     * @ticket 38034
+     */
+    public function test_orderby_post__in_array_with_implied_order() {
+        $posts = self::factory()->post->create_many( 4 );
+
+        $ordered = array( $posts[2], $posts[0], $posts[3] );
+
+        $q = new WP_Query( array(
+            'post_type' => 'any',
+            'post__in' => $ordered,
+            'orderby' => 'post__in',
+        ) );
         $this->assertSame( $ordered, wp_list_pluck( $q->posts, 'ID' ) );
     }

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -292 +292 @@
         $this->assertEquals( 2, count( $data ) );
         $this->assertEquals( $id1, $data[0]['id'] );
-        $this->assertPostsOrderedBy( "FIELD( {posts}.ID, $id1,$id3 )" );
+        $this->assertPostsOrderedBy( "FIELD({posts}.ID,$id1,$id3)" );
         // Invalid include should error
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );