pre_wp_nav_menu
Filter HookDescription
Filters whether to short-circuit the wp_nav_menu() output. 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.Hook Information
File Location |
wp-includes/nav-menu-template.php
View on GitHub
|
Hook Type | Filter |
Line Number | 118 |
Hook Parameters
Type | Name | Description |
---|---|---|
string|null
|
$output
|
Nav menu output to short-circuit with. Default null. |
stdClass
|
$args
|
An object containing wp_nav_menu() arguments. |
Usage Examples
Basic Usage
<?php
// Hook into pre_wp_nav_menu
add_filter('pre_wp_nav_menu', 'my_custom_filter', 10, 2);
function my_custom_filter($output, $args) {
// Your custom filtering logic here
return $output;
}
Source Code Context
wp-includes/nav-menu-template.php:118
- How this hook is used in WordPress core
<?php
113 * @see wp_nav_menu()
114 *
115 * @param string|null $output Nav menu output to short-circuit with. Default null.
116 * @param stdClass $args An object containing wp_nav_menu() arguments.
117 */
118 $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
119
120 if ( null !== $nav_menu ) {
121 if ( $args->echo ) {
122 echo $nav_menu;
123 return;
PHP Documentation
<?php
/**
* Filters whether to short-circuit the wp_nav_menu() output.
*
* 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.
*
* @since 3.9.0
*
* @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.
*/
Quick Info
- Hook Type: Filter
- Parameters: 2
- File: wp-includes/nav-menu-template.php
Related Hooks
Related hooks will be displayed here in future updates.