Changeset 38099

Timestamp:

07/19/2016 02:12:48 AM (8 years ago)

Author:

boonebgorges

Message:

Taxonomy: Improve back compat of values passed to 'terms_clauses' filter.

Prior to the introduction of WP_Term_Query, the 'orderby' clause
passed to the 'terms_clauses' filter was prefixed by ORDER BY. After
WP_Term_Query, this was not the case; ORDER BY was added after the
filter. As such, plugins filtering 'terms_clauses' and returning an
'orderby' clause beginning with ORDER BY resulted in invalid syntax
when WP_Term_Query prepended a second ORDER BY keyword to
the clause.

This changeset rearranges the way the 'orderby' clause is built so that
it will be passed to 'terms_clauses' in the previous format.

Fixes #37378.

Location:

trunk

Files:

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

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

@@ -385 +385 @@
 
         $orderby = $this->parse_orderby( $this->query_vars['orderby'] );
+        if ( $orderby ) {
+            $orderby = "ORDER BY $orderby";
+        }
+
         $order = $this->parse_order( $this->query_vars['order'] );
 
@@ -619 +623 @@
         $this->sql_clauses['select']  = "SELECT $distinct $fields";
         $this->sql_clauses['from']    = "FROM $wpdb->terms AS t $join";
-        $this->sql_clauses['orderby'] = $orderby ? "ORDER BY $orderby $order" : '';
+        $this->sql_clauses['orderby'] = $orderby ? "$orderby $order" : '';
         $this->sql_clauses['limits']  = $limits;
 

trunk/tests/phpunit/tests/term/query.php

@@ -86 +86 @@
         $this->assertSame( array( $terms[1], $terms[0], $terms[2] ), $found );
     }
+
+    /**
+     * @ticket 37378
+     */
+    public function test_order_by_keyword_should_not_be_duplicated_when_filtered() {
+        register_taxonomy( 'wptests_tax', 'post' );
+
+        add_filter( 'terms_clauses', array( $this, 'filter_terms_clauses' ) );
+        $q = new WP_Term_Query( array(
+            'taxonomy' => array( 'wptests_tax' ),
+            'orderby' => 'name',
+        ) );
+        remove_filter( 'terms_clauses', array( $this, 'filter_terms_clauses' ) );
+
+        $this->assertContains( 'ORDER BY tt.term_id', $q->request );
+        $this->assertNotContains( 'ORDER BY ORDER BY', $q->request );
+    }
+
+    public function filter_terms_clauses( $clauses ) {
+        $clauses['orderby'] = 'ORDER BY tt.term_id';
+        return $clauses;
+    }
 }