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

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

関数リファレンス/wp terms checklist

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

wp_category_checklist() /en のタクソノミーに依存しないバージョンです。

使い方

<?php wp_terms_checklist( $post_id, $args ); ?>

デフォルトの使い方

$post_id
整数) (オプション) タームのチェックリストを作りたい投稿の ID。
初期値: 0(投稿を指定しない)
$args
配列) (オプションパラメータを見てください。
初期値: array()
<?php $args = array(
	'descendants_and_self'  => 0,
	'selected_cats'         => false,
	'popular_cats'          => false,
	'walker'                => null,
	'taxonomy'              => 'category',
	'checked_ontop'         => true
); ?>

パラメータ

descendants_and_self 
(整数) 指定したタームとその子孫タームを表示する。デフォルトは 0 で、タームを指定しません。
selected_cats 
(配列) デフォルトは 'false' で、初期状態はどのタームも選択されません。しかし $post_id が指定された場合は、その投稿につけられたタームが初期状態で選択されます。その他の場合は、ターム ID の配列を与えることにより初期状態で選択されるべきタームを指定します。
popular_cats 
(配列) デフォルトは 'false' で、使用数の順にトップ 10 のタームを表示します。その他の場合は、タームの配列を与えることにより「人気のターム」のリストに表示されるべきタームを指定します。
walker 
(オブジェクト) リストをレンダリングする Walker オブジェクト。有効な値は:
  • Walker_Category もしくは Walker /en のいずれかを拡張したクラスのインスタンス。
参考: デフォルトは Walker_Category_Checklist です。これは wp-admin/includes/template.php にあります。しかし wp_terms_checklist() が呼び出される時点ではこのクラスが未定義の場合があります。そのためこのクラスを拡張したい場合は注意すべきです。
taxonomy 
(文字列) このタクソノミーのタームを返します。このパラメータは バージョン 3.0 で追加されました。有効な値は:
  • category - デフォルト
  • または登録されている任意のタクソノミー
checked_ontop 
(真偽値) 選択されたタームをタームリストの一番上に表示するかしないか。デフォルトは true です(一番上に表示する)。有効な値は:
  • 1 (True) - デフォルト
  • 0 (False)

変更履歴

新規導入: 3.0

ソースファイル

wp_terms_checklist()wp-admin/includes/template.php にあります。

関連項目

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


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