wp_dropdown_pages

パラメータ

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

  キーワード	意味
  depth	階層付きの場合は1、階層なし（フラット）の場合は0を指定（省略時は0）
  child_of	親固定ページの投稿IDを指定（その投稿IDの固定ページの子孫がすべて対象となる。省略時は0）
  selected	初期表示時に選択状態にする固定ページの投稿IDを指定（省略時は0）
  echo	表示する場合は1、取得する場合は0を指定（省略時は1）
  name	select要素のname属性値を指定（省略時は'page_id'）
  id	select要素のid属性値を指定（省略時は''）
  class	select要素のclass属性値を指定（省略時は''）
  show_option_none	固定ページがない場合のテキストを指定（省略時は''）
  show_option_no_change	'no change'（変更なし）のテキストを指定（省略時は''）
  option_none_value	（最初に表示される）未選択時のoption要素のvalue属性値を指定（省略時は-1）
  value_field	option要素のvalue属性値を指定（省略時は'ID'）

返り値

常に固定ページリストのHTMLテキストを返す。

注意

option要素は、'show_option_no_change'、'show_option_none'固定ページリストの順で追加される。

[4.2.0]'value_field'が追加され、option要素のvalue属性値に投稿ID以外（例：カテゴリー名）を表示できるようになった。

[4.3.0]'class'が追加され、select要素の任意のclass属性値を指定できるようになった。

使用例

• ドロップダウン形式の固定ページリストを表示する。
  <?php wp_dropdown_pages(); ?>
• ドロップダウン形式の固定ページリストを取得する。
  <?php $dropdown = wp_dropdown_pages( array( 'echo'=>0 ) ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/post-template.php