wp_nav_menu

Filter Hook

Description

Filters the HTML content for navigation menus.

Hook Information

File Location	`wp-includes/nav-menu-template.php` View on GitHub
Hook Type	Filter
Line Number	`307`

Hook Parameters

Type	Name	Description
`string`	`$nav_menu`	The HTML content for the navigation menu.
`stdClass`	`$args`	An object containing wp_nav_menu() arguments.

Usage Examples

Basic Usage

<?php
// Hook into wp_nav_menu
add_filter('wp_nav_menu', 'my_custom_filter', 10, 2);

function my_custom_filter($nav_menu, $args) {
    // Your custom filtering logic here
    return $nav_menu;
}

Source Code Context

wp-includes/nav-menu-template.php:307 - How this hook is used in WordPress core

<?php
 302  	 * @see wp_nav_menu()
 303  	 *
 304  	 * @param string   $nav_menu The HTML content for the navigation menu.
 305  	 * @param stdClass $args     An object containing wp_nav_menu() arguments.
 306  	 */
 307  	$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );
 308  
 309  	if ( $args->echo ) {
 310  		echo $nav_menu;
 311  	} else {
 312  		return $nav_menu;

PHP Documentation

<?php
/**
	 * Filters the HTML content for navigation menus.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param string   $nav_menu The HTML content for the navigation menu.
	 * @param stdClass $args     An object containing wp_nav_menu() arguments.
	 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/nav-menu-template.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.