wp_tag_cloud

説明

mixed wp_tag_cloud( [ mixed $args = '' ] )
投稿ページのタグクラウドを$argsのecho値がtrue(format値が'array'以外)ならば表示する。echo値がtrue以外ならばタグ情報をformat値の形式で取得する。

パラメータ

  • $args
    表示条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。キーワードは次の通り。
    キーワード省略時の値意味
    smallest8最小の表示サイズ
    largest22最大の表示サイズ
    unit'pt'表示サイズの単位('pt'、'px'など)
    number45表示するタグの数
    format'flat'出力形式を指定('flat'、'array'、'list'など)
    orderby'name'タグのソート対象を指定('name'、'name'以外の場合は投稿件数が適用)
    order'ASC'タグのソート順を指定('ASC'(昇順)、'DESC'(降順)、'RAND'(ランダム)など)
    exclude''特定のタグを除外する場合に、それらのタグIDを指定
    include''タグを限定する場合に、それらのタグIDを指定
    link'view'リンク先を指定('view'、'edit')
    taxonomy'post_tag'タクソノミー種別を指定('post_tag')
    echotrue表示する場合は1、文字列として取得する場合は0
    show_count0[4.8.0]タグのついた投稿数を表示する場合は1またはtrue、表示しない場合は0またはfalse

返り値

パラメータ$argsにecho値がfalseかformat値が'array'の場合は、タグ情報を返す。それら以外の場合は何も返さない。

注意

format値が'array'の場合、echo値に関わらずタグ情報の配列が返る。

[4.8.0]パラメータにshow_countが追加され、1またはtrueの場合はタグ名の後にその投稿数を表示する。


使用例

  • 最小サイズが10ピクセル、最大サイズが20ピクセルのタグクラウドを表示する。
    <?php wp_tag_cloud('smallest=10&largest=20&unit=px'); ?>

フィルター

[2.3.0]表示または結果を返す前に'wp_tag_cloud'を呼び出す。パラメータ$returnには生成した表示内容が、$argsには本関数が受け取った内容に既定値補間した内容を追加したものがが格納されている。
$return = apply_filters( 'wp_tag_cloud', $return, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

最終更新 : 2018年05月27日 10:48



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。