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



お勧め

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

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

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

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。