云策 WordPress 开发者社区

钩子文档

wp_nav_menu

查看官方原文 ↗
💡 云策文档标注

概述

wp_nav_menu 是一个 WordPress 过滤器，用于修改导航菜单的 HTML 输出内容。它允许开发者在菜单渲染前自定义其结构和样式。

关键要点

  • 过滤器名称：wp_nav_menu，用于过滤导航菜单的 HTML 内容。
  • 参数：$nav_menu（菜单 HTML 字符串）和 $args（包含 wp_nav_menu() 参数的对象）。
  • 相关函数：与 wp_nav_menu() 函数紧密关联，用于显示导航菜单。
  • 引入版本：WordPress 3.0.0。

注意事项

  • 参数 $args 包含多个配置项，如 menu、menu_class、container、depth 等，用于控制菜单的显示和行为。
  • 使用此过滤器时，需确保正确处理 $nav_menu 和 $args 参数，以避免破坏菜单功能。
📄 原文内容

Filters the HTML content for navigation menus.

Description

See also

Parameters

$nav_menustring
The HTML content for the navigation menu.
$argsstdClass
An object containing 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'.

Source

$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );

View all references View on Trac View on GitHub

Used by Description
wp_nav_menu()wp-includes/nav-menu-template.php

Displays a navigation menu.

Changelog

Version Description
3.0.0 Introduced.