- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/wp list categories」の版間の差分
(en:Template Tags/wp_list_categories 18:16, 20 Jun 2007 MichaelH 版) |
(一部訳) |
||
1行目: | 1行目: | ||
− | + | 原文・最新版: [[:en:Template Tags/wp_list_categories|WordPress Codex » wp_list_categories]] | |
− | + | ||
− | == | + | == 説明 == |
− | + | (Description) | |
+ | |||
+ | テンプレートタグ <code>wp_list_categories</code> は、リンク付き[[用語集#Category|カテゴリ]]リストを表示します。カテゴリリンクをクリックすると、[[:ja:Template Hierarchy|テンプレート階層ルール]]に基づく適切な[[Category Templates|カテゴリ・テンプレート]]([[:en:Category Templates|原文]])を用いたカテゴリページに、そのカテゴリに属する全ての記事が表示されます。<code>wp_list_categories</code> は、WordPress 2.1 で非推奨となった <code>[[:en:Template_Tags/list_cats|list_cats()]]</code> および <code>[[:en:Template_Tags/wp_list_cats|wp_list_cats()]]</code> の後継で、この二つとほぼ同じように動作します。 | ||
+ | |||
+ | == 使い方 == | ||
+ | (Usage) | ||
+ | |||
+ | <?php wp_list_categories('arguments'); ?> | ||
+ | |||
+ | == 用例 == | ||
+ | (Examples) | ||
+ | ===デフォルトでの使い方=== | ||
+ | (Default Usage) | ||
+ | |||
+ | wp_list_categories(); | ||
− | |||
− | |||
<pre> | <pre> | ||
$defaults = array('show_option_all' => '', 'orderby' => 'name', 'order' => 'ASC', | $defaults = array('show_option_all' => '', 'orderby' => 'name', 'order' => 'ASC', | ||
14行目: | 25行目: | ||
</pre> | </pre> | ||
− | + | デフォルトでは次のように表示: | |
− | * No link to all | + | * No link to all categories(訳注:意図分からず。。) |
− | * | + | * リストはカテゴリ名の昇順 |
− | * | + | * (各カテゴリに属する最後に更新された記事の)最終更新日は非表示 |
− | * | + | * 番号なし箇条書きリスト形式で表示 |
− | * | + | * 投稿数は非表示 |
− | * | + | * 投稿のあるカテゴリのみ表示 |
− | * | + | * カテゴリ概要を title 属性にセット |
− | * | + | * 子カテゴリの制限なし |
− | * | + | * フィードへのリンクなし/リンク画像なし |
− | * | + | * 表示カテゴリの指定/除外なし(指定しないので、上記初期値に <code>'include' => ''</code> が載っていない) |
− | * | + | * カテゴリレベルをインデント表示(ネスト表示、ツリー表示) |
− | * | + | * リストの前に、見出しとして「Category」(日本語化ファイルで定義されていればその文字列)を表示 |
− | * | + | * SQL LIMIT なし(<code>'number' => 0</code> は上記初期値に載っていない) |
− | + | ||
− | + | ||
− | === | + | === カテゴリの指定・除外 === |
− | + | (Include or Exclude Categories) | |
− | < | + | カテゴリをアルファベット順にソート、カテゴリID 16, 3, 9, 5 のみを表示したいとき、次のようにコードを書きます: |
− | + | <pre class="expample"> | |
− | < | + | <ul> |
− | + | <?php | |
− | + | wp_list_categories('orderby=name&include=3,5,9,16'); ?> | |
− | wp_list_categories('orderby=name&include=3,5,9,16'); ? | + | </ul> |
− | + | </pre> | |
− | + | ||
− | </ | + | |
− | + | 次の例は、カテゴリ名順にソート、各カテゴリの投稿数を表示、リストからカテゴリID 10 を除外。 | |
− | + | <pre class="expample"> | |
− | < | + | <ul> |
− | + | <?php | |
− | < | + | wp_list_categories('orderby=name&show_count=1&exclude=10'); ?> |
− | + | </ul> | |
− | + | </pre> | |
− | wp_list_categories('orderby=name&show_count=1&exclude=10'); ? | + | |
− | + | ||
− | + | ||
− | </ | + | |
− | === Display or Hide the List Heading | + | === リストの見出しの表示/非表示 === |
− | + | (Display or Hide the List Heading) | |
− | + | '''title_li''' パラメータは、生成されるカテゴリリストの見出しを設定したり隠したりします。初期値は <tt>'(__('Categories')'</tt>で、見出しとして "Categories"(日本語化で「カテゴリ」)といった語句を表示します。このパラメータに null や空の値をセットすると、見出しを表示しません。次のコードは、カテゴリID 4、7 以外を表示し、見出しを非表示とする例: | |
− | + | ||
− | <tt> | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | </tt> | + | |
− | + | ||
− | + | <pre class="expample"> | |
+ | <ul> | ||
+ | <?php | ||
+ | wp_list_categories('exclude=4,7&title_li='); ?> | ||
+ | </ul> | ||
+ | </pre> | ||
− | < | + | 次の例は、カテゴリID 9、5、23 のみを表示、見出しを <code><nowiki><h2></nowiki></code> タグ付きの "Poetry" 語句に変更: |
− | + | ||
− | < | + | <pre class="expample"> |
− | + | <ul> | |
− | + | <?php | |
− | wp_list_categories('include=5,9,23&title_li= | + | wp_list_categories('include=5,9,23&title_li=<h2>' . __('Poetry') . '</h2>' ); ?> |
− | + | </ul> | |
− | </ | + | </pre> |
− | </ | + | |
+ | 訳注: <code>(__('Categories')</code>、<code>__('Poetry')</code> は、ローカライズ(日本語化)対応の書き方です。括弧内の文字列とその訳語を日本語化ファイルで定義すれば、訳語に置換されて表示されます。 | ||
+ | |||
+ | === 子カテゴリのみの表示 === | ||
+ | (Only Show Children of a Category) | ||
− | |||
The following example code generates category links, sorted by ID, only for the children of the category with ID 8; it shows the number of posts per category and hides category descriptions from the <tt>title</tt> attribute of the generated links. '''Note:''' If there are no posts in a parent Category, the parent Category will not display. | The following example code generates category links, sorted by ID, only for the children of the category with ID 8; it shows the number of posts per category and hides category descriptions from the <tt>title</tt> attribute of the generated links. '''Note:''' If there are no posts in a parent Category, the parent Category will not display. | ||
− | < | + | <pre class="expample"> |
− | + | <ul> | |
− | < | + | <?php wp_list_categories('orderby=id&show_count=1 |
− | + | &use_desc_for_title=0&child_of=8'); ?> | |
− | + | </ul> | |
− | + | </pre> | |
− | + | ||
− | </ | + | |
− | === Display Categories with RSS Feed Links | + | === フィードリンク付きカテゴリ表示 === |
− | + | (Display Categories with RSS Feed Links) | |
− | + | カテゴリ名でソート、各カテゴリの投稿数を表示、各カテゴリの RSS フィードへのリンクを表示する例: | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | <pre class="expample"> | |
+ | <ul> | ||
+ | <?php | ||
+ | wp_list_categories('orderby=name&show_count=1&feed=RSS'); ?> | ||
+ | </ul> | ||
+ | </pre> | ||
+ | |||
+ | RSS リンク部分をフィードアイコンで表示するには: | ||
+ | |||
+ | <pre class="expample"> | ||
+ | <ul> | ||
+ | <?php | ||
+ | wp_list_categories('orderby=name&show_count=1 | ||
+ | &feed_image=/images/rss.gif'); ?> | ||
+ | </ul> | ||
+ | </pre> | ||
− | + | === カテゴリリストのマークアップ様式 === | |
− | + | (Markup and Styling of Category Lists) | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | |||
By default, '''wp_list_categories()''' generates list items <tt><nowiki><li></nowiki></tt> for an unordered list <tt><nowiki><ul></nowiki></tt>. All list items generated by '''wp_list_categories()''' are marked with the class <tt>"page_item"</tt>. When '''wp_list_categories()''' is called while displaying a Category Page, the list item for that Page will be given the additional class <tt>"current_page_item"</tt>: | By default, '''wp_list_categories()''' generates list items <tt><nowiki><li></nowiki></tt> for an unordered list <tt><nowiki><ul></nowiki></tt>. All list items generated by '''wp_list_categories()''' are marked with the class <tt>"page_item"</tt>. When '''wp_list_categories()''' is called while displaying a Category Page, the list item for that Page will be given the additional class <tt>"current_page_item"</tt>: | ||
133行目: | 132行目: | ||
</pre> | </pre> | ||
− | You can style these classes with [[ | + | You can style these classes with [[用語集#CSS|CSS selectors]] : |
.page_item { ... } | .page_item { ... } | ||
.current_page_item { ... } | .current_page_item { ... } | ||
---- | ---- | ||
− | '''Note:''' The list items generated by ''wp_list_categories'' (unless the '''style''' parameter is set to ''none'') require an opening and closing <tt><nowiki><ul></nowiki></tt> tag. See the [[ | + | '''Note:''' The list items generated by ''wp_list_categories'' (unless the '''style''' parameter is set to ''none'') require an opening and closing <tt><nowiki><ul></nowiki></tt> tag. See the [[#用例|examples]] below. |
---- | ---- | ||
− | == | + | == パラメータ == |
− | + | (Parameters) | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | ; | + | ; show_option_all |
+ | : (''文字列'') A non-blank values causes the display of a link to all categories if the style is set to list. The default value is not to display a link to all.(訳注:意図分からず。。) | ||
+ | ; orderby | ||
+ | : (''文字列'') カテゴリのソート項目:アルファベット、カテゴリID、カテゴリの投稿数。初期値はカテゴリ名でソート。有効値: | ||
+ | :* <code>ID</code> | ||
+ | :* <code>name</code> - 初期値 | ||
+ | :* <code>count</code> | ||
+ | ; order | ||
+ | : (''文字列'') カテゴリのソート順(昇順または降順)。初期値は ''昇順''。有効値: | ||
+ | :* <code>ASC</code> - 初期値 | ||
+ | :* <code>DESC</code> | ||
+ | ; show_last_updated | ||
+ | : (''論理値'') (各カテゴリに属する)投稿の最終更新日を表示するか。表示する(TRUE) または 非表示(FALSE)。初期値は非表示(FALSE)。 | ||
+ | : * <code>1 (true) </code> | ||
+ | : * <code>0 (false) </code> - 初期値 | ||
+ | ; style | ||
+ | : (''文字列'') カテゴリリストの表示形式。値 ''list'' は、カテゴリを箇条書きとして表示。''none'' は表示形式なし(各カテゴリは <code><nowiki><br></nowiki></code>(改行)で区切られる)。[[#Markup_and_Styling_of_Category_Lists|the markup section]] 参照。有効値: | ||
+ | :* <code>list</code> - 初期値 | ||
+ | :* <code>none</code> | ||
+ | ; show_count | ||
+ | : (''論理値'') 各カテゴリに投稿数を表示するか。初期値は ''false''(非表示)。有効値: | ||
+ | :* <code>1 (true)</code> | ||
+ | :* <code>0 (false)</code> - 初期値 | ||
+ | ; hide_empty | ||
+ | : (''論理値'') 投稿のないカテゴリを非表示にするか。初期値は ''true''(空のカテゴリを隠す)。有効値: | ||
+ | :* <code>1 (true)</code> - 初期値 | ||
+ | :* <code>0 (false)</code> | ||
+ | ; use_desc_for_title | ||
+ | : (''論理値'') カテゴリの[[:en:Manage Categories SubPanel|概要]]をリンク(アンカータグ)の <code>title</code> 属性に挿入(<nowiki><a title="<em>カテゴリ概要</em>" href="...</nowiki> のように)するか。初期値は ''true''(カテゴリ概要を挿入)。有効値: | ||
+ | :* <code>1 (true)</code> - 初期値 | ||
+ | :* <code>0 (false)</code> | ||
+ | ; child_of | ||
+ | : (''整数'') このパラメータで指定したカテゴリID の子カテゴリのみ表示。初期値なし。このパラメータを使うと、'''hide_empty''' パラメータに ''false'' がセットされる。 | ||
+ | ; feed | ||
+ | : (''文字列'')各カテゴリの [[用語集#RSS|rss-2]] フィードへのリンクを表示、そのリンク文字列を設定する。初期値は ''フィードへのリンク・リンク文字列なし''。 | ||
+ | ; feed_image | ||
+ | : (''文字列'') 各カテゴリの rss-2 フィードへのリンクを画像(通常は RSSフィードアイコン)で表示したいときに、その画像の URI を設定。このパラメータは '''feed''' パラメータより優先(リンク文字列の替わりに画像)。初期値なし。 | ||
+ | ; exclude | ||
+ | : (''文字列'') 指定したカテゴリ(複数可)をリストから除外。除外するカテゴリID をカンマ区切りで昇順に指定。[[#カテゴリの指定・除外|用例]]を参照。''child_of'' パラメータは自動的に無効となります。 | ||
+ | ; include | ||
+ | : (''文字列'') 指定したカテゴリID のみリストに表示。カンマ区切りで昇順に指定。[[#カテゴリの指定・除外|用例]]を参照。 | ||
+ | ; hierarchical | ||
+ | : (''論理値'') サブカテゴリを箇条書き項目の内側(親カテゴリより下位レベル)に表示するか、親と同レベルで表示するか。(つまり、箇条書きを入れ子・ツリー表示にするか否か。)初期値は ''true''(サブカテゴリを親より下位レベルに表示)。有効値: | ||
+ | :* <code>1 (true)</code> - 初期値 | ||
+ | :* <code>0 (false)</code> | ||
+ | ; title_li | ||
+ | : (''文字列'') 箇条書きの外側に表示するタイトルと表示形式。デフォルトは "_Categories"。このパラメータを中味を空で指定すると、箇条書きの外側には何も表示しません。[[#リストの見出しの表示/非表示|用例]]を参照。 | ||
+ | ; number | ||
+ | : (''整数'') 表示するカテゴリ数を設定。This causes the SQL LIMIT value to be defined. 初期値は無制限。 | ||
== Related == | == Related == |
2007年7月18日 (水) 21:38時点における版
原文・最新版: WordPress Codex » wp_list_categories
目次
説明
(Description)
テンプレートタグ wp_list_categories
は、リンク付きカテゴリリストを表示します。カテゴリリンクをクリックすると、テンプレート階層ルールに基づく適切なカテゴリ・テンプレート(原文)を用いたカテゴリページに、そのカテゴリに属する全ての記事が表示されます。wp_list_categories
は、WordPress 2.1 で非推奨となった list_cats()
および wp_list_cats()
の後継で、この二つとほぼ同じように動作します。
使い方
(Usage)
<?php wp_list_categories('arguments'); ?>
用例
(Examples)
デフォルトでの使い方
(Default Usage)
wp_list_categories();
$defaults = array('show_option_all' => '', 'orderby' => 'name', 'order' => 'ASC', 'show_last_update' => 0, 'style' => 'list','show_count' => 0, 'hide_empty' => 1, 'use_desc_for_title' => 1, 'child_of' => 0, 'feed' => '', 'feed_image' => '', 'exclude' => '', 'hierarchical' => true, 'title_li' => __('Categories'));
デフォルトでは次のように表示:
- No link to all categories(訳注:意図分からず。。)
- リストはカテゴリ名の昇順
- (各カテゴリに属する最後に更新された記事の)最終更新日は非表示
- 番号なし箇条書きリスト形式で表示
- 投稿数は非表示
- 投稿のあるカテゴリのみ表示
- カテゴリ概要を title 属性にセット
- 子カテゴリの制限なし
- フィードへのリンクなし/リンク画像なし
- 表示カテゴリの指定/除外なし(指定しないので、上記初期値に
'include' =>
が載っていない) - カテゴリレベルをインデント表示(ネスト表示、ツリー表示)
- リストの前に、見出しとして「Category」(日本語化ファイルで定義されていればその文字列)を表示
- SQL LIMIT なし(
'number' => 0
は上記初期値に載っていない)
カテゴリの指定・除外
(Include or Exclude Categories)
カテゴリをアルファベット順にソート、カテゴリID 16, 3, 9, 5 のみを表示したいとき、次のようにコードを書きます:
<ul> <?php wp_list_categories('orderby=name&include=3,5,9,16'); ?> </ul>
次の例は、カテゴリ名順にソート、各カテゴリの投稿数を表示、リストからカテゴリID 10 を除外。
<ul> <?php wp_list_categories('orderby=name&show_count=1&exclude=10'); ?> </ul>
リストの見出しの表示/非表示
(Display or Hide the List Heading)
title_li パラメータは、生成されるカテゴリリストの見出しを設定したり隠したりします。初期値は '(__('Categories')'で、見出しとして "Categories"(日本語化で「カテゴリ」)といった語句を表示します。このパラメータに null や空の値をセットすると、見出しを表示しません。次のコードは、カテゴリID 4、7 以外を表示し、見出しを非表示とする例:
<ul> <?php wp_list_categories('exclude=4,7&title_li='); ?> </ul>
次の例は、カテゴリID 9、5、23 のみを表示、見出しを <h2>
タグ付きの "Poetry" 語句に変更:
<ul> <?php wp_list_categories('include=5,9,23&title_li=<h2>' . __('Poetry') . '</h2>' ); ?> </ul>
訳注: (__('Categories')
、__('Poetry')
は、ローカライズ(日本語化)対応の書き方です。括弧内の文字列とその訳語を日本語化ファイルで定義すれば、訳語に置換されて表示されます。
子カテゴリのみの表示
(Only Show Children of a Category)
The following example code generates category links, sorted by ID, only for the children of the category with ID 8; it shows the number of posts per category and hides category descriptions from the title attribute of the generated links. Note: If there are no posts in a parent Category, the parent Category will not display.
<ul> <?php wp_list_categories('orderby=id&show_count=1 &use_desc_for_title=0&child_of=8'); ?> </ul>
フィードリンク付きカテゴリ表示
(Display Categories with RSS Feed Links)
カテゴリ名でソート、各カテゴリの投稿数を表示、各カテゴリの RSS フィードへのリンクを表示する例:
<ul> <?php wp_list_categories('orderby=name&show_count=1&feed=RSS'); ?> </ul>
RSS リンク部分をフィードアイコンで表示するには:
<ul> <?php wp_list_categories('orderby=name&show_count=1 &feed_image=/images/rss.gif'); ?> </ul>
カテゴリリストのマークアップ様式
(Markup and Styling of Category Lists)
By default, wp_list_categories() generates list items <li> for an unordered list <ul>. All list items generated by wp_list_categories() are marked with the class "page_item". When wp_list_categories() is called while displaying a Category Page, the list item for that Page will be given the additional class "current_page_item":
<ul> <li class="page_item current_page_item"> [the current page] </li> <li class="page_item"> [another page] </li> </ul>
You can style these classes with CSS selectors :
.page_item { ... } .current_page_item { ... }
Note: The list items generated by wp_list_categories (unless the style parameter is set to none) require an opening and closing <ul> tag. See the examples below.
パラメータ
(Parameters)
- show_option_all
- (文字列) A non-blank values causes the display of a link to all categories if the style is set to list. The default value is not to display a link to all.(訳注:意図分からず。。)
- orderby
- (文字列) カテゴリのソート項目:アルファベット、カテゴリID、カテゴリの投稿数。初期値はカテゴリ名でソート。有効値:
-
ID
-
name
- 初期値 -
count
-
- order
- (文字列) カテゴリのソート順(昇順または降順)。初期値は 昇順。有効値:
-
ASC
- 初期値 -
DESC
-
- show_last_updated
- (論理値) (各カテゴリに属する)投稿の最終更新日を表示するか。表示する(TRUE) または 非表示(FALSE)。初期値は非表示(FALSE)。
- *
1 (true)
- *
0 (false)
- 初期値 - style
- (文字列) カテゴリリストの表示形式。値 list は、カテゴリを箇条書きとして表示。none は表示形式なし(各カテゴリは
<br>
(改行)で区切られる)。the markup section 参照。有効値:-
list
- 初期値 -
none
-
- show_count
- (論理値) 各カテゴリに投稿数を表示するか。初期値は false(非表示)。有効値:
-
1 (true)
-
0 (false)
- 初期値
-
- hide_empty
- (論理値) 投稿のないカテゴリを非表示にするか。初期値は true(空のカテゴリを隠す)。有効値:
-
1 (true)
- 初期値 -
0 (false)
-
- use_desc_for_title
- (論理値) カテゴリの概要をリンク(アンカータグ)の
title
属性に挿入(<a title="<em>カテゴリ概要</em>" href="... のように)するか。初期値は true(カテゴリ概要を挿入)。有効値:-
1 (true)
- 初期値 -
0 (false)
-
- child_of
- (整数) このパラメータで指定したカテゴリID の子カテゴリのみ表示。初期値なし。このパラメータを使うと、hide_empty パラメータに false がセットされる。
- feed
- (文字列)各カテゴリの rss-2 フィードへのリンクを表示、そのリンク文字列を設定する。初期値は フィードへのリンク・リンク文字列なし。
- feed_image
- (文字列) 各カテゴリの rss-2 フィードへのリンクを画像(通常は RSSフィードアイコン)で表示したいときに、その画像の URI を設定。このパラメータは feed パラメータより優先(リンク文字列の替わりに画像)。初期値なし。
- exclude
- (文字列) 指定したカテゴリ(複数可)をリストから除外。除外するカテゴリID をカンマ区切りで昇順に指定。用例を参照。child_of パラメータは自動的に無効となります。
- include
- (文字列) 指定したカテゴリID のみリストに表示。カンマ区切りで昇順に指定。用例を参照。
- hierarchical
- (論理値) サブカテゴリを箇条書き項目の内側(親カテゴリより下位レベル)に表示するか、親と同レベルで表示するか。(つまり、箇条書きを入れ子・ツリー表示にするか否か。)初期値は true(サブカテゴリを親より下位レベルに表示)。有効値:
-
1 (true)
- 初期値 -
0 (false)
-
- title_li
- (文字列) 箇条書きの外側に表示するタイトルと表示形式。デフォルトは "_Categories"。このパラメータを中味を空で指定すると、箇条書きの外側には何も表示しません。用例を参照。
- number
- (整数) 表示するカテゴリ数を設定。This causes the SQL LIMIT value to be defined. 初期値は無制限。
Related
カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()