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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。