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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。