wp_dropdown_pages

説明

string wp_dropdown_pages( [ mixed $args = '' ] )
ドロップダウン形式の固定ページリストを表示または取得する。

パラメータ

  • $args
    検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
    キーワード意味
    depth階層付きの場合は1、階層なし(フラット)の場合は0を指定(省略時は0)
    child_of親固定ページの投稿IDを指定(その投稿IDの固定ページの子孫がすべて対象となる。省略時は0)
    selected初期表示時に選択状態にする固定ページの投稿IDを指定(省略時は0)
    echo表示する場合は1、取得する場合は0を指定(省略時は1)
    nameselect要素のname属性値を指定(省略時は'page_id')
    idselect要素のid属性値を指定(省略時は'')
    classselect要素のclass属性値を指定(省略時は'')
    show_option_none固定ページがない場合のテキストを指定(省略時は'')
    show_option_no_change'no change'(変更なし)のテキストを指定(省略時は'')
    option_none_value(最初に表示される)未選択時のoption要素のvalue属性値を指定(省略時は-1)
    value_fieldoption要素の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テキストが入る。
$html = apply_filters( 'wp_dropdown_pages', $output );

アクション

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

ソースファイル

/wp-includes/post-template.php

最終更新 : 2018年05月27日 10:46



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。