テンプレートタグ/wp page menu

テンプレートタグ wp_page_menu() は、WordPress ページ をリンクとしてリスト表示します。そして表示されるページに ホーム を自動的に追加することができます。このタグは、サイドバーのカスタマイズ/en あるいは ヘッダの設計/en をカスタマイズするのに便利ですし、他の テンプレート でも使用されているかもしれません。

この テンプレートタグ は、 WordPress バージョン 2.7 以降で利用可能です。

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

$defaults = array(
    'sort_column' => 'post_title',
    'menu_class'  => 'menu',
    'echo'        => true,
    'link_before' => '',
    'link_after'  => '');

デフォルトの設定は以下の通りです。

• タイトルでソート
• div class は 'menu'
• 出力を返す(表示)
• リンク前後のテキストなし
• ページリストに "ホーム" を追加しない(上のデフォルト設定では表記されていません)
• 注意：出力は <ul> と </ul> タグで囲まれます。

 wp_page_menu();

次の例は、表示されるページリストに "ホーム" を追加します。さらに、ページは div 要素で括られ、Page ID 5, 9, および 23 は表示されず、ページ順に表示されます。このリストには、 "Page Menu" というタイトルが付けられます。

<h2>Page Menu</h2>
<?php wp_page_menu('show_home=1&exclude=5,9,23&menu_class=page-navi&sort_column=menu_order'); ?>

次の例は、"ホーム" だけを表示します。include=99999' が存在しない Page ID を示すので、ホームへのリンクのみが表示されます。

<?php wp_page_menu('show_home=1&include=9999); ?>

sort_column (文字列)

ページタイトルのアルファベット順でソートします。初期値は ページタイトルのアルファベット順でソート。sort_column パラメータは、WordPress データベースの wp_post table にある任意のフィールドのディスクリプタを用いることができます。以下に便利な例を示します。

• 'post_title' - (タイトルの) アルファベット順でソート。初期値
• 'menu_order' - ページ順でソート。Page Order と Page ID とは異なることに注意してください。Page ID は、WordPress がすべての投稿とページに割り当てる一意の番号です。Page Order は管理パネルでユーザーが設定することができます。(管理パネル > ページ > 編集/en)
• 'post_date' - 投稿日時でソート。
• 'post_modified' - 最終更新日時でソート。
• 'ID' - Page ID でソート。
• 'post_author' - 著者の ID 番号でソート.
• 'post_name' - 投稿 slug のアルファベット順でソート。

menu_class (文字列)

リストを表示をする div class。初期値はmenu。

echo (真偽値)

リストを表示する（True）か、PHP 文字列として使えるようにリストの値を返す（False）か。初期値は0 (リストの値を返す)。有効な値:

• 0 (false) - 初期値
• 1 (true)

show_home (真偽値)

ページリストの先頭に"ホーム"を追加するか。"ホーム"の URL は、管理パネル > 設定 > 一般設定 の ブログのアドレス(URL) が用いられます。初期値は 0 ("ホーム"をリストに表示しなt)。有効な値:

• 0 (false) - 初期値
• 1 (true)

link_before (文字列)

<a> タグ内のリンクテキストの前につける文字列を設定。

link_after (文字列)

<a> タグ内のリンクテキストの後につける文字列を設定。

変更履歴

• 2.7 : 新規テンプレートタグ

wp_title, get_posts, query_posts, the_search_query

テンプレート:Copyedit

最新英語版： WordPress Codex » Template Tags/wp_page_menu （最新版との差分）