• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/wp dropdown pages

提供: WordPress Codex 日本語版
移動先: 案内検索

送信ボタンのない、ページのリストのセレクトボックス (つまり、ドロップダウン) を表示します。

使い方

<?php wp_dropdown_pages('arguments'); ?>

用例

初期設定での使用

$defaults = array('depth' => 0, 'child_of' => 0, 'selected' => 0, 
'echo' => 1,'name' => 'page_id', 'show_option_none' => '');

デフォルトでは以下のように動作します。

  • ページとサブページが親子関係をインデントして表示します
  • すべてのページを表示します (子ページに制限はありません)
  • 「selected」になっているページはなく、初期状態で選択されているページはありません
  • ドロップダウンには「page_id」という name がつけられます
  • 空の値を選択することはできません (show_option_none)
<?php wp_dropdown_pages(); ?>

送信ボタンのある階層ページのドロップダウンリストを HTML フォームに表示します。

<li id="pages">
 <h2><?php _e('pages:'); ?></h2>
   <form action="<?php bloginfo('url'); ?>" method="get">
   <?php wp_dropdown_pages(); ?>
   <input type="submit" name="submit" value="view" />
   </form>
</li>

パラメータ

depth 
(整数) このパラメータは wp_list_pages で表示されるリストに含めるページの階層レベルを設定します。デフォルト値は 0 です (すべてのページとサブページを表示します)。
  • 0 - ページとサブページを親子関係を維持して (インデントして) 表示します (デフォルト)
  • -1 - ページとサブページを同列に (インデントなし) 表示します
  • 1 - トップレベルのページのみ表示します
  • 2 - 2 (またはそれ以上) の深さ (レベル) のページを表示します
child_of 
(整数) ページ ID を値としてそのページのサブページを表示します。デフォルト値は 0 です (すべてのページを表示)。
selected 
(整数) 該当する ID のページを「selected」にし、初期状態でそのページが選択された状態になります。デフォルトではどのページも選択されていません。
echo 
(論理値) ページリストを表示するか、PHP で使うために HTML テキストとして返すかを設定します。デフォルト値は 1 (リストを表示) です。
  • 1 (true) - デフォルト
  • 0 (false)
name 
(文字列) ドロップダウンの name を設定します。デフォルトは「page_id」です
show_option_none 
(文字列) ドロップダウンに空の値の項目を表示します
exclude 
(string) リストから除外したいページの ID をコンマで区切ったリストで定義します。例えば、「exclude=4,12」はページ ID が 4 と 12 のページが表示または返されません。デフォルトでは除外されるページはありません。

上記以外のパラメータ

推奨しませんが、 get_pages ファンクションにあるいくつかのパラメータを wp_dropdown_pages でも使うことができます。以下が get_pages のパラメータの初期設定です。

$defaults = array('child_of' => 0, 'sort_order' => 'ASC', 'sort_column' => 'post_title',
'hierarchical' => 1, 'exclude' => '', 'include' => '', 'meta_key' => '', 'meta_value' => '', 'authors' => '');

記事

コードドキュメンテーション

  • クラス: WP_Query - WP_Query クエリの詳細概要
  • オブジェクト: $wpdb - $wpdb オブジェクトの使い方概要
  • 関数: get_query_var()
  • 関数: query_posts() - 追加カスタムクエリの作成
  • 関数: get_post() - 項目の ID を使ってその投稿のレコードをデータベースから取得する
  • 関数: get_posts() - 項目の配列を返す特別な関数。
  • 関数: get_pages() - ページの配列を返す特別な関数。
  • 関数: have posts() - クエリが記事を返すかどうか判断する条件分岐。
  • 関数: the_post() - クエリの後に自動的にループを設定するのに使われる。
  • 関数: rewind_posts() - 現在のループをクリアする。
  • 関数: setup_postdata() - ループ内で単一クエリ結果のデータを設定する。
  • 関数: wp_reset_postdata() - 以前のクエリを復元する(通常、ループ内のもう一つのループで使われる)。
  • 関数: wp_reset_query()
  • 関数: is_main_query() - 変更するのがメインクエリであるよう保証する。
  • アクションフック: pre_get_posts - 実行される前に WordPress クエリを変更する。
  • アクションフック: the_post - 投稿オブジェクトをクエリの後に変更する。
  • フィルターフック: found_posts - found_posts WP_Query オブジェクトの値を変更する


関連

固定ページ: get_all_page_ids(), get_ancestors(), get_page_link(), get_page_by_path(), get_page_by_title(), get_page_children(), get_page_hierarchy(), get_page_uri() /en, get_pages(), is_page(), page_uri_index() /en, wp_list_pages(), wp_page_menu()


リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


テンプレートタグへのクエリ文字列型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Template Tags/wp_dropdown_pages最新版との差分