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

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

「テンプレートタグ/wp generate tag cloud」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Template_Tags/wp_generate_tag_cloud 19:16, 9 October 2009 Ramiy)
 
(全体を和訳。不足内容をソースから)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
Returns an HTML string that makes a tag cloud.
+
タグクラウドの HTML を文字列や配列で取得します。
  
== Usage ==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
%%%<?php wp_generate_tag_cloud( $tags, $args ); ?>%%%
+
<code><?php $cloud = wp_generate_tag_cloud( $tags, $args ); ?></code>
  
===Default Usage===
+
<div id="Default_Usage">
 +
===デフォルトの使い方===
 +
</div>
  
%%% <?php $args = array(
+
<code><?php $args = array(
 
'smallest'  => 8,
 
'smallest'  => 8,
 
'largest'  => 22,
 
'largest'  => 22,
20行目: 26行目:
 
'topic_count_text_callback'  => 'default_topic_count_text',
 
'topic_count_text_callback'  => 'default_topic_count_text',
 
'topic_count_scale_callback' => 'default_topic_count_scale',
 
'topic_count_scale_callback' => 'default_topic_count_scale',
'filter'    => 1 ); ?>%%%
+
'filter'    => 1 ); ?></code>
  
== Parameters ==
+
デフォルトでは次のように表示します。各タグの文字サイズは、付けられた記事数に応じて ''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 フィルタが実行されます。
  
 +
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
== Examples ==
+
{{Parameter|$tags|tagオブジェクトの配列|タグクラウドを作るためのタグ情報の配列。id, link, name のプロパティを持つこと。配列のキーが id の場合は id プロパティは不要。}}
 +
{{Parameter|smallest|整数|一番小さい(件数が少ない)タグの表示サイズを <tt>unit</tt> 単位で指定。|オプション|8}}
 +
{{Parameter|largest|整数|一番大きい(件数が少ない)タグの表示サイズを <tt>unit</tt> 単位で指定。|オプション|22}}
 +
{{Parameter|largest|文字列|フォントサイズの単位を指定。CSS の font-size プロパティで指定可能な単位が使える。
 +
:* <tt>pt</tt> (ポイント)
 +
:* <tt>px</tt> (ピクセル)
 +
:* <tt>em</tt> (現在のフォントのサイズを1とした比率)
 +
:* <tt>%</tt> (現在のフォントのサイズを100とした比率)
 +
|オプション|pt}}
 +
{{Parameter|number|整数|表示するタグの個数。0 ならすべて表示する|オプション|0}}
 +
{{Parameter|format|文字列|タグクラウドの戻り値の形式を指定する。
 +
:* <tt>array</tt> (タグを <a></a> で囲んだ文字列の配列)
 +
:* <tt>list</tt> (タグを <li><a></a></li> で囲み、<ul class='wp-tag-cloud'></ul> のリストにした文字列)
 +
:* <tt>flat</tt> (タグを <a></a> で囲み <tt>separator</tt> で区切った文字列)
 +
|オプション|flat}}
 +
{{Parameter|separator|文字列|<tt>format</tt> が <tt>flat</tt> のときのタグリンクの区切り文字。|オプション|\n}}
 +
{{Parameter|orderby|文字列|タグの並び順のキー。
 +
:* <tt>name</tt> (タグの名前順)
 +
:* <tt>その他</tt> (タグの件数順)
 +
|オプション|name}}
 +
{{Parameter|order|文字列|タグの並び順。
 +
:* <tt>ASC</tt> (昇順)
 +
:* <tt>DESC</tt> (降順)
 +
:* <tt>RAND</tt> (ランダム。orderby の値は無効)
 +
|オプション|ASC}}
 +
{{Parameter|topic_count_text_callback|関数名|タグリンクの title 属性に設定される「タグの件数」の文字列を返す関数。|オプション|default_topic_count_text}}
 +
{{Parameter|topic_count_scale_callback|関数名|タグリンクのフォントサイズ算出の元になる「タグのサイズ」を 100% 単位で返す関数。|オプション|default_topic_count_scale}}
 +
{{Parameter|single_text|文字列|タグの件数が1件のときの表示フォーマット。PHP の sprintf で使うフォーマット指定子を含む。<tt>topic_count_text_callback</tt> = '' のとき有効。|オプション}}
 +
{{Parameter|multiple_text|文字列|タグの件数が複数のときの表示フォーマット。PHP の sprintf で使うフォーマット指定子を含む。<tt>topic_count_text_callback</tt> = '' のとき有効。|オプション}}
 +
{{Parameter|filter|真偽値|タグクラウド作成後に wp_generate_tag_cloud フィルタを実行するかどうかを指定。
 +
:* <tt>1</tt> (true)
 +
:* <tt>0</tt> (false)
 +
|オプション|1}}
  
 +
<div id="Hooks">
 +
== フック ==
 +
</div>
 +
* apply_filters( 'tag_cloud_sort', $tags, $args )
 +
タグクラウド作成前に実行されます。
  
== Notes ==
+
* apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
* Called by [[Template Tags/wp_tag_cloud|wp_tag_cloud()]]
+
タグクラウド作成後に実行されます。
* Uses [[Function Reference/get_tags|get_tags()]]
+
  
== Changelog ==
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
* Since: 2.3.0
+
<div id="Notes">
 +
== 注 ==
 +
</div>
  
== Source File ==
+
* [[テンプレートタグ/wp_tag_cloud|wp_tag_cloud()]] から呼ばれます。
 +
* [[関数リファレンス/get_tags|get_tags()]] を呼びます。
  
<tt>wp_generate_tag_cloud()</tt> is located in {{Trac|wp-includes/category-template.php}}.
+
== 変更履歴 ==
  
== Related ==
+
* [[Version 2.3.0|2.3.0]] : 新規テンプレートタグ
  
{{Tag Tags}}
+
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
  
{{Tag Footer}}
+
<tt>wp_generate_tag_cloud()</tt> は {{Trac|wp-includes/category-template.php}} にあります。
{{DEFAULTSORT:wp_generate_tag_cloud}}  
+
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
 
 +
{{Tag Tag Tags}}
 +
{{PHP Function Tag Footer}}
 
{{原文|Template_Tags/wp_generate_tag_cloud|79012}}<!-- 19:16, 9 October 2009 Ramiy 版 -->
 
{{原文|Template_Tags/wp_generate_tag_cloud|79012}}<!-- 19:16, 9 October 2009 Ramiy 版 -->
 +
 +
{{DEFAULTSORT:wp_generate_tag_cloud}}
 
[[Category:テンプレートタグ]]
 
[[Category:テンプレートタグ]]
  
[[en:Template_Tags/wp_generate_tag_cloud]]
+
[[en:Template Tags/wp_generate_tag_cloud]]

2010年4月17日 (土) 00:44時点における版

タグクラウドの 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 - 最少・最多値のフォントサイズの単位として '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
文字列) (オプションformatflat のときのタグリンクの区切り文字。
初期値: \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 );

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

用例

変更履歴

  • 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最新版との差分