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



お勧め

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。