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

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

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

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

この項目「関数リファレンス/wp category checklist」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

チェックボックスの <input> 要素の番号なしリストを出力します。要素はカテゴリー名でラベル付けされます。これは wp_terms_checklist() を簡単に呼び出せる便利な関数です。

使い方

<?php
    wp_category_checklist( $post_id, $descendants_and_self, $selected_cats,
        $popular_cats, $walker, $checked_ontop);
?>

パラメータ

すべてのパラメータはデフォルトがあるので省略できますが、この関数は $post_id$selected_cats(配列)の両方を省略すると大して便利なものではありません。ただし両方とも指定するのは止めましょう。

$post_id
整数) (オプション) この ID で指定した投稿につけられたカテゴリーにチェックをつける。ゼロでない値を指定する場合は $selected_cats が false でなければならない(配列も不可)。
初期値: 0(投稿を指定しない)
$descendants_and_self
整数) (オプション) この ID で指定したカテゴリーとその子孫カテゴリーを表示する。
初期値: 0(カテゴリーを指定しない)
$selected_cats
真偽値|配列) (オプション) チェックをつけるカテゴリーの ID の配列。もし $post_id で投稿を指定したら、これは false にしなければならない。
初期値: false(カテゴリーを指定しない)
$popular_cats
真偽値|配列) (オプション) カテゴリーの ID の配列を指定すると、「人気のカテゴリー」クラスを与えられるカテゴリーのリストを上書きする。
初期値: false(カテゴリーを指定しない)
$walker
オブジェクト) (オプション) 出力を生成するために使う Walker オブジェクト。空の場合は Walker_Category_Checklist のインスタンスが使われる。
初期値: null
$checked_ontop
真偽値) (オプション) チェックされたカテゴリーを階層から外してリストの先頭に表示する。false の場合はそうしません。
初期値: true

用例

すべてのカテゴリーのリストを出力します:

wp_category_checklist();

特定のカテゴリーとその子孫カテゴリーのリストを出力します:

$category_id = 22;

wp_category_checklist( 0, $category_id );

特定の投稿についたすべてのカテゴリーにチェックをつけます:

$post_id = 45;

wp_category_checklist( $post_id );

投稿を指定する代わりに、チェックをつけるカテゴリーの配列を指定します:

$selected_cats = array( 45, 33, 118 );

wp_category_checklist( 0, 0, $selected_cats );

人気のカテゴリーに表示するカテゴリーを上書きします:

$popular = array( 45, 33, 118 );

wp_category_checklist( 0, 0, false, $popular );

使用する walker オブジェクトを指定します:

$walker = new My_Walker_Category_Checklist;

wp_category_checklist( 0, 0, false, false, $walker );

チェックをつけたカテゴリーを他のカテゴリーの前にリストします:

$selected_cats = array( 45, 33, 118 );
$checked_ontop = true;

wp_category_checklist( 0, 0, $selected_cats, false, null, $checked_ontop );

パラメーターを任意の組み合わせで使うことができますが、$post_id$selected_cats を両方とも使うのは避けましょう。

変更履歴

新規導入: 2.5.1

ソースファイル

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

カテゴリー: 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()

リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


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


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