云策 WordPress 开发者社区

钩子文档

nav_menu_item_args

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

概述

nav_menu_item_args 是一个 WordPress 过滤器，用于修改单个导航菜单项的参数。它允许开发者在生成菜单项时自定义其输出和行为。

关键要点

  • 过滤器名称：nav_menu_item_args，用于过滤单个菜单项的参数。
  • 参数：$args（stdClass 对象，包含 wp_nav_menu() 的参数）、$menu_item（WP_Post 对象，菜单项数据）、$depth（整数，菜单项深度）。
  • 用途：常用于自定义菜单项的 HTML 结构、类名、ID 等，例如通过 Walker_Nav_Menu::start_el() 调用。
  • 引入版本：WordPress 4.4.0。

代码示例

$args = apply_filters( 'nav_menu_item_args', $args, $menu_item, $depth );
📄 原文内容

Filters the arguments for a single nav menu item.

Parameters

$argsstdClass
An object of 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'.

$menu_itemWP_Post
Menu item data object.
$depthint
Depth of menu item. Used for padding.

Source

$args = apply_filters( 'nav_menu_item_args', $args, $menu_item, $depth );

View all references View on Trac View on GitHub

Used by Description
Walker_Nav_Menu::start_el()wp-includes/class-walker-nav-menu.php

Starts the element output.

Changelog

Version Description
4.4.0 Introduced.