云策 WordPress 开发者社区

钩子文档

nav_menu_item_attributes

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

概述

nav_menu_item_attributes 是一个 WordPress 过滤器钩子，用于修改导航菜单项列表元素（如 <li>）的 HTML 属性。它允许开发者在菜单项输出时动态调整其属性，如 class 和 id。

关键要点

  • 过滤器钩子名称：nav_menu_item_attributes
  • 主要参数：$li_atts（HTML 属性数组）、$menu_item（当前菜单项对象）、$args（wp_nav_menu() 参数对象）、$depth（菜单项深度）
  • 用途：自定义菜单项列表元素的属性，例如添加自定义 CSS 类或 ID
  • 相关函数：Walker_Nav_Menu::start_el() 使用此钩子
  • 引入版本：WordPress 6.3.0

代码示例

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

Filters the HTML attributes applied to a menu’s list item element.

Parameters

$li_attsarray
The HTML attributes applied to the menu item’s <li> element, empty strings are ignored.

  • class string
    HTML CSS class attribute.
  • id string
    HTML id attribute.

$menu_itemWP_Post
The current menu item object.
$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'.

$depthint
Depth of menu item. Used for padding.

Source

$li_atts       = apply_filters( 'nav_menu_item_attributes', $li_atts, $menu_item, $args, $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
6.3.0 Introduced.