wp_get_nav_menu_object

Filter Hook

Description

Filters the nav_menu term retrieved for wp_get_nav_menu_object().

Hook Information

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

Hook Parameters

Type	Name	Description
`WP_Term\|false`	`$menu_obj`	Term from nav_menu taxonomy, or false if nothing had been found.
`int\|string\|WP_Term`	`$menu`	The menu ID, slug, name, or object passed to wp_get_nav_menu_object().

Usage Examples

Basic Usage

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

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

Source Code Context

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

<?php
  44  	 * @since 4.3.0
  45  	 *
  46  	 * @param WP_Term|false      $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
  47  	 * @param int|string|WP_Term $menu     The menu ID, slug, name, or object passed to wp_get_nav_menu_object().
  48  	 */
  49  	return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu );
  50  }
  51  
  52  /**
  53   * Determines whether the given ID is a navigation menu.
  54   *

PHP Documentation

<?php
/**
	 * Filters the nav_menu term retrieved for wp_get_nav_menu_object().
	 *
	 * @since 4.3.0
	 *
	 * @param WP_Term|false      $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
	 * @param int|string|WP_Term $menu     The menu ID, slug, name, or object passed to wp_get_nav_menu_object().
	 */

Quick Info

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

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.