wp_nav_menu_objects

Filters the sorted list of menu item objects before generating the menu's HTML.

Description

apply_filters( 'wp_nav_menu_objects', (array) $sorted_menu_items, (stdClass) $args ); 

Parameters (2)

0. $sorted_menu_items (array)
The menu items, sorted by each menu item's menu order.
1. $args (stdClass)
An object containing wp_nav_menu() arguments.

Usage

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

Defined (1)

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

/wp-includes/nav-menu-template.php  
  1. $sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );