wp_dropdown_categories:WordPress私的マニュアル

wp_dropdown_categories

(2.1.0以降)
wp_dropdown_categories - ドロップダウン形式のカテゴリーリストを表示または取得する

説明

string wp_dropdown_categories( [ mixed $args = '' ] )

ドロップダウン形式のカテゴリーリストを表示または取得する。

パラメータ

$args

検索条件を指定する文字列または連想配列。主なキーワードは次の通り。

キーワード	意味
show_option_all	トップページURLのテキストを指定（省略時は''）
show_option_none	カテゴリーがない場合のテキストを指定（省略時は__('No categories')）
show_last_update	最終更新日を出力する場合はtrue、出力しない場合はfalseを指定（省略時はfalse）
show_count	投稿数を表示する場合はtrue、表示しない場合はfalseを指定（省略時はfalse）
echo	表示する場合はtrue、取得する場合はfalseを指定（省略時はtrue）
depth	階層付きの場合はtrue、階層なし（フラット）の場合はfalseを指定（省略時はfalse）
name	select要素のname属性値を指定（省略時は'cat'）
id	select要素のid属性値を指定（省略時は''）
class	select要素のclass属性値を指定（省略時は'postform'）
tab_index	select要素のtabindex属性値を指定（省略時は0）
hide_if_empty	条件にマッチするカテゴリーがない場合にselect要素を出力しない場合はtrue、必ず出力する場合はfalseを指定（省略時はfalse）
option_none_value	（最初に表示される）未選択時のoption要素のvalue属性値を指定（省略時は-1）
value_field	option要素のvalue属性値を指定（省略時は'term_id'）
required	[4.6.0]select要素にrequired属性を指定（省略時はfalse）

内部で呼び出されるget_termsと共通するパラメータは次の通り。

キーワード	意味
orderby	ソート対象を示すcount、name、slug、term_group、none、idなど（省略時は'name'）
order	ソート順を示すASCかDESC（省略時はASC）
hide_empty	投稿記事がないカテゴリーを取得しない場合はtrue(1)、投稿記事がないカテゴリーも取得する場合はfalse(0)を指定（省略時はtrue）
exclude	取得したくないカテゴリーのID（複数指定する場合は,で区切る。省略時は''）
child_of	カテゴリーのIDを指定（そのIDのカテゴリーの子孫がすべて対象となる。省略時はfalse）
hierarchical	true(1)またはfalse(0)を指定（省略時はtrue）
taxonomy	タクソノミーのスラッグを指定（省略時は'category'）

返り値

パラメータ$argsで'echo'の値に0を指定した場合はカテゴリーリストのHTMLテキストを返す。'echo'の値が1の場合は何も返さない。

注意

デフォルトでは'hide_empty'が1（true）のため、投稿のないカテゴリーは含まれない。投稿数に関係なくすべてのカテゴリーを表示（取得）する場合は、'hide_empty=0'を指定する。
パラメータ$argsには'selected'があり、カテゴリーアーカイブページの場合には現在のカテゴリーのIDが設定されるようになっている。 [4.2.0]'value_field'が追加され、option要素のvalue属性値にタームID以外（例：カテゴリー名）を表示できるようになった。

使用例

ドロップダウン形式のカテゴリーリストを表示する。
<?php wp_dropdown_categories(); ?>
ドロップダウン形式の全カテゴリーリストを取得する。
<?php $dropdown = wp_dropdown_categories( array( 'echo'=>0, 'hide_empty'=>0, 'hierarchical'=>1 ) ); ?>

フィルター

HTMLテキストを表示または返す直前にwp_dropdown_catsフィルターを実行する。$outputにはHTMLテキストが入る。

$output = apply_filters( 'wp_dropdown_cats', $output );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

参考

Code Reference: wp_dropdown_categories