- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「関数リファレンス/wp get nav menu items」の版間の差分
提供: WordPress Codex 日本語版
< 関数リファレンス
(和訳完了。) |
|||
| 4行目: | 4行目: | ||
== 説明 == | == 説明 == | ||
</div> | </div> | ||
| − | + | [[Administration Panels#Appearance|管理画面→外観]] → [[Appearance Menus SubPanel|メニュー]] パネル内に作られたナビゲーションメニューのアイテムを返す関数です。 | |
| − | + | この関数は、メニュー名、スラッグ、IDなど、ナビゲーションメニューのアイテムを返します。返されるメニューアイテムは、通常の投稿やページを参照している、関係する <i>nav_menu_item</i> タイプの投稿です。 | |
| − | + | ||
<div id="Usage"> | <div id="Usage"> | ||
| 29行目: | 28行目: | ||
== パラメータ == | == パラメータ == | ||
</div> | </div> | ||
| − | {{Parameter|$menu|string| | + | {{Parameter|$menu|string|メニューID}} |
| − | + | nav menu location は有効な引数ではありません。 | |
| − | {{Parameter|$args|array| | + | {{Parameter|$args|array|オプションの引数|optional}} |
<div id="Return Values"> | <div id="Return Values"> | ||
== 戻り値 == | == 戻り値 == | ||
</div> | </div> | ||
| − | + | インデックス化された WP_Post オブジェクトの配列 (メニューアイテムが無い場合は空) もしくは、booleanのfalseを返します。 | |
| − | + | ||
| − | + | ||
| − | + | ||
| + | <div id="Examples"> | ||
| + | == 使用例 == | ||
| + | </div> | ||
| + | <div id="Building simple menu list"> | ||
| + | === シンプルなメニューリストを作る例 === | ||
| + | </div> | ||
<pre> | <pre> | ||
| − | // | + | // $menu_name から nag menu を取得します。 |
| − | // | + | // (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 （最新版との差分）
関数リファレンス、テンプレートタグ目次もご覧ください。
