WordPress.org

Make WordPress Core

Changeset 46652


Ignore:
Timestamp:
11/04/2019 05:48:55 PM (2 years ago)
Author:
johnbillion
Message:

Docs: Correct and improve the readability of some parameters of WP_Term_Query.

See #48303

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-term-query.php

    r46586 r46652  
    122122     *                                                See #41796 for details.
    123123     *     @type int          $offset                 The number by which to offset the terms query. Default empty.
    124      *     @type string       $fields                 Term fields to query for. Accepts 'all' (returns an array of
    125      *                                                complete term objects), 'all_with_object_id' (returns an
    126      *                                                array of term objects with the 'object_id' param; works only
    127      *                                                when the `$object_ids` parameter is populated), 'ids'
    128      *                                                (returns an array of ids), 'tt_ids' (returns an array of
    129      *                                                term taxonomy ids), 'id=>parent' (returns an associative
    130      *                                                array with ids as keys, parent term IDs as values), 'names'
    131      *                                                (returns an array of term names), 'count' (returns the number
    132      *                                                of matching terms), 'id=>name' (returns an associative array
    133      *                                                with ids as keys, term names as values), or 'id=>slug'
    134      *                                                (returns an associative array with ids as keys, term slugs
    135      *                                                as values). Default 'all'.
    136      *     @type bool         $count                  Whether to return a term count (true) or array of term objects
    137      *                                                (false). Will take precedence over `$fields` if true.
     124     *     @type string       $fields                 Term fields to query for. Accepts:
     125     *                                                - 'all' Returns an array of complete term objects (`WP_Term[]`).
     126     *                                                - 'all_with_object_id' Returns an array of term objects with the 'object_id'
     127     *                                                  param (`WP_Term[]`). Works only when the `$object_ids` parameter is populated.
     128     *                                                - 'ids' Returns an array of term IDs (`int[]`).
     129     *                                                - 'tt_ids' Returns an array of term taxonomy IDs (`int[]`).
     130     *                                                - 'names' Returns an array of term names (`string[]`).
     131     *                                                - 'slugs' Returns an array of term slugs (`string[]`).
     132     *                                                - 'count' Returns the number of matching terms (`int`).
     133     *                                                - 'id=>parent' Returns an associative array of parent term IDs, keyed by term ID (`int[]`).
     134     *                                                - 'id=>name' Returns an associative array of term names, keyed by term ID (`string[]`).
     135     *                                                - 'id=>slug' Returns an associative array of term slugs, keyed by term ID (`string[]`).
     136     *                                                Default 'all'.
     137     *     @type bool         $count                  Whether to return a term count. Will take precedence over `$fields` if true.
    138138     *                                                Default false.
    139139     *     @type string|array $name                   Optional. Name or array of names to return term(s) for.
Note: See TracChangeset for help on using the changeset viewer.