widget_nav_menu_args

Filters the arguments for the Custom Menu widget.

Description

apply_filters( 'widget_nav_menu_args', (array) $nav_menu_args, (WP_Term) $nav_menu, (array) $args, (array) $instance ); 

Parameters (4)

0. $nav_menu_args (array)

1. $nav_menu (WP_Term)

Nav menu object for the current menu.

2. $args (array)

Display arguments for the current widget.

3. $instance (array)

Array of settings for the current widget.

Usage

To run the hook, copy the example below.

$nav_menu_args = apply_filters( 'widget_nav_menu_args', $nav_menu_args, $nav_menu, $args, $instance ); 
                         
if ( !empty( $nav_menu_args ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the widget_nav_menu_args callback 
function filter_widget_nav_menu_args( $nav_menu_args, $nav_menu, $args, $instance ) { 
    // make filter magic happen here... 
    return $nav_menu_args; 
}; 
         
// add the filter 
add_filter( 'widget_nav_menu_args', 'filter_widget_nav_menu_args', 10, 4 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'widget_nav_menu_args', 'filter_widget_nav_menu_args', 10, 4 );