sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Allow get_terms() to fetch terms regardless of taxonomy.

Browse Source 
`get_terms()` has historically required that a taxonomy be specified when
querying terms. This requirement is related to the fact that terms could
formerly be shared between taxonomies, making `$taxonomies` critical for
disambiguation. Since terms can no longer be shared as of 4.4, it'
s desirable to be able to query for terms regardless of what taxonomy they're in.

Because it's now optional to pass taxonomies, it's no longer necessary to have
`$taxonomies` as the first (and required) parameter for `get_terms()`. The new
function signature is `get_terms( $args )`, where 'taxonomy' can (optionally) be
passed as part of the `$args` array. This syntax is more consistent with
functions like `get_users()` and `get_posts()`.

We've maintained backward compatibility by always giving precedence to the old
argument format. If a second parameter is detected, or if it's detected that
the first parameter is a list of taxonomy names rather than an `$args` array,
`get_terms()` will parse the function arguments in the legacy fashion.

Props flixos90, swissspidy, DrewAPicture, boonebgorges.
Fixes #35495.

git-svn-id: https://develop.svn.wordpress.org/trunk@36614 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2016-02-22 22:16:37 +00:00
parent 572578b8f1
commit 408fb37f2b
2 changed files with 98 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
src/wp-includes/taxonomy.php
View File

@ -1072,20 +1072,37 @@ function get_term_to_edit( $id, $taxonomy ) {
* The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query
* along with the $args array.
*
* Prior to 4.5.0, the first parameter of `get_terms()` was a taxonomy or list of taxonomies:
*
* $terms = get_terms( 'post_tag', array(
* 'hide_empty' => false,
* ) );
*
* Since 4.5.0, taxonomies should be passed via the 'taxonomy' argument in the `$args` array:
*
* $terms = get_terms( array(
* 'taxonomy' => 'post_tag',
* 'hide_empty' => false,
* ) );
*
* @since 2.3.0
* @since 4.2.0 Introduced 'name' and 'childless' parameters.
* @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter.
* Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return
* a list of WP_Term objects.
* @since 4.5.0 Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
* @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
* Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
*
* @internal The `$deprecated` parameter is parsed for backward compatibility only.
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $wp_filter
*
* @param string|array $taxonomies Taxonomy name or list of Taxonomy names.
* @param array|string $args {
* Optional. Array or string of arguments to get terms.
*
* @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
* be limited.
* @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,
@ -1144,24 +1161,17 @@ function get_term_to_edit( $id, $taxonomy ) {
* @type string $meta_value Limit terms to those matching a specific metadata value. Usually used
* in conjunction with `$meta_key`.
* }
* @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
* parameter will be interpreted as `$args`, and the first function parameter will
* be parsed as a taxonomy or array of taxonomies.
* @return array|int|WP_Error List of WP_Term instances and their children. Will return WP_Error, if any of $taxonomies
* do not exist.
*/
function get_terms( $taxonomies, $args = '' ) {
function get_terms( $args = array(), $deprecated = '' ) {
global $wpdb;
$empty_array = array();
if ( ! is_array( $taxonomies ) ) {
$taxonomies = array( $taxonomies );
}
foreach ( $taxonomies as $taxonomy ) {
if ( ! taxonomy_exists($taxonomy) ) {
return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
}
}
$defaults = array(
'taxonomy' => null,
'orderby' => 'name',
'order' => 'ASC',
'hide_empty' => true,
@ -1187,6 +1197,35 @@ function get_terms( $taxonomies, $args = '' ) {
'meta_query' => ''
);
/*
* Legacy argument format ($taxonomy, $args) takes precedence.
*
* We detect legacy argument format by checking if
* (a) a second non-empty parameter is passed, or
* (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
*/
$key_intersect = array_intersect_key( $defaults, (array) $args );
$do_legacy_args = $deprecated || empty( $key_intersect );
$taxonomies = null;
if ( $do_legacy_args ) {
$taxonomies = (array) $args;
$args = $deprecated;
} elseif ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
$taxonomies = (array) $args['taxonomy'];
unset( $args['taxonomy'] );
}
$empty_array = array();
if ( $taxonomies ) {
foreach ( $taxonomies as $taxonomy ) {
if ( ! taxonomy_exists($taxonomy) ) {
return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
}
}
}
/**
* Filter the terms query default arguments.
*
@ -1204,9 +1243,11 @@ function get_terms( $taxonomies, $args = '' ) {
// Save queries by not crawling the tree in the case of multiple taxes or a flat tax.
$has_hierarchical_tax = false;
foreach ( $taxonomies as $_tax ) {
if ( is_taxonomy_hierarchical( $_tax ) ) {
$has_hierarchical_tax = true;
if ( $taxonomies ) {
foreach ( $taxonomies as $_tax ) {
if ( is_taxonomy_hierarchical( $_tax ) ) {
$has_hierarchical_tax = true;
}
}
}
@ -1311,7 +1352,9 @@ function get_terms( $taxonomies, $args = '' ) {
$where_conditions = array();
$where_conditions[] = "tt.taxonomy IN ('" . implode("', '", $taxonomies) . "')";
if ( $taxonomies ) {
$where_conditions[] = "tt.taxonomy IN ('" . implode("', '", $taxonomies) . "')";
}
$exclude = $args['exclude'];
$exclude_tree = $args['exclude_tree'];

37
tests/phpunit/tests/term/getTerms.php
View File

@ -11,6 +11,43 @@ class Tests_Term_getTerms extends WP_UnitTestCase {
wp_cache_delete( 'last_changed', 'terms' );
}
/**
* @ticket 35495
*/
public function test_should_accept_an_args_array_containing_taxonomy_for_first_parameter() {
register_taxonomy( 'wptests_tax', 'post' );
$term = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
$found = get_terms( array(
'taxonomy' => 'wptests_tax',
'hide_empty' => false,
'fields' => 'ids',
'update_term_meta_cache' => false,
) );
$this->assertEqualSets( array( $term ), $found );
}
/**
* @ticket 35495
*/
public function test_excluding_taxonomy_arg_should_return_terms_from_all_taxonomies() {
register_taxonomy( 'wptests_tax1', 'post' );
register_taxonomy( 'wptests_tax2', 'post' );
$t1 = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax1' ) );
$t2 = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax2' ) );
$found = get_terms( array(
'hide_empty' => false,
'fields' => 'ids',
'update_term_meta_cache' => false,
) );
// There may be other terms lying around, so don't do an exact match.
$this->assertContains( $t1, $found );
$this->assertContains( $t2, $found );
}
/**
* @ticket 23326
*/