Changeset 30004

Timestamp:

10/24/2014 02:50:24 AM (10 years ago)

Author:

boonebgorges

Message:

Allow ORDER BY in WP_Comment_Query::query() to be disabled.

Disable ORDER BY by passing boolean false, an empty array, or the string
'none' to the 'orderby parameter. This mirrors the behavior of WP_Query.

Props psycleuk.
Fixes #29902.

Location:

trunk

Files:

• src/wp-includes/comment.php (modified) (2 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -388 +388 @@
         $order = ( 'ASC' == strtoupper( $this->query_vars['order'] ) ) ? 'ASC' : 'DESC';
 
-        if ( ! empty( $this->query_vars['orderby'] ) ) {
+        // Disable ORDER BY with 'none', an empty array, or boolean false.
+        if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) {
+            $orderby = '';
+        } else if ( ! empty( $this->query_vars['orderby'] ) ) {
             $ordersby = is_array( $this->query_vars['orderby'] ) ?
                 $this->query_vars['orderby'] :
@@ -589 +592 @@
         }
 
-        $this->request = "SELECT $fields FROM $wpdb->comments $join WHERE $where $groupby $orderby $order $limits";
+        if ( $orderby ) {
+            $orderby = "ORDER BY $orderby $order";
+        }
+
+        $this->request = "SELECT $fields FROM $wpdb->comments $join WHERE $where $groupby $orderby $limits";
 
         if ( $this->query_vars['count'] ) {

trunk/tests/phpunit/tests/comment/query.php

@@ -578 +578 @@
         $this->assertContains( 'ORDER BY comment_date_gmt', $q->request );
     }
+
+    /**
+     * @ticket 29902
+     */
+    public function test_orderby_none() {
+        $q = new WP_Comment_Query();
+        $q->query( array(
+            'orderby' => 'none',
+        ) );
+
+        $this->assertNotContains( 'ORDER BY', $q->request );
+    }
+
+    /**
+     * @ticket 29902
+     */
+    public function test_orderby_empty_array() {
+        $q = new WP_Comment_Query();
+        $q->query( array(
+            'orderby' => array(),
+        ) );
+
+        $this->assertNotContains( 'ORDER BY', $q->request );
+    }
+
+    /**
+     * @ticket 29902
+     */
+    public function test_orderby_false() {
+        $q = new WP_Comment_Query();
+        $q->query( array(
+            'orderby' => false,
+        ) );
+
+        $this->assertNotContains( 'ORDER BY', $q->request );
+    }
 }