• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/wp generate tag cloud

提供: WordPress Codex 日本語版
移動先: 案内検索

タグクラウドの HTML を文字列や配列で取得します。

使い方

<?php $cloud = wp_generate_tag_cloud( $tags, $args ); ?>

デフォルトの使い方

<?php $args = array(
	'smallest'  => 8,
	'largest'   => 22,
	'unit'      => 'pt',
	'number'    => 0,
	'format'    => 'flat',
	'separator' => "\n",
	'orderby'   => 'name',
	'order'     => 'ASC',
	'topic_count_text_callback'  => 'default_topic_count_text',
	'topic_count_scale_callback' => 'default_topic_count_scale',
	'filter'    => 1 ); ?>

デフォルトでは次のように表示します。各タグの文字サイズは、付けられた記事数に応じて smallestlargest の間で段階的に変化します。

  • smallest - 一番小さいタグを 8(pt) で表示(件数が少ないタグ)
  • largest - 一番大きいタグを 22(pt) で表示(件数が多いタグ)
  • unit - smallestlargest のフォントサイズの単位として 'pt' (ポイント) を使用。
  • number - すべてのタグを表示。
  • format - flat 形式でタグを表示。
  • separator - ホワイトスペース区切りでタグを表示。
  • orderby - タグ名順に表示
  • order - 昇順でソート(前項でタグ名を指定しているので「タグ名の昇順」となる)。
  • topic_count_text_callback - タグ数の表示形式を default_topic_count_text 関数で指定。
  • topic_count_scale_callback - タグの表示スケールを default_topic_count_scale 関数で指定。
  • filter - 最後に wp_generate_tag_cloud フィルタが実行されます。

パラメータ

$tags
配列) (必須) タグクラウドを作るためのタグ情報の配列。配列の要素はタグオブジェクトとし、id, link, name のプロパティを持つこと。配列のキーが id の場合は id プロパティは不要。
初期値: なし
smallest
整数) (オプション) 一番小さい(件数が少ない)タグの表示サイズを unit 単位で指定。
初期値: 8
largest
整数) (オプション) 一番大きい(件数が少ない)タグの表示サイズを unit 単位で指定。
初期値: 22
unit
文字列) (オプション) フォントサイズの単位を指定。CSS の font-size プロパティで指定可能な単位が使える。
初期値: pt
  • pt (ポイント)
  • px (ピクセル)
  • em (現在のフォントのサイズを1とした比率)
  • % (現在のフォントのサイズを100とした比率)
number
整数) (オプション) 表示するタグの個数。0 ならすべて表示する
初期値: 0
format
文字列) (オプション) タグクラウドの戻り値の形式を指定する。
初期値: flat
  • array (タグを <a></a> で囲んだ文字列の配列)
  • list (タグを <li><a></a></li> で囲み、<ul class='wp-tag-cloud'></ul> のリストにした文字列)
  • flat (タグを <a></a> で囲み separator で区切った文字列)
separator
文字列) (オプションformatflat である場合のタグリンクの区切り文字。
初期値: "\n"
orderby
文字列) (オプション) タグの並び順のキー。
初期値: name
  • name (タグの名前順)
  • その他 (タグの件数順)
order
文字列) (オプション) タグの並び順。
初期値: ASC
  • ASC (昇順)
  • DESC (降順)
  • RAND (ランダム。orderby の値は無効)
topic_count_text_callback
関数名) (オプション) タグリンクの title 属性に設定される「タグの件数」の文字列を返す関数。
初期値: default_topic_count_text
topic_count_scale_callback
関数名) (オプション) タグリンクのフォントサイズ算出の元になる「タグのサイズ」を 100% 単位で返す関数。
初期値: default_topic_count_scale
single_text
文字列) (オプション) タグが 1 件のときの表示フォーマット。PHP の sprintf で使うフォーマット指定子を含む。topic_count_text_callback が空文字のとき有効。
初期値: なし
multiple_text
文字列) (オプション) タグが 2 件以上のときの表示フォーマット。PHP の sprintf で使うフォーマット指定子を含む。topic_count_text_callback が空文字のとき有効。
初期値: なし
filter
真偽値) (オプション) タグクラウド作成後に 'wp_generate_tag_cloud' フィルタを実行するかどうかを指定。
初期値: 1
  • 1 (true)
  • 0 (false)

フック

  • apply_filters( 'tag_cloud_sort', $tags, $args );
タグクラウド作成前に実行されます。
  • apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
タグクラウド作成後に実行されます。

用例

情報募集中 クリエイティブな例を求めています。外部サイトへのリンクでも構いません。 該当部分を編集するか、このページのノートまたはフォーラム等で教えてください。


変更履歴

  • 2.3.0 : 新規テンプレートタグ

ソースファイル

wp_generate_tag_cloud()wp-includes/category-template.php にあります。


タグ: get_tag(), get_tag_link(), get_tags(), get_the_tag_list(), get_the_tags(), is_tag(), the_tags(), single_tag_title(), tag_description(), wp_generate_tag_cloud(), wp_tag_cloud()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_generate_tag_cloud最新版との差分