636 | | * Display tag cloud. |
637 | | * |
638 | | * The text size is set by the 'smallest' and 'largest' arguments, which will |
639 | | * use the 'unit' argument value for the CSS text size unit. The 'format' |
640 | | * argument can be 'flat' (default), 'list', or 'array'. The flat value for the |
641 | | * 'format' argument will separate tags with spaces. The list value for the |
642 | | * 'format' argument will format the tags in a UL HTML list. The array value for |
643 | | * the 'format' argument will return in PHP array type format. |
644 | | * |
645 | | * The 'orderby' argument will accept 'name' or 'count' and defaults to 'name'. |
646 | | * The 'order' is the direction to sort, defaults to 'ASC' and can be 'DESC'. |
647 | | * |
648 | | * The 'number' argument is how many tags to return. By default, the limit will |
649 | | * be to return the top 45 tags in the tag cloud list. |
650 | | * |
651 | | * The 'topic_count_text' argument is a nooped plural from _n_noop() to generate the |
652 | | * text for the tag link count. |
653 | | * |
654 | | * The 'topic_count_text_callback' argument is a function, which given the count |
655 | | * of the posts with that tag returns a text for the tag link count. |
656 | | * |
657 | | * The 'post_type' argument is used only when 'link' is set to 'edit'. It determines the post_type |
658 | | * passed to edit.php for the popular tags edit links. |
659 | | * |
660 | | * The 'exclude' and 'include' arguments are used for the get_tags() function. Only one |
661 | | * should be used, because only one will be used and the other ignored, if they are both set. |
| 636 | * Displays a tag cloud. |
664 | | * @since 4.8.0 Added the `show_count` argument. |
665 | | * |
666 | | * @param array|string|null $args Optional. Override default arguments. |
| 639 | * @see wp_generate_tag_cloud() and get_terms() for the full lists of arguments which can be passed in $args. |
| 640 | * |
| 641 | * @param array|string $args { |
| 642 | * Optional. Array or string of arguments for displaying a tag cloud. |
| 643 | * |
| 644 | * @type int $number The number of tags to display. Accepts any positive integer |
| 645 | * or zero to return all. Default 0 (all tags). |
| 646 | * @type string $link Whether to display term editing links or term permalinks. |
| 647 | * Accepts 'edit' and 'view'. Default 'view'. |
| 648 | * @type string $post_type The post type. Used to highlight the proper post type menu |
| 649 | * on the linked edit page. Defaults to the first post type |
| 650 | * associated with the taxonomy. |
| 651 | * @type bool $echo Whether or not to echo the return value. Default true. |
| 652 | * } |