云策 WordPress 开发者社区

钩子文档

pre_wp_nav_menu

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

概述

pre_wp_nav_menu 是一个 WordPress 过滤器，用于在 wp_nav_menu() 输出前进行短路处理。如果过滤器返回非空值，将直接输出或返回该值，跳过默认的菜单生成逻辑。

关键要点

  • 过滤器名称：pre_wp_nav_menu
  • 作用：短路 wp_nav_menu() 输出，返回非空值时直接使用该值
  • 参数：$output（默认 null）和 $args（包含 wp_nav_menu() 参数的对象）
  • 相关函数：wp_nav_menu()
  • 引入版本：3.9.0

代码示例

$nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
📄 原文内容

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.

See also

Parameters

$outputstring|null
Nav menu output to short-circuit with. Default null.
$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( 'pre_wp_nav_menu', null, $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.9.0 Introduced.