vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Allow get_terms() results to ordered by metadata.

Browse Source 
The `$orderby` parameter of `get_terms()` now accepts the following values,
related to term meta:

* 'meta_value'
* 'meta_value_num'
* the value of the `$meta_key` parameter
* any key from the `$meta_query` array

This brings order-by-meta support for terms in line with post, comment, and
user queries.

As a byproduct of these improvements, `$meta_key` and `$meta_value` parameters
have been introduced to `get_terms()`. They interact with `$meta_query` in the
same way as in `WP_Query` and other query classes.

Props jadpm, eherman24.
Fixes #34996.

git-svn-id: https://develop.svn.wordpress.org/trunk@36485 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges
2016-02-06 04:41:26 +00:00
parent 0673904ddf
commit eb8e2fb6ed
2 changed files with 382 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/phpunit/tests/term/getTerms.php
+331
View File
@@ -1233,6 +1233,337 @@ class Tests_Term_getTerms extends WP_UnitTestCase {
$this->assertEquals( array( $t1, $t2, $t3 ), $found );
}
/**
* @ticket 34996
*/
public function test_orderby_meta_value() {
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'zzz' );
add_term_meta( $terms[0], 'fee', 'ber' );
add_term_meta( $terms[1], 'foo', 'aaa' );
add_term_meta( $terms[1], 'fee', 'ber' );
add_term_meta( $terms[2], 'foo', 'jjj' );
add_term_meta( $terms[2], 'fee', 'ber' );
// Matches the first meta query clause.
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
}
/**
* @ticket 34996
*/
public function test_orderby_meta_value_num() {
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', '999' );
add_term_meta( $terms[0], 'fee', 'ber' );
add_term_meta( $terms[1], 'foo', '111' );
add_term_meta( $terms[1], 'fee', 'ber' );
add_term_meta( $terms[2], 'foo', '555' );
add_term_meta( $terms[2], 'fee', 'ber' );
// Matches the first meta query clause.
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'orderby' => 'meta_value_num',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
}
/**
* @ticket 34996
*/
public function test_orderby_meta_value_with_meta_key() {
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'bar' );
add_term_meta( $terms[0], 'fee', 'zzz' );
add_term_meta( $terms[0], 'faa', 'jjj' );
add_term_meta( $terms[1], 'foo', 'bar' );
add_term_meta( $terms[1], 'fee', 'aaa' );
add_term_meta( $terms[1], 'faa', 'aaa' );
add_term_meta( $terms[2], 'foo', 'bar' );
add_term_meta( $terms[2], 'fee', 'jjj' );
add_term_meta( $terms[2], 'faa', 'zzz' );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
),
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
// Matches the first meta query clause.
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
// Matches the meta query clause corresponding to the 'meta_key' param.
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'meta_key' => 'faa',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[0], $terms[2] ), $found );
}
/**
* @ticket 34996
*/
public function test_orderby_meta_value_num_with_meta_key() {
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'bar' );
add_term_meta( $terms[0], 'fee', '999' );
add_term_meta( $terms[0], 'faa', '555' );
add_term_meta( $terms[1], 'foo', 'bar' );
add_term_meta( $terms[1], 'fee', '111' );
add_term_meta( $terms[1], 'faa', '111' );
add_term_meta( $terms[2], 'foo', 'bar' );
add_term_meta( $terms[2], 'fee', '555' );
add_term_meta( $terms[2], 'faa', '999' );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
),
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'meta_key' => 'fee',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'foo',
'compare' => 'EXISTS',
),
array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'meta_key' => 'faa',
'orderby' => 'meta_value',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[0], $terms[2] ), $found );
}
/**
* @ticket 34996
*/
public function test_orderby_clause_key() {
register_taxonomy( 'wptests_tax', 'post' );
$terms = self::factory()->term->create_many( 3, array( 'taxonomy' => 'wptests_tax' ) );
add_term_meta( $terms[0], 'foo', 'zzz' );
add_term_meta( $terms[0], 'fee', 'jjj' );
add_term_meta( $terms[1], 'foo', 'aaa' );
add_term_meta( $terms[1], 'fee', 'aaa' );
add_term_meta( $terms[2], 'foo', 'jjj' );
add_term_meta( $terms[2], 'fee', 'zzz' );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
'fee_key' => array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'orderby' => 'foo_key',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[2], $terms[0] ), $found );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
'fee_key' => array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'orderby' => 'fee_key',
'order' => 'ASC',
'fields' => 'ids',
) );
$this->assertEqualSets( array( $terms[1], $terms[0], $terms[2] ), $found );
$expected = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
'fee_key' => array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'fields' => 'ids',
) );
$found = get_terms( 'wptests_tax', array(
'hide_empty' => false,
'meta_query' => array(
'relation' => 'AND',
'foo_key' => array(
'key' => 'foo',
'compare' => 'EXISTS',
),
'fee_key' => array(
'key' => 'fee',
'compare' => 'EXISTS',
),
),
'orderby' => 'faa_key',
'fields' => 'ids',
) );
$this->assertEqualSets( $expected, $found );
}
public function test_hierarchical_false_with_parent() {
$initial_terms = $this->create_hierarchical_terms();