WordPress.org

Make WordPress Core

Changeset 42658


Ignore:
Timestamp:
02/07/2018 03:21:25 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Document default arguments for wp_tag_cloud() in a hash notation, noting that full lists of additionally-supported arguments are already documented in get_terms() and wp_generate_tag_cloud().

Props birgire, johnbillion.
Fixes #42019.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/category-template.php

    r42417 r42658  
    653653
    654654/**
    655  * Display tag cloud.
    656  *
    657  * The text size is set by the 'smallest' and 'largest' arguments, which will
    658  * use the 'unit' argument value for the CSS text size unit. The 'format'
    659  * argument can be 'flat' (default), 'list', or 'array'. The flat value for the
    660  * 'format' argument will separate tags with spaces. The list value for the
    661  * 'format' argument will format the tags in a UL HTML list. The array value for
    662  * the 'format' argument will return in PHP array type format.
    663  *
    664  * The 'orderby' argument will accept 'name' or 'count' and defaults to 'name'.
    665  * The 'order' is the direction to sort, defaults to 'ASC' and can be 'DESC'.
    666  *
    667  * The 'number' argument is how many tags to return. By default, the limit will
    668  * be to return the top 45 tags in the tag cloud list.
    669  *
    670  * The 'topic_count_text' argument is a nooped plural from _n_noop() to generate the
    671  * text for the tag link count.
    672  *
    673  * The 'topic_count_text_callback' argument is a function, which given the count
    674  * of the posts with that tag returns a text for the tag link count.
    675  *
    676  * The 'post_type' argument is used only when 'link' is set to 'edit'. It determines the post_type
    677  * passed to edit.php for the popular tags edit links.
    678  *
    679  * The 'exclude' and 'include' arguments are used for the get_tags() function. Only one
    680  * should be used, because only one will be used and the other ignored, if they are both set.
     655 * Displays a tag cloud.
    681656 *
    682657 * @since 2.3.0
    683658 * @since 4.8.0 Added the `show_count` argument.
    684659 *
    685  * @param array|string|null $args Optional. Override default arguments.
     660 * @param array|string $args {
     661 *     Optional. Array or string of arguments for displaying a tag cloud. See wp_generate_tag_cloud()
     662 *     and get_terms() for the full lists of arguments that can be passed in `$args`.
     663 *
     664 *     @type int    $number    The number of tags to display. Accepts any positive integer
     665 *                             or zero to return all. Default 0 (all tags).
     666 *     @type string $link      Whether to display term editing links or term permalinks.
     667 *                             Accepts 'edit' and 'view'. Default 'view'.
     668 *     @type string $post_type The post type. Used to highlight the proper post type menu
     669 *                             on the linked edit page. Defaults to the first post type
     670 *                             associated with the taxonomy.
     671 *     @type bool   $echo      Whether or not to echo the return value. Default true.
     672 * }
    686673 * @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
    687674 *                    Otherwise, this function outputs the tag cloud.
     
    772759 * @since 4.8.0 Added the `show_count` argument.
    773760 *
    774  * @param array $tags List of tags.
     761 * @param array $tags Array of WP_Term objects to generate the tag cloud for.
    775762 * @param string|array $args {
    776  *     Optional. Array of string of arguments for generating a tag cloud.
     763 *     Optional. Array or string of arguments for generating a tag cloud.
    777764 *
    778765 *     @type int      $smallest                   Smallest font size used to display tags. Paired
Note: See TracChangeset for help on using the changeset viewer.