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

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

「関数リファレンス/wp get nav menu items」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(和訳完了。)
4行目: 4行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
Returns the items from a navigation menu created in the [[Administration Panels#Appearance|Appearance]] → [[Appearance Menus SubPanel|Menus]] panel.
+
[[Administration Panels#Appearance|管理画面→外観]] → [[Appearance Menus SubPanel|メニュー]] パネル内に作られたナビゲーションメニューのアイテムを返す関数です。
 
+
この関数は、メニュー名、スラッグ、IDなど、ナビゲーションメニューのアイテムを返します。返されるメニューアイテムは、通常の投稿やページを参照している、関係する <i>nav_menu_item</i> タイプの投稿です。
Given a menu name, id or slug, the function returns the menu items from that navigation menu. The menu items returned are in fact the actual <i>nav_menu_item</i> type posts which contain references to the normal posts/pages they are associated with.
+
  
 
<div id="Usage">
 
<div id="Usage">
29行目: 28行目:
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$menu|string|Menu ID}}  
+
{{Parameter|$menu|string|メニューID}}  
The nav menu location is not a valid argument.
+
nav menu location は有効な引数ではありません。
{{Parameter|$args|array|Optional arguments|optional}}
+
{{Parameter|$args|array|オプションの引数|optional}}
  
 
<div id="Return Values">
 
<div id="Return Values">
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
Indexed array of WP_Post objects (empty if the menu contains no items) or bool false.
+
インデックス化された WP_Post オブジェクトの配列 (メニューアイテムが無い場合は空) もしくは、booleanのfalseを返します。
 
+
== Examples ==
+
=== Building simple menu list ===
+
  
 +
<div id="Examples">
 +
== 使用例 ==
 +
</div>
 +
<div id="Building simple menu list">
 +
=== シンプルなメニューリストを作る例 ===
 +
</div>
 
<pre>
 
<pre>
     // Get the nav menu based on $menu_name (same as 'theme_location' or 'menu' arg to wp_nav_menu)
+
     // $menu_name から nag menu を取得します。
     // This code based on wp_nav_menu's code to get Menu ID from menu slug
+
    // (wp_nav_menu への 'theme_location' 'menu' 引数と同じです)
 +
     // このコードは、メニュースラッグからメニュー ID を取得する wp_nav_menu のコードを元にしています。
  
 
     $menu_name = 'custom_menu_slug';
 
     $menu_name = 'custom_menu_slug';
66行目: 69行目:
 
</pre>
 
</pre>
  
 +
<div id="Change Log">
 
== 改訂履歴 ==
 
== 改訂履歴 ==
 
</div>
 
</div>

2013年8月11日 (日) 09:15時点における版

このページ「関数リファレンス/wp get nav menu items」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

管理画面→外観メニュー パネル内に作られたナビゲーションメニューのアイテムを返す関数です。 この関数は、メニュー名、スラッグ、IDなど、ナビゲーションメニューのアイテムを返します。返されるメニューアイテムは、通常の投稿やページを参照している、関係する nav_menu_item タイプの投稿です。

使用法

<?php $items = wp_get_nav_menu_items( $menu, $args ); ?>

デフォルトの使用法

<?php $args = array(
       'order'                  => 'ASC',
       'orderby'                => 'menu_order',
       'post_type'              => 'nav_menu_item',
       'post_status'            => 'publish',
       'output'                 => ARRAY_A,
       'output_key'             => 'menu_order',
       'nopaging'               => true,
       'update_post_term_cache' => false ); ?>%%%

パラメータ

$menu
string) (必須) メニューID
初期値: なし

nav menu location は有効な引数ではありません。

$args
array) (optional) オプションの引数
初期値: なし

戻り値

インデックス化された WP_Post オブジェクトの配列 (メニューアイテムが無い場合は空) もしくは、booleanのfalseを返します。

使用例

シンプルなメニューリストを作る例

    // $menu_name から nag menu を取得します。 
    // (wp_nav_menu への 'theme_location' や 'menu' 引数と同じです)
    // このコードは、メニュースラッグからメニュー ID を取得する wp_nav_menu のコードを元にしています。

    $menu_name = 'custom_menu_slug';

    if ( ( $locations = get_nav_menu_locations() ) && isset( $locations[ $menu_name ] ) ) {
	$menu = wp_get_nav_menu_object( $locations[ $menu_name ] );

	$menu_items = wp_get_nav_menu_items($menu->term_id);

	$menu_list = '<ul id="menu-' . $menu_name . '">';

	foreach ( (array) $menu_items as $key => $menu_item ) {
	    $title = $menu_item->title;
	    $url = $menu_item->url;
	    $menu_list .= '<li><a href="' . $url . '">' . $title . '</a></li>';
	}
	$menu_list .= '</ul>';
    } else {
	$menu_list = '<ul><li>Menu "' . $menu_name . '" not defined.</li></ul>';
    }
    // $menu_list now ready to output

改訂履歴

  • 3.0.0 にて導入されました。

ソースファイル

wp_get_nav_menu_items()wp-includes/nav-menu.php にあります。

ナビゲーションメニュー: register_nav_menus(), register_nav_menu(), unregister_nav_menu() /en , has_nav_menu(), wp_nav_menu(), wp_get_nav_menu_items()

最新英語版: WordPress Codex » Function Reference/wp get nav menu items最新版との差分


関数リファレンステンプレートタグ目次もご覧ください。