当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「テンプレートタグ/wp page menu」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(15:14, December 17, 2008 MichaelH 版に更新)
(サイドバーのカスタマイズ、ヘッダの設計、日本語ページ無(ページ名は「WordPress サイトデザイン リファレンス」から): アルファベット順でソートは、日本語はあいうえお順?)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
 
<div id="Description">
 
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
The Template Tag, [[テンプレートタグ/wp_page_menu|wp_page_menu()]], displays a list of WordPress [[Pages]] as links, and affords the opportunity to have '''Home''' added automatically to the list of Pages displayed.  This Tag is useful to customize the [[Customizing Your Sidebar|Sidebar]]/[[:en:Customizing Your Sidebar|en]] or [[Designing Headers|Header]]/[[:en:Designing Headers|en]], but may be used in other [[テンプレート|Templates]] as well.
+
テンプレートタグ [[テンプレートタグ/wp_page_menu|wp_page_menu()]] は、WordPress [[ページ]] をリンクとしてリスト表示します。そして表示されるページに '''ホーム''' を自動的に追加することができます。このタグは、[[サイドバーのカスタマイズ]]/[[:en:Customizing Your Sidebar|en]] あるいは [[ヘッダの設計]]/[[:en:Designing Headers|en]] をカスタマイズするのに便利ですし、他の [[テンプレート]] でも使用されているかもしれません。
  
This [[テンプレートタグ|Template Tag]] is available for WordPress versions 2.7 and newer.
+
この [[テンプレートタグ]] は、 WordPress バージョン 2.7 以降で利用可能です。
  
 
<div id="Usage">
 
<div id="Usage">
18行目: 18行目:
  
 
<div id="Default_Usage">
 
<div id="Default_Usage">
===Default Usage===
+
===デフォルトでの使い方===
 
</div>
 
</div>
  
28行目: 28行目:
 
     'link_after'  => '');</pre>
 
     'link_after'  => '');</pre>
  
By default, the usage shows:
+
デフォルトの設定は以下の通りです。
 
+
* Sorted by title
+
* The div class is 'menu'
+
* Results are echoed (displayed)
+
* No link_before or link_after text
+
* Do not add "Home" to the list of pages (this is not shown in defaults above)
+
* Note: Output is encompassed by the <tt><nowiki><ul></nowiki></tt> and <tt><nowiki></ul></nowiki></tt> tags
+
  
 +
* タイトルでソート
 +
* div class は 'menu'
 +
* 出力を返す(表示)
 +
* リンク前後のテキストなし
 +
* ページリストに "ホーム" を追加しない(上のデフォルト設定では表記されていません)
 +
* 注意:出力は <tt><nowiki><ul></nowiki></tt> と <tt><nowiki></ul></nowiki></tt> タグで囲まれます。
 +
<pre>
 
  wp_page_menu();
 
  wp_page_menu();
 +
</pre>
  
 
<div id="Display Home as a Page">
 
<div id="Display Home as a Page">
=== Display Home as a Page ===
+
=== ページリストにホームを表示する ===
 
</div>
 
</div>
The following example causes "Home" to be added to the beginning of the list of Pages displayed. In addition, the Pages wrapped in a div element, Page IDs 5, 9, and 23, are excluded from the list of Pages displayed, and the pages are listed in Page Order.  The list is prefaced with the title, "Page Menu",
+
次の例は、表示されるページリストに "ホーム" を追加します。さらに、ページは div 要素で括られ、Page ID 5, 9, および 23 は表示されず、ページ順に表示されます。このリストには、 "Page Menu" というタイトルが付けられます。
  
 
<pre>
 
<pre>
50行目: 51行目:
  
 
<div id="Display_only_Home">
 
<div id="Display_only_Home">
=== Display only Home===
+
=== ホームのみを表示する ===
 
</div>
 
</div>
The following example displays just a link to "Home".  Note that the '''include=99999'''' references a Page ID that does not exist so only a link for Home is displayed.
+
次の例は、"ホーム" だけを表示します。'''include=99999'''' が存在しない Page ID を示すので、ホームへのリンクのみが表示されます。<!-- 文中は99999だが、例では9999。 原文のまま。Mizuno -->
  
 
<pre>
 
<pre>
62行目: 63行目:
 
</div>
 
</div>
  
; '''sort_column''' (''string''):Sorts the list of Pages in a alphabetic order by title of the pages. The default setting is ''sort alphabetically by page title''.  The '''sort_column''' parameter can be used to sort the list of Pages by the descriptor of any field in the [[データベース概要#Table: wp_posts|wp_post table]] of the WordPress database. Some useful examples are listed here.
+
; '''sort_column''' (''文字列''):ページタイトルのアルファベット順でソートします。<!--日本語はあいうえお順? Mizuno -->初期値は ''ページタイトルのアルファベット順でソート'''''sort_column''' パラメータは、WordPress データベースの [[データベース概要#Table: wp_posts|wp_post table]] にある任意のフィールドのディスクリプタを用いることができます。以下に便利な例を示します。
:* <tt>'post_title'</tt> - Sort Pages alphabetically (by title) - default
+
:* <tt>'post_title'</tt> - (タイトルの) アルファベット順でソート。初期値
:* <tt>'menu_order'</tt> - Sort Pages by Page Order.  Note the difference between ''Page Order'' and ''Page ID''.  The Page ID is a unique number assigned by WordPress to every post or page.  The Page Order can be set by the user in the administrative panel (e.g. [[管理パネル]] > [[管理パネル#Pages - Your Static Content|ページ]] > [[Pages Edit SubPanel|編集]]/[[:en:Pages Edit SubPanel|en]]).
+
:* <tt>'menu_order'</tt> - ページ順でソート。''Page Order'' ''Page ID'' とは異なることに注意してください。Page ID は、WordPress がすべての投稿とページに割り当てる一意の番号です。Page Order は管理パネルでユーザーが設定することができます。([[管理パネル]] > [[管理パネル#Pages - Your Static Content|ページ]] > [[Pages Edit SubPanel|編集]]/[[:en:Pages Edit SubPanel|en]])
:* <tt>'post_date'</tt> - Sort by creation time.
+
:* <tt>'post_date'</tt> - 投稿日時でソート。
:* <tt>'post_modified'</tt> - Sort by time last modified.
+
:* <tt>'post_modified'</tt> - 最終更新日時でソート。
:* <tt>'ID'</tt> - Sort by numeric Page ID.
+
:* <tt>'ID'</tt> - Page ID でソート。
:* <tt>'post_author'</tt> - Sort by the Page author's numeric ID.
+
:* <tt>'post_author'</tt> - 著者の ID 番号でソート.
:* <tt>'post_name'</tt> - Sort alphabetically by Post [[用語集#Slug|slug]].
+
:* <tt>'post_name'</tt> - 投稿 [[用語集#Slug|slug]] のアルファベット順でソート。
  
; '''menu_class''' (''string''):The div class the list is displayed in.  Defaults to '''menu'''.
+
; '''menu_class''' (''文字列''):リストを表示をする div class。初期値は'''menu'''
  
; '''echo''' (''boolean''):Toggles the display of the generated list of links or return the list as an HTML text string to be used in PHP. The default value is ''0'' (do NOT display the generated list items). Valid values:
+
; '''echo''' (''真偽値''):リストを表示する(True)か、PHP 文字列として使えるようにリストの値を返す(False)か。初期値は''0'' (リストの値を返す)。有効な値:
:* <tt>0 (false)</tt> - default
+
:* <tt>0 (false)</tt> - 初期値
 
:* <tt>1 (true)</tt>
 
:* <tt>1 (true)</tt>
  
; '''show_home''' (''boolean''): Add "Home" as the first item in the list of "Pages".  The URL assigned to "Home" is pulled from the '''Blog address (URL)''' in [[管理パネル]] > [[管理パネル#Settings - Configuration Settings|設定]] > [[Settings General SubPanel|一般設定]].  The default value is ''0'' (do NOT display "Home" in the generated list). Valid values:
+
; '''show_home''' (''真偽値''):ページリストの先頭に"ホーム"を追加するか。"ホーム"URL は、[[管理パネル]] > [[管理パネル#Settings - Configuration Settings|設定]] > [[Settings General SubPanel|一般設定]] の '''ブログのアドレス(URL)''' が用いられます。初期値は ''0'' ("ホーム"をリストに表示しなt)。有効な値:
:* <tt>0 (false)</tt> - default
+
:* <tt>0 (false)</tt> - 初期値
 
:* <tt>1 (true)</tt>
 
:* <tt>1 (true)</tt>
  
; '''link_before''' (''string''): Sets the text or html that proceeds the link text inside <a> tag.
+
; '''link_before''' (''文字列''): &lt;a&gt; タグ内のリンクテキストの前につける文字列を設定。
  
; '''link_after''' (''string''): Sets the text or html that follows the link text inside <a> tag.
+
; '''link_after''' (''文字列''): &lt;a&gt; タグ内のリンクテキストの後につける文字列を設定。
  
 
== 変更履歴 ==
 
== 変更履歴 ==
98行目: 99行目:
 
{{Copyedit}}
 
{{Copyedit}}
  
{{原文|Template Tags/wp page menu|65097}}<!-- 15:14, December 17, 2008 MichaelH 版 -->
+
{{原文|Template Tags/wp page menu}}
  
 
{{DEFAULTSORT:Wp_page_menu}}
 
{{DEFAULTSORT:Wp_page_menu}}

2009年1月14日 (水) 19:52時点における版

この項目「テンプレートタグ/wp page menu」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

テンプレートタグ 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 OrderPage 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_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()


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


この記事は翻訳時に編集が必要であるとマークされていました。その為Codex原文が大きく編集されている可能性があります。内容を確認される際は原文を参照していただき、可能であれば本項目へ反映させてください。よりよいCodexを作成するためのお手伝いをお願いします。

最新英語版: WordPress Codex » Template Tags/wp page menu