Filters a menu item’s starting output.

Description

The menu item’s starting output only includes $args->before, the opening <a>, the menu item’s title, the closing </a>, and $args->after. Currently, there is no filter for modifying the opening and closing <li> for a menu item.

Parameters

$item_outputstring

The menu item’s starting HTML output.

$menu_itemWP_Post

Menu item data object.

$depthint

Depth of menu item. Used for padding.

$argsstdClass

An object of wp_nav_menu() arguments.

More Arguments from wp_nav_menu( … $args )

Array of nav menu arguments.

• menu int|string|WP_Term
  Desired menu. Accepts a menu ID, slug, name, or object.
  
• menu_class string
  CSS class to use for the ul element which forms the menu.
  Default 'menu'.
• menu_id string
  The ID that is applied to the ul element which forms the menu.
  Default is the menu slug, incremented.
• container string
  Whether to wrap the ul, and what to wrap it with.
  Default 'div'.
• container_class string
  Class that is applied to the container.
  Default ‘menu-{menu slug}-container’.
• container_id string
  The ID that is applied to the container.
• container_aria_label string
  The aria-label attribute that is applied to the container when it’s a nav element.
• fallback_cb callable|false
  If the menu doesn’t exist, a callback function will fire.
  Default is 'wp_page_menu'. Set to false for no fallback.
• before string
  Text before the link markup.
• after string
  Text after the link markup.
• link_before string
  Text before the link text.
• link_after string
  Text after the link text.
• echo bool
  Whether to echo the menu or return it. Default true.
• depth int
  How many levels of the hierarchy are to be included.
  0 means all. Default 0.
  Default 0.
• walker object
  Instance of a custom walker class.
• theme_location string
  Theme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user.
• items_wrap string
  How the list items should be wrapped. Uses printf() format with numbered placeholders. Default is a ul with an id and class.
• item_spacing string
  Whether to preserve whitespace within the menu’s HTML.
  Accepts 'preserve' or 'discard'. Default 'preserve'.

Source

$output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $menu_item, $depth, $args );

View all references View on Trac View on GitHub

Changelog