云策 WordPress 开发者社区

钩子文档

wp_tag_cloud

查看官方原文 ↗
💡 云策文档标注

概述

wp_tag_cloud 过滤器用于修改标签云的最终输出HTML，允许开发者自定义显示内容。它接收标签云字符串或数组以及参数数组作为输入，返回过滤后的输出。

关键要点

  • 过滤器名称为 'wp_tag_cloud'，通过 apply_filters 调用，用于过滤标签云的输出内容。
  • 参数包括 $return（标签云字符串或数组）和 $args（参数数组），后者包含 smallest、largest、unit、number、format 等选项。
  • 此过滤器仅作用于生成后的HTML输出，不用于修改生成前的参数；参数修改应使用其他相关过滤器。

代码示例

add_filter( 'wp_tag_cloud', 'wpdocs_no_follow_tag_cloud_links' );
function wpdocs_no_follow_tag_cloud_links( $return ) {
    $return = str_replace('

注意事项

  • 过滤器自 WordPress 2.3.0 版本引入，主要用于输出阶段，确保在修改时不影响参数生成逻辑。
  • 参数 $args 中的 format 选项决定 $return 的类型（字符串或数组），需根据此调整处理方式。
📄 原文内容

Filters the tag cloud output.

Parameters

$returnstring|string[]
Tag cloud as a string or an array, depending on 'format' argument.
$argsarray
An array of tag cloud arguments. See wp_tag_cloud() for information on accepted arguments.

More Arguments from wp_tag_cloud( … $args )

Array or string of arguments for generating a tag cloud.

  • smallest int
    Smallest font size used to display tags. Paired with the value of $unit, to determine CSS text size unit. Default 8 (pt).
  • largest int
    Largest font size used to display tags. Paired with the value of $unit, to determine CSS text size unit. Default 22 (pt).
  • unit string
    CSS text size unit to use with the $smallest and $largest values. Accepts any valid CSS text size unit. Default 'pt'.
  • number int
    The number of tags to return. Accepts any positive integer or zero to return all.
    Default 0.
  • format string
    Format to display the tag cloud in. Accepts 'flat' (tags separated with spaces), 'list' (tags displayed in an unordered list), or 'array' (returns an array).
    Default 'flat'.
  • separator string
    HTML or text to separate the tags. Default “n” (newline).
  • orderby string
    Value to order tags by. Accepts 'name' or 'count'.
    Default 'name'. The ‘tag_cloud_sort’ filter can also affect how tags are sorted.
  • order string
    How to order the tags. Accepts 'ASC' (ascending), 'DESC' (descending), or 'RAND' (random). Default 'ASC'.
  • filter int|bool
    Whether to enable filtering of the final output via ‘wp_generate_tag_cloud’. Default 1.
  • topic_count_text array
    Nooped plural text from _n_noop() to supply to tag counts. Default null.
  • topic_count_text_callback callable
    Callback used to generate nooped plural text for tag counts based on the count. Default null.
  • topic_count_scale_callback callable
    Callback used to determine the tag count scaling value. Default default_topic_count_scale() .
  • show_count bool|int
    Whether to display the tag counts. Default 0. Accepts 0, 1, or their bool equivalents.

Source

$return = apply_filters( 'wp_tag_cloud', $return, $args );

View all references View on Trac View on GitHub

Used by Description
wp_tag_cloud()wp-includes/category-template.php

Displays a tag cloud.

Changelog

Version Description
2.3.0 Introduced.

User Contributed Notes

  2. Skip to note 4 content


    buddhabackpacker


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    This “filter” only returns the HTML after generated. There is no longer a filter for the args before generating.