钩子文档

nav_menu_description

💡 云策文档标注

概述

nav_menu_description 是一个 WordPress 过滤器钩子,用于修改导航菜单项的描述文本。它允许开发者自定义菜单项的描述内容,通常基于菜单项的文章内容生成。

关键要点

  • 过滤器钩子:nav_menu_description
  • 参数:$description(字符串类型,表示菜单项的描述)
  • 源位置:在菜单项对象的 description 属性中应用,使用 wp_trim_words 函数截取文章内容的前200个单词作为默认描述
  • 相关函数:WP_Customize_Nav_Menu_Item_Setting::value_as_wp_post_nav_menu_item() 和 wp_setup_nav_menu_item() 用于设置和模拟菜单项属性
  • 版本历史:自 WordPress 3.0.0 版本引入

📄 原文内容

Filters a navigation menu item’s description.

Parameters

$descriptionstring
The menu item description.

Source

$menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );

Changelog

Version Description
3.0.0 Introduced.