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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。