wp_dropdown_categories() の使い方|説明・引数・注意点

説明

wp_dropdown_categories() は、カテゴリーを選択するセレクトボックスを出力する関数です。

基本構文

wp_dropdown_categories( array|string $args = '' ): string

引数

  • $args:show_option_none、name、selected、taxonomy、echo など

戻り値

HTML文字列(echo が true のときは出力も行う)。

使い方(サンプル)

wp_dropdown_categories( array(
	'show_option_all' => 'すべて',
	'name'            => 'cat',
) );

注意点

  • カスタムタクソノミーも taxonomy 引数で指定できます。

実務での使いどころ

  • カテゴリーを選ぶ、プルダウン(<select>)を出力するとき。
  • カスタムタクソノミーの、ターム選択(taxonomy を指定)を作るとき。

よくあるミスと対処

  • 選んだときの移動が、自動で行われると思っている。ページ移動には、JavaScriptが別に必要。
  • taxonomy を指定せず、カスタムタクソノミーのタームが、出てこない。
  • name の既定は cat。他のフォーム項目と、名前が重なる。

NG例

wp_dropdown_categories(); // カスタムタクソノミーのタームが出ない

OK例

wp_dropdown_categories( array(
	'taxonomy'         => 'news_cat',
	'name'             => 'news_cat',
	'show_option_all'  => 'すべて',
	'value_field'      => 'slug',
) );

使い分け早見表

やりたいこと 使うもの
プルダウンのHTMLを出力 wp_dropdown_categories()
リストのHTMLを出力 wp_list_categories()
配列で取得 get_terms()

関連項目

wp_list_categories()、get_categories()

公式リファレンス:wp_dropdown_categories() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました