Changeset 33715

Timestamp:

08/23/2015 05:39:07 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Add better documentation for all accepted values for the fields argument in get_terms().

See #32246.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy.php

@@ -1628 +1628 @@
  *                                           positive number. Default ''|0 (all).
  *     @type int          $offset            The number by which to offset the terms query. Default empty.
- *     @type string       $fields            Term fields to query for. Accepts 'all' (returns an array of
- *                                           term objects), 'ids' or 'names' (returns an array of integers
- *                                           or strings, respectively. Default 'all'.
+ *     @type string       $fields            Term fields to query for. Accepts 'all' (returns an array of complete
+ *                                           term objects), 'ids' (returns an array of ids), 'id=>parent' (returns
+ *                                           an associative array with ids as keys, parent term IDs as values),
+ *                                           'names' (returns an array of term names), 'count' (returns the number
+ *                                           of matching terms), 'id=>name' (returns an associative array with ids
+ *                                           as keys, term names as values), or 'id=>slug' (returns an associative
+ *                                           array with ids as keys, term slugs as values). Default 'all'.
  *     @type string|array $name              Optional. Name or array of names to return term(s) for. Default empty.
  *     @type string|array $slug              Optional. Slug or array of slugs to return term(s) for. Default empty.