pre_wp_nav_menu

Filters whether to short-circuit the wp_nav_menu() output.

Description

apply_filters( 'pre_wp_nav_menu', (null) $null, (stdClass) $args ); 

Returning a non-null value to the filter will short-circuit wp_nav_menu(), echoing that value if $args->echo is true, returning that value otherwise.

Parameters (2)

0. $null (null) => null
Nav menu output to short-circuit with. Default null.
1. $args (stdClass)
An object containing wp_nav_menu() arguments.

Usage

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

Defined (1)

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

/wp-includes/nav-menu-template.php  
  1. $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );