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

説明

wp_dropdown_pages() は、固定ページを選択するセレクトボックスを出力する関数です。

基本構文

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

引数

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

戻り値

HTML文字列。

使い方(サンプル)

wp_dropdown_pages( array( 'name' => 'target_page', 'show_option_none' => '選択してください' ) );

注意点

  • 設定画面で「このページ」を選ぶ項目を作るときに便利です。

実務での使いどころ

  • 固定ページを選ぶ、プルダウン(<select>)を出力するとき。
  • テーマのオプションや、独自のフォームで、ページを選ばせるとき。

よくあるミスと対処

  • name の既定は page_id。他のフォーム項目と、名前が重なる。
  • 選択済みの値(selected)を、指定していない。
  • 文字列として受け取りたいのに、echo の既定のまま使っている。'echo' => 0 を指定する。

NG例

wp_dropdown_pages(); // name が、既定の page_id のまま

OK例

wp_dropdown_pages( array(
	'name'             => 'contact_page',
	'selected'         => (int) get_option( 'contact_page' ),
	'show_option_none' => '選択してください',
) );

使い分け早見表

関数 出力するもの
wp_dropdown_pages() 固定ページの、プルダウン
wp_list_pages() 固定ページの、リスト
get_pages() 固定ページを、配列で取得する

関連項目

wp_list_pages()、get_pages()

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

コメント

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