wppaste
WordPress

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

Since
3.9.0
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.

Compatibility

WordPress
since 3.9.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$outputstring|null
Nav menu output to short-circuit with. Default null.
$argsstdClass
An object containing wp_nav_menu() arguments.

Where this hook fires · 1

  • wp-includes/nav-menu-template.php:118wp_nav_menu()

Source code

View on Trac View on GitHub 

	 *	 * @see wp_nav_menu()	 *	 * @param string|null $output Nav menu output to short-circuit with. Default null.	 * @param stdClass    $args   An object containing wp_nav_menu() arguments.	 */	$nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args ); 	if ( null !== $nav_menu ) {		if ( $args->echo ) {			echo $nav_menu;			return;		}

Changelog

Introduced in 3.9.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.