Supplement hook documentation for the `get_terms_fields` filter to more clearly explain the expected consequences of using it to modify the fields to select in a terms query.

Props boonebgorges.
Fixes #31174.

Built from https://develop.svn.wordpress.org/trunk@31855


git-svn-id: http://core.svn.wordpress.org/trunk@31834 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-03-20 20:11:26 +00:00
parent 88c109e919
commit cedee3dd1c
1 changed files with 7 additions and 3 deletions

View File

@ -1562,9 +1562,6 @@ function get_term_to_edit( $id, $taxonomy ) {
* The 'get_terms_orderby' filter passes the ORDER BY clause for the query * The 'get_terms_orderby' filter passes the ORDER BY clause for the query
* along with the $args array. * along with the $args array.
* *
* The 'get_terms_fields' filter passes the fields for the SELECT query
* along with the $args array.
*
* @since 2.3.0 * @since 2.3.0
* @since 4.2.0 Introduced 'name' and 'childless' parameters. * @since 4.2.0 Introduced 'name' and 'childless' parameters.
* *
@ -1933,6 +1930,13 @@ function get_terms( $taxonomies, $args = '' ) {
/** /**
* Filter the fields to select in the terms query. * Filter the fields to select in the terms query.
* *
* Field lists modified using this filter will only modify the term fields returned
* by the function when the `$fields` parameter set to 'count' or 'all'. In all other
* cases, the term fields in the results array will be determined by the `$fields`
* parameter alone.
*
* Use of this filter can result in unpredictable behavior, and is not recommended.
*
* @since 2.8.0 * @since 2.8.0
* *
* @param array $selects An array of fields to select for the terms query. * @param array $selects An array of fields to select for the terms query.