wp_nav_menu:WordPress私的マニュアル

wp_nav_menu

(3.0.0以降)
wp_nav_menu - ナビゲーションメニューを表示する

説明

string wp_nav_menu( [ array $args = array() ] )

ナビゲーションメニューを表示する（パラメータ'echo'がtrueの場合）。パラメータ'echo'がfalseの場合は、ナビゲーションメニューの文字列（HTMLコード）を返す。

パラメータ

$args

検索条件を指定する連想配列。キーワードは次の通り。

キーワード	省略時の値	意味
menu	''	カスタムメニューのIDを指定
container	'div'	ナビゲーションメニューを囲むタグ名を指定
container_class	''	ナビゲーションメニューを囲むタグのクラス名を指定
container_id	''	ナビゲーションメニューを囲むタグのIDを指定
menu_class	'menu'	ナビゲーションメニューを囲むタグのクラス名を指定
menu_id	''	ナビゲーションメニューを囲むタグのIDを指定
echo	true	ナビゲーションメニューを表示する場合はtrue、文字列として取得する場合はfalseを指定
fallback_cb	'wp_page_menu'	メニューが存在しない場合に実行するコールバック関数名を指定（wp_page_menu）
before	''	メニューのリンク（aタグ）の前に出力する文字列を指定
after	''	メニューのリンク（aタグ）の後に出力する文字列を指定
link_before	''	メニューの文字列の前に出力する文字列を指定
link_after	''	メニューの文字列の後に出力する文字列を指定
items_wrap	'<ul id="%1$s" class="%2$s">%3$s</ul>'	[3.1.0]メニューリストのパターンを指定
depth	0	階層数を指定（0はすべてを表示、1ならばメニューバーのみ）。
walker	''	コールバック関数名を指定
theme_locaution	''	テーマ内のロケーションIDを指定。

返り値

パラメータ'echo'がtrueの場合は何も返さない。パラメータ'echo'がfalseの場合はメニュータグの文字列を返す。

注意

カスタムメニューを使用しない場合と使用する場合とでは、出力されるタグの構造が微妙に異なる。

使用例

ナビゲーションメニューを表示する。
<?php wp_nav_menu( array( 'container_class' => 'menu-header', 'theme_locaution' => 'primary' ) ); ?>
ナビゲーションメニューを取得する。
<?php $nav = wp_nav_menu( array( 'container_class' => 'menu-header', 'theme_locaution' => 'primary', 'echo' => false ) ); ?>

フィルター

[3.0.0]受け取ったパラメータと標準値をマージ後、'wp_nav_menu_args'フィルターを呼び出す。パラメータ$argsには標準値とマージ済みの引数が格納された連想配列となる。

$args = apply_filters( 'wp_nav_menu_args', $args );

[3.9.0]メニューHTMLを高速生成に対応するため'pre_wp_nav_menu'フィルターを呼び出す。パラメータ$outputは標準でnull、$argsには標準値とマージ済みの引数が格納された連想配列となる。

$nav_menu = apply_filters( 'pre_wp_nav_menu', $output, $args );

[3.0.0]メニューHTMLのコンテナ部分で使用できるタグを調べるため、'wp_nav_menu_container_allowedtags'フィルターを呼び出す。パラメータ$tagsはタグの配列で標準では array( 'div', 'nav' ) が格納されている。

$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', $tags );

[3.1.0]メニューアイテムHTMLの生成前に'wp_nav_menu_objects'フィルターを呼び出す。パラメータ$sorted_menu_itemsにはソート済みのメニューアイテム情報の配列、$argsには標準値とマージ済みの引数が格納された連想配列となる。

$sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );

[3.0.0]メニューHTMLの生成前に'wp_nav_menu_items'フィルターを呼び出す。パラメータ$itemsにはメニューアイテムHTML、$argsには標準値とマージ済みの引数が格納された連想配列となる。

$items = apply_filters( 'wp_nav_menu_items', $items, $args );

[3.0.0]'wp_nav_menu_items'フィルターの直後に'wp_nav_menu_{$menu->slug}_items'フィルターを呼び出す。特定のメニューのみ操作する場合はこちらを使用するのが便利。パラメータ$itemsにはメニューアイテムHTML、$argsには標準値とマージ済みの引数が格納された連想配列となる。

$items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );

[3.0.0]メニューHTMLを出力する直前に'wp_nav_menu'フィルターを呼び出す。パラメータ$nav_menuにはメニューHTML、$argsには標準値とマージ済みの引数が格納された連想配列となる。

$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/nav-menu-template.php

参考

Code Reference: wp_nav_menu

wp_nav_menu

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

参考

お勧めコンテンツ