Changeset 31855

Timestamp:

03/20/2015 08:10:22 PM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -1561 +1561 @@
  *
  * The 'get_terms_orderby' filter passes the ORDER BY clause for the query
- * along with the $args array.
- *
- * The 'get_terms_fields' filter passes the fields for the SELECT query
  * along with the $args array.
  *
@@ -1934 +1931 @@
      * 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
      *