WordPress.org

Make WordPress Core


Ignore:
Timestamp:
07/01/2021 09:09:04 PM (3 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous formatting corrections for docblocks.

See #53399

File:
1 edited

Legend:

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

    r51298 r51299  
    9595     *     @type string|array $taxonomy               Taxonomy name, or array of taxonomies, to which results should
    9696     *                                                be limited.
    97      *     @type int|int[]    $object_ids             Optional. Object ID, or array of object IDs. Results will be
     97     *     @type int|int[]    $object_ids             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', 'meta_value_num'.
    107      *                                                  the value of `$meta_key`.
    108      *                                                  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'
     107     *                                                * 'meta_value_num'.
     108     *                                                * The value of `$meta_key`.
     109     *                                                * The array keys of `$meta_query`.
    109110     *                                                * 'none' to omit the ORDER BY clause.
    110      *                                                Defaults to 'name'.
     111     *                                                Default 'name'.
    111112     *     @type string       $order                  Whether to order terms in ascending or descending order.
    112113     *                                                Accepts 'ASC' (ascending) or 'DESC' (descending).
     
    117118     *                                                Default empty array.
    118119     *     @type int[]|string $exclude                Array or comma/space-separated string of term IDs to exclude.
    119      *                                                If $include is non-empty, $exclude is ignored.
     120     *                                                If `$include` is non-empty, `$exclude` is ignored.
    120121     *                                                Default empty array.
    121122     *     @type int[]|string $exclude_tree           Array or comma/space-separated string of term IDs to exclude
    122      *                                                along with all of their descendant terms. If $include is
    123      *                                                non-empty, $exclude_tree is ignored. Default empty array.
     123     *                                                along with all of their descendant terms. If `$include` is
     124     *                                                non-empty, `$exclude_tree` is ignored. Default empty array.
    124125     *     @type int|string   $number                 Maximum number of terms to return. Accepts ''|0 (all) or any
    125126     *                                                positive number. Default ''|0 (all). Note that $number may
    126      *                                                not return accurate results when coupled with $object_ids.
     127     *                                                not return accurate results when coupled with `$object_ids`.
    127128     *                                                See #41796 for details.
    128129     *     @type int          $offset                 The number by which to offset the terms query. Default empty.
     
    146147     *     @type bool         $count                  Whether to return a term count. If true, will take precedence
    147148     *                                                over `$fields`. Default false.
    148      *     @type string|array $name                   Optional. Name or array of names to return term(s) for.
     149     *     @type string|array $name                   Name or array of names to return term(s) for.
    149150     *                                                Default empty.
    150      *     @type string|array $slug                   Optional. Slug or array of slugs to return term(s) for.
     151     *     @type string|array $slug                   Slug or array of slugs to return term(s) for.
    151152     *                                                Default empty.
    152      *     @type int|int[]    $term_taxonomy_id       Optional. Term taxonomy ID, or array of term taxonomy IDs,
     153     *     @type int|int[]    $term_taxonomy_id       Term taxonomy ID, or array of term taxonomy IDs,
    153154     *                                                to match when querying terms.
    154155     *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants
    155      *                                                (even if $hide_empty is set to true). Default true.
     156     *                                                (even if `$hide_empty` is set to true). Default true.
    156157     *     @type string       $search                 Search criteria to match terms. Will be SQL-formatted with
    157158     *                                                wildcards before and after. Default empty.
     
    164165     *                                                Default false.
    165166     *     @type string       $get                    Whether to return terms regardless of ancestry or whether the
    166      *                                                terms are empty. Accepts 'all' or empty (disabled).
    167      *                                                Default empty.
     167     *                                                terms are empty. Accepts 'all' or '' (disabled).
     168     *                                                Default ''.
    168169     *     @type int          $child_of               Term ID to retrieve child terms of. If multiple taxonomies
    169170     *                                                are passed, `$child_of` is ignored. Default 0.
     
    174175     *                                                Default false.
    175176     *     @type string       $cache_domain           Unique cache key to be produced when this query is stored in
    176      *                                                an object cache. Default is 'core'.
     177     *                                                an object cache. Default 'core'.
    177178     *     @type bool         $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
    178      *     @type array        $meta_query             Optional. Meta query clauses to limit retrieved terms by.
     179     *     @type array        $meta_query             Meta query clauses to limit retrieved terms by.
    179180     *                                                See `WP_Meta_Query`. Default empty.
    180181     *     @type string       $meta_key               Limit terms to those matching a specific metadata key.
Note: See TracChangeset for help on using the changeset viewer.