Make WordPress Core


Ignore:
Timestamp:
07/01/2021 09:11:48 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Descriptive improvements and corrections for various docblocks.

See #53399

File:
1 edited

Legend:

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

    r51299 r51300  
    9393     *     Optional. Array or query string of term query parameters. Default empty.
    9494     *
    95      *     @type string|array $taxonomy               Taxonomy name, or array of taxonomies, to which results should
     95     *     @type string|array $taxonomy               Taxonomy name, or array of taxonomy names, to which results should
    9696     *                                                be limited.
    97      *     @type int|int[]    $object_ids             Object ID, or array of object IDs. Results will be
     97     *     @type int|int[]    $object_ids             Optional. Object ID, or array of object IDs. Results will be
    9898     *                                                limited to terms associated with these objects.
    9999     *     @type string       $orderby                Field(s) to order terms by. Accepts:
    100      *                                                * Term fields ('name', 'slug', 'term_group', 'term_id', 'id',
     100     *                                                * term fields ('name', 'slug', 'term_group', 'term_id', 'id',
    101101     *                                                  'description', 'parent', 'term_order'). Unless `$object_ids`
    102102     *                                                  is not empty, 'term_order' is treated the same as 'term_id'.
    103103     *                                                * 'count' to use the number of objects associated with the term.
    104      *                                                * 'include' to match the 'order' of the `$include` param.
    105      *                                                * 'slug__in' to match the 'order' of the `$slug` param.
    106      *                                                * 'meta_value'
    107      *                                                * 'meta_value_num'.
    108      *                                                * The value of `$meta_key`.
    109      *                                                * The array keys of `$meta_query`.
     104     *                                                * 'include' to match the 'order' of the $include param.
     105     *                                                * 'slug__in' to match the 'order' of the $slug param.
     106     *                                                * 'meta_value', 'meta_value_num'.
     107     *                                                  the value of `$meta_key`.
     108     *                                                  the array keys of `$meta_query`.
    110109     *                                                * 'none' to omit the ORDER BY clause.
    111      *                                                Default 'name'.
     110     *                                                Defaults to 'name'.
    112111     *     @type string       $order                  Whether to order terms in ascending or descending order.
    113112     *                                                Accepts 'ASC' (ascending) or 'DESC' (descending).
     
    118117     *                                                Default empty array.
    119118     *     @type int[]|string $exclude                Array or comma/space-separated string of term IDs to exclude.
    120      *                                                If `$include` is non-empty, `$exclude` is ignored.
     119     *                                                If $include is non-empty, $exclude is ignored.
    121120     *                                                Default empty array.
    122121     *     @type int[]|string $exclude_tree           Array or comma/space-separated string of term IDs to exclude
    123      *                                                along with all of their descendant terms. If `$include` is
    124      *                                                non-empty, `$exclude_tree` is ignored. Default empty array.
     122     *                                                along with all of their descendant terms. If $include is
     123     *                                                non-empty, $exclude_tree is ignored. Default empty array.
    125124     *     @type int|string   $number                 Maximum number of terms to return. Accepts ''|0 (all) or any
    126125     *                                                positive number. Default ''|0 (all). Note that $number may
    127      *                                                not return accurate results when coupled with `$object_ids`.
     126     *                                                not return accurate results when coupled with $object_ids.
    128127     *                                                See #41796 for details.
    129128     *     @type int          $offset                 The number by which to offset the terms query. Default empty.
     
    147146     *     @type bool         $count                  Whether to return a term count. If true, will take precedence
    148147     *                                                over `$fields`. Default false.
    149      *     @type string|array $name                   Name or array of names to return term(s) for.
     148     *     @type string|array $name                   Optional. Name or array of names to return term(s) for.
    150149     *                                                Default empty.
    151      *     @type string|array $slug                   Slug or array of slugs to return term(s) for.
     150     *     @type string|array $slug                   Optional. Slug or array of slugs to return term(s) for.
    152151     *                                                Default empty.
    153      *     @type int|int[]    $term_taxonomy_id       Term taxonomy ID, or array of term taxonomy IDs,
     152     *     @type int|int[]    $term_taxonomy_id       Optional. Term taxonomy ID, or array of term taxonomy IDs,
    154153     *                                                to match when querying terms.
    155154     *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants
    156      *                                                (even if `$hide_empty` is set to true). Default true.
     155     *                                                (even if $hide_empty is set to true). Default true.
    157156     *     @type string       $search                 Search criteria to match terms. Will be SQL-formatted with
    158157     *                                                wildcards before and after. Default empty.
     
    165164     *                                                Default false.
    166165     *     @type string       $get                    Whether to return terms regardless of ancestry or whether the
    167      *                                                terms are empty. Accepts 'all' or '' (disabled).
    168      *                                                Default ''.
     166     *                                                terms are empty. Accepts 'all' or empty (disabled).
     167     *                                                Default empty.
    169168     *     @type int          $child_of               Term ID to retrieve child terms of. If multiple taxonomies
    170169     *                                                are passed, `$child_of` is ignored. Default 0.
     
    175174     *                                                Default false.
    176175     *     @type string       $cache_domain           Unique cache key to be produced when this query is stored in
    177      *                                                an object cache. Default 'core'.
     176     *                                                an object cache. Default is 'core'.
    178177     *     @type bool         $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
    179      *     @type array        $meta_query             Meta query clauses to limit retrieved terms by.
     178     *     @type array        $meta_query             Optional. Meta query clauses to limit retrieved terms by.
    180179     *                                                See `WP_Meta_Query`. Default empty.
    181180     *     @type string       $meta_key               Limit terms to those matching a specific metadata key.
Note: See TracChangeset for help on using the changeset viewer.