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



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない(2011年9月27日 更新)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。