apply_filters( 'pre_wp_nav_menu', string|null $output, stdClass $args )

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


Description

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

Top ↑

See also


Top ↑

Parameters

$output string|null
Nav menu output to short-circuit with. Default null.
$args stdClass
An object containing wp_nav_menu() arguments.
More Arguments from wp_nav_menu( ... $args ) Array of nav menu arguments.
  • menuint|string|WP_Term
    Desired menu. Accepts a menu ID, slug, name, or object.
  • menu_classstring
    CSS class to use for the ul element which forms the menu.
    Default 'menu'.
  • menu_idstring
    The ID that is applied to the ul element which forms the menu.
    Default is the menu slug, incremented.
  • containerstring
    Whether to wrap the ul, and what to wrap it with.
    Default 'div'.
  • container_classstring
    Class that is applied to the container.
    Default 'menu-{menu slug}-container'.
  • container_idstring
    The ID that is applied to the container.
  • container_aria_labelstring
    The aria-label attribute that is applied to the container when it's a nav element.
  • fallback_cbcallable|false
    If the menu doesn't exist, a callback function will fire.
    Default is 'wp_page_menu'. Set to false for no fallback.
  • beforestring
    Text before the link markup.
  • afterstring
    Text after the link markup.
  • link_beforestring
    Text before the link text.
  • link_afterstring
    Text after the link text.
  • echobool
    Whether to echo the menu or return it. Default true.
  • depthint
    How many levels of the hierarchy are to be included.
    0 means all. Default 0.
    Default 0.
  • walkerobject
    Instance of a custom walker class.
  • theme_locationstring
    Theme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user.
  • items_wrapstring
    How the list items should be wrapped. Uses printf() format with numbered placeholders. Default is a ul with an id and class.
  • item_spacingstring
    Whether to preserve whitespace within the menu's HTML.
    Accepts 'preserve' or 'discard'. Default 'preserve'.

Top ↑

Source

File: wp-includes/nav-menu-template.php. View all references

$nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );


Top ↑

Changelog

Changelog
Version Description
3.9.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.