apply_filters( 'wp_nav_menu_args', array $args )

Filters the arguments used to display a navigation menu.

Contents

Description

Top ↑

See also

Top ↑

Parameters

$args array
Array 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'.

Top ↑

More Information

The “wp_nav_menu_args” filter is applied to the arguments of the wp_nav_menu() function before they are processed.

This filter can be used in functions.php of a child theme to add/remove/modify the arguments of a menu defined in the parent theme.

Also, plugins can use this filter to change menus by adding classes/IDs or using a custom walker object.

Top ↑

Source

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

$args = apply_filters( 'wp_nav_menu_args', $args );

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by megamenu —

    The following code will populate the “theme_location” option if it was not specified (or was left empty) in the initial call to “wp_nav_menu”.

    function wp_nav_menu_populate_missing_theme_location( $args ) {
	if ( ! isset( $args['theme_location'] ) || $args['theme_location'] == "" ) {
		$args['theme_location'] = 'main_navigation';
	}
	
	return $args;
}
add_filter( 'wp_nav_menu_args', 'wp_nav_menu_populate_missing_theme_location' );
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Steven Lin —

    Example migrated from Codex:

    The Twenty Thirteen theme defines the following menu in its header.php file.

    <?php wp_nav_menu( array( 'theme_location' => 'primary', 'menu_class' => 'nav-menu' ) ); ?>

    The following example code will add an ID to the container and change the “depth” to -1 so that links at all levels are displayed in a single, flat list.

    add_filter( 'wp_nav_menu_args', 'modify_nav_menu_args' );

function modify_nav_menu_args( $args )
{
	if( 'primary' == $args['theme_location'] )
	{
		$args['depth'] = -1;
		$args['container_id'] = 'my_primary_menu';
	}

	return $args;
}

    The container ID will only show up if you set a menu for this theme location.

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