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

説明

タグクラウドの 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 ); ?>

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

• smallest - 一番小さいタグを 8(pt) で表示（件数が少ないタグ）
• largest - 一番大きいタグを 22(pt) で表示（件数が多いタグ）
• unit - 最少・最多値のフォントサイズの単位として 'pt' (ポイント) を使用。
• number - 最大 0 タグを表示
• 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

（tagオブジェクトの配列） （必須） タグクラウドを作るためのタグ情報の配列。id, link, name のプロパティを持つこと。配列のキーが id の場合は id プロパティは不要。

初期値： なし

smallest

（整数） （オプション） 一番小さい（件数が少ない）タグの表示サイズを unit 単位で指定。

初期値： 8

largest

（整数） （オプション） 一番大きい（件数が少ない）タグの表示サイズを unit 単位で指定。

初期値： 22

largest

（文字列） （オプション） フォントサイズの単位を指定。CSS の font-size プロパティで指定可能な単位が使える。

• pt （ポイント）
• px （ピクセル）
• em （現在のフォントのサイズを1とした比率）
• % （現在のフォントのサイズを100とした比率）

初期値： pt

number

（整数） （オプション） 表示するタグの個数。0 ならすべて表示する

初期値： 0

format

（文字列） （flat） オプション

初期値： なし

separator

（文字列） （オプション） format が flat のときのタグリンクの区切り文字。

初期値： \n

orderby

（文字列） （オプション） タグの並び順のキー。

• name (タグの名前順)
• その他 (タグの件数順)

初期値： name

order

（文字列） （オプション） タグの並び順。

• ASC (昇順)
• DESC (降順)
• RAND (ランダム。orderby の値は無効)

初期値： ASC

topic_count_text_callback

（関数名） （オプション） タグリンクの title 属性に設定される「タグの件数」の文字列を返す関数。

初期値： default_topic_count_text

topic_count_scale_callback

（関数名） （オプション） タグリンクのフォントサイズ算出の元になる「タグのサイズ」を 100% 単位で返す関数。

初期値： default_topic_count_scale

single_text

（文字列） （必須） オプション

初期値： なし

multiple_text

（文字列） （必須） オプション

初期値： なし

filter

（真偽値） （オプション） タグクラウド作成後に wp_generate_tag_cloud フィルタを実行するかどうかを指定。

• 1 (true)
• 0 (false)

初期値： 1

フック

• apply_filters( 'tag_cloud_sort', $tags, $args )

タグクラウド作成前に実行されます。

• apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );

タグクラウド作成後に実行されます。

用例

注

• wp_tag_cloud() から呼ばれます。
• get_tags() を呼びます。

変更履歴

• 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()

テンプレートタグへの PHP 関数型パラメータの渡し方、関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Template_Tags/wp_generate_tag_cloud （最新版との差分）