Changeset 31532

Timestamp:

02/24/2015 04:36:26 PM (10 years ago)

Author:

boonebgorges

Message:

Add 'orderby=description' support to get_terms().

This fixes an interface inconsistency in edit-tags.php, where Description
appears as a sortable column header.

Props neil_pie.
Fixes #31364.

Location:

trunk

Files:

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

trunk/src/wp-includes/taxonomy.php

@@ -1575 +1575 @@
  *     Optional. Array or string of arguments to get terms.
  *
- *     @type string   $orderby               Field(s) to order terms by. Accepts term fields ('name', 'slug',
- *                                           'term_group', 'term_id', 'id'), 'count' for term taxonomy count,
- *                                           'include' to match the 'order' of the $include param, or 'none'
- *                                           to skip ORDER BY. Defaults to 'name'.
- *     @type string   $order                 Whether to order terms in ascending or descending order.
+ *     @type string       $orderby           Field(s) to order terms by. Accepts term fields ('name', 'slug',
+ *                                           'term_group', 'term_id', 'id', 'description'), 'count' for term
+ *                                           taxonomy count, 'include' to match the 'order' of the $include param,
+ *                                           or 'none' to skip ORDER BY. Defaults to 'name'.
+ *     @type string       $order             Whether to order terms in ascending or descending order.
  *                                           Accepts 'ASC' (ascending) or 'DESC' (descending).
  *                                           Default 'ASC'.
@@ -1748 +1748 @@
     } elseif ( 'term_group' == $_orderby ) {
         $orderby = 't.term_group';
+    } elseif ( 'description' == $_orderby ) {
+        $orderby = 'tt.description';
     } elseif ( 'none' == $_orderby ) {
         $orderby = '';

trunk/tests/phpunit/tests/term/getTerms.php

@@ -1136 +1136 @@
     }
 
+    /**
+     * @ticket 31364
+     */
+    public function test_orderby_description() {
+        $tax = 'wptests_tax';
+        register_taxonomy( $tax, 'post' );
+
+        $t1 = $this->factory->term->create( array( 'taxonomy' => $tax, 'description' => 'fff' ) );
+        $t2 = $this->factory->term->create( array( 'taxonomy' => $tax, 'description' => 'aaa' ) );
+        $t3 = $this->factory->term->create( array( 'taxonomy' => $tax, 'description' => 'zzz' ) );
+        $t4 = $this->factory->term->create( array( 'taxonomy' => $tax, 'description' => 'jjj' ) );
+
+        $found = get_terms( $tax, array(
+            'fields' => 'ids',
+            'orderby' => 'description',
+            'hide_empty' => false,
+        ) );
+
+        _unregister_taxonomy( 'wptests_tax' );
+
+        $this->assertEquals( array( $t2, $t1, $t4, $t3 ), $found );
+    }
+
     public function test_hierarchical_false_with_parent() {
         $initial_terms = $this->create_hierarchical_terms();