函数文档

is_nav_menu_item()

💡 云策文档标注

概述

is_nav_menu_item() 是一个 WordPress 函数,用于检查给定的 ID 是否对应一个导航菜单项。它通过验证 ID 的 post_type 是否为 'nav_menu_item' 来实现此功能。

关键要点

  • 函数接受一个整数参数 $menu_item_id,表示待检查的潜在导航菜单项 ID。
  • 返回布尔值,指示该 ID 是否属于一个导航菜单项。
  • 内部实现结合了 is_wp_error() 和 get_post_type() 函数进行验证。
  • 该函数自 WordPress 3.0.0 版本引入。

代码示例

function is_nav_menu_item( $menu_item_id = 0 ) {
    return ( ! is_wp_error( $menu_item_id ) && ( 'nav_menu_item' === get_post_type( $menu_item_id ) ) );
}

注意事项

  • 参数 $menu_item_id 是必需的,且应为整数类型。
  • 函数首先检查 $menu_item_id 是否为 WP_Error 对象,以避免错误处理。
  • 相关函数包括 get_post_type() 和 is_wp_error(),用于获取 post_type 和错误检查。
  • 该函数被多个导航菜单相关函数(如 wp_nav_menu_update_menu_items())使用。

📄 原文内容

Determines whether the given ID is a nav menu item.

Parameters

$menu_item_idintrequired
The ID of the potential nav menu item.

Return

bool Whether the given ID is that of a nav menu item.

Source

function is_nav_menu_item( $menu_item_id = 0 ) {
	return ( ! is_wp_error( $menu_item_id ) && ( 'nav_menu_item' === get_post_type( $menu_item_id ) ) );
}

Changelog

Version Description
3.0.0 Introduced.