wp_get_nav_menus

（3.0.0以降）
wp_get_nav_menus - すべてのナビゲーションメニュー情報を取得する

説明

array wp_get_nav_menus( [ array $args = array() ] )
すべてのナビゲーションメニュー情報を取得する。

パラメータ

  • $args
    パラメータを連想配列で指定（省略時はarray()）。主なキーは次の通り。
    キー意味省略時の値
    'hide_empty'投稿記事がないものを取得しない場合はtrueを指定false
    'orderby'ソート対象を指定[4.1.0]'name'。それより前は'none'

返り値

ナビゲーションメニュー情報（オブジェクト）の配列を返す。

注意

パラメータ$argsは get_terms関数に引き継がれ、連想配列のキーは共通である。なおソート対象の$args['orderby']の省略時の値は、4.1.0から'name'に変更されている。

使用例

  • すべてのナビゲーションメニュー情報を取得する。
    <?php $menus = wp_get_nav_menus(); ?>
  • すべてのナビゲーションメニュー情報をスラッグ順で取得する。
    <?php $menus = wp_get_nav_menus( array( 'orderby'=>'slug' ) ); ?>

フィルター

[3.0.0]ナビゲーションメニュー情報を返す前に'wp_get_nav_menus'フィルターを呼び出す。パラメータ$menusにはナビゲーションメニュー情報の配列が、$argsは本関数が受け取った内容が格納される。
return apply_filters( 'wp_get_nav_menus', $menus, $args );

アクション

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

ソースファイル

/wp-includes/nav-menu.php

最終更新 : 2018年05月27日 10:46

関連

参考

Code Reference: wp_get_nav_menus

お勧め

5.5で非推奨になる関数名について（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい（2013年11月27日 更新）

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）

query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？