◆ WordPress に関するドキュメントは 『WordPress Codex 日本語版』へ移動しました。 ◆
最新情報はリンク先でお読みください。
テンプレートタグ/list cats
出典: ps*wiki
< テンプレートタグ
このテンプレートタグは WordPress 2.1 から非推奨となりました。後継となる新しいテンプレートタグが作られたか、動作対象外となり、WordPress の将来のバージョンで削除される見込みです。
このタグを使っていた場合は、後継の wp_list_categories に切り替えてください。
- 書式:
<?php list_cats(optionall, 'all', 'sort_column', 'sort_order', 'file', list, optiondates, optioncount, hide_empty, use_desc_for_title, children, child_of, 'Categories', recurse, 'feed', 'feed_img', 'exclude', hierarchical); ?>
- 説明: リスト形式でカテゴリーリンク一覧を出力。
- 位置: ループ外
- 引数:
- optionall (true/false)- すべての記事を含む、「All」リンクを出力するかどうか。
- true(デフォルト。「All」リンクを出力)
- false(「All」リンクを出力しない)
- all (文字列)- すべての記事を含む、「All」リンクのラベルテキスト。デフォルト値は「All」。
- sort_column (規定値)- 出力するカテゴリーの並べ方。
- ID(デフォルト。カテゴリーID順)
- name(カテゴリー名順)
- sort_order (asc/desc)- 出力するカテゴリーの並び順。sort_columnで指定した並べ方に基づく。
- asc(デフォルト。sort_columnで指定したルールに従い、昇順に並べる)
- desc(降順に並べる)
- file (文字列)- カテゴリーリンクを出力するファイル名。現時点のバージョンではこの引数を指定してもデフォルト値が採用される。
- list (true/false)- <li>要素内に各カテゴリー名とそのリンクを出力するかどうか。
- true(デフォルト。< nowiki >
- </nowiki >要素を使用。)
- false(タグを付加しない)
- optiondates (true/false)- カテゴリー最新記事の投稿/更新日を出力するかどうか。
- true(投稿/更新日を出力)
- false(デフォルト。投稿/更新日を出力しない)
- optioncount (true/false)- カテゴリー内の記事数を出力するかどうか。
- true(投稿/更新日を出力)
- false(デフォルト。投稿/更新日を出力しない)
- hide_empty (true/false)- 投稿記事数が0のカテゴリーを一覧に含めるどうか。
- true(デフォルト。記事数が0のカテゴリーを出力しない)
- false(記事数が0でもカテゴリーを出力)
- use_desc_for_title (true/false)- a要素のtitle属性としてカテゴリーの説明を追加するかどうか。
- true(デフォルト。title属性を追加)
- false(title属性を追加しない)
- children (true/false)- サブカテゴリーを出力するかどうか。
- true(サブカテゴリーを出力)
- false(デフォルト。サブカテゴリーを出力しない)
- child_of (整数)- 指定したカテゴリーIDのサブカテゴリーのみを出力。デフォルトではすべてのカテゴリーのサブカテゴリーを出力する。
- Categories (整数)- カテゴリーを階層形式で出力するためにWordPress内部で使われる引数。テーマテンプレート内でこのタグを使う場合、0以外は指定しないこと。
- recurse (true/false)- 取得した値の処理方法。
- true(PHPで使用できる値としてカテゴリー一覧を返す)
- false(デフォルト。カテゴリー一覧をページ内に出力)
- feed (文字列)- 各投稿者のRSSフィードをリンクするテキスト。デフォルトではテキストやリンクは出力されない。
- feed_image (文字列)- 各投稿者のRSSフィードをリンクする画像のURL。「feed」引数で指定したテキストよりも優先される。
- exclude (整数)- 出力させないカテゴリーのID。複数ある場合は '1,2,3' などのコンマ区切り形式で指定する。
- hierarchical (true/false)- サブカテゴリーを親カテゴリーの下階層として出力させるかどうか。
- true(デフォルト。複数階層形式で一覧を出力)
- false(すべてのカテゴリーを同じ階層として出力)
- optionall (true/false)- すべての記事を含む、「All」リンクを出力するかどうか。
- コード記述例:
<?php list_cats(false, '', 'name'); ?>
- 出力例:
<li><a href="http://example.com/?cat=2" title="WordPress関連情報">Wordpress</a></li> <li><a href="http://example.com/?cat=1" title="WordPressプラグイン関連情報">プラグイン</a></li>
