概要
wp_dropdown_pages 関数は、ドロップダウン形式の固定ページリストを表示または取得するために使用される関数です。この関数は、ユーザーが特定のページを選択できるようにするための簡単な方法を提供します。特に管理画面のカスタムメタボックスやウィジェットでの使用が一般的です。
この関数がよく使われるシナリオは以下の通りです：
1. フォームで選択するページのリストを表示する
2. ページ選択用のメタボックスを作成する
3. カスタム投稿タイプ用の親ページを選択する
4. ナビゲーションメニュー作成時のページ選択
5. ウィジェットで特定のページをリンクするための選択
6. 固定ページのサブページを選ぶためのリスト表示
7. サイドバーやフッターに特定のページへのリンクを動的に生成する
8. 検索結果または他のコンテンツからのリンクを生成する際に使用する
構文
wp_dropdown_pages( $args );
パラメータ
$args はオプションの引数で、以下のパラメータを含む配列形式です：
– post_type: 対象とする投稿タイプ
– selected: 事前に選択したページの ID
– name: select ボックスの名前属性
– sort_column: ソートする列（デフォルトは ‘menu_order’）
– sort_order: 昇順または降順（’asc’ か ‘desc’）
– post_parent: 特定の親ページの子ページのみを取得
戻り値
この関数は、ドロップダウンリストの HTML を出力します。
関連する関数
関数を使用可能なバージョン
wp_dropdown_pages は WordPress バージョン 1.5 以降で使用可能です。
コアファイルのパス
wp-includes/post-template.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
-
基本的な固定ページのドロップダウンを表示
wp_dropdown_pages();これは最も基本的な使い方で、全ての固定ページが含まれたドロップダウンを表示します。
-
選択されたページをデフォルトで表示する
wp_dropdown_pages( array( 'selected' => 42 ) );この例では、ページ ID 42 がデフォルトで選択された状態のドロップダウンを表示します。
-
特定の親ページの子ページのみを表示
wp_dropdown_pages( array( 'post_parent' => 10 ) );ID が10のページの子ページのみを含むドロップダウンを表示します。
-
ソートオプションを指定する
wp_dropdown_pages( array( 'sort_column' => 'post_title', 'sort_order' => 'asc' ) );ページのタイトルで昇順にソートされたドロップダウンリストを作成します。
-
カスタム名属性でドロップダウンを表示
wp_dropdown_pages( array( 'name' => 'custom_dropdown_name' ) );ドロップダウンの名前属性を
custom_dropdown_nameに設定して表示します。