wp_get_nav_menus

Filters the navigation menu objects being returned.

Description

apply_filters( 'wp_get_nav_menus', (array) $get_terms, (array) $args ); 

Parameters (2)

0. $get_terms (array) => get_terms( 'nav_menu', $args)
An array of menu objects.
1. $args (array)
An array of arguments used to retrieve menu objects.

Usage

To run the hook, copy the example below.
  1. $get_terms = apply_filters( 'wp_get_nav_menus', $get_terms, $args ); 
  2.  
  3. if ( !empty( $get_terms ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the wp_get_nav_menus callback 
  2. function filter_wp_get_nav_menus( $get_terms, $args ) { 
  3. // make filter magic happen here... 
  4. return $get_terms
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_get_nav_menus', 'filter_wp_get_nav_menus', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_get_nav_menus', 'filter_wp_get_nav_menus', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/nav-menu.php  
  1. return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu', $args), $args );