函数文档

wp_nav_menu_disabled_check()

💡 云策文档标注

概述

wp_nav_menu_disabled_check() 函数用于检查是否应禁用菜单位置元框的提交按钮和输入字段。它基于全局变量和当前选定菜单的ID来返回disabled属性或false。

关键要点

  • 函数接受两个参数:$nav_menu_selected_id(必需,当前选定菜单的ID、名称或slug)和$display(可选,控制是否显示或仅返回字符串,默认true)。
  • 返回值:如果至少存在一个菜单,则返回disabled属性字符串;否则返回false。
  • 内部逻辑:检查全局变量$one_theme_location_no_menus,若为true则返回false;否则调用disabled()函数处理。

代码示例

function wp_nav_menu_disabled_check( $nav_menu_selected_id, $display = true ) {
	global $one_theme_location_no_menus;

	if ( $one_theme_location_no_menus ) {
		return false;
	}

	return disabled( $nav_menu_selected_id, 0, $display );
}

注意事项

  • 该函数自WordPress 3.6.0引入,并在5.3.1版本中添加了$display参数。
  • 常用于后台菜单管理界面,如Walker_Nav_Menu_Checklist和多个元框函数中。

📄 原文内容

Check whether to disable the Menu Locations meta box submit button and inputs.

Parameters

$nav_menu_selected_idint|stringrequired
ID, name, or slug of the currently selected menu.
$displaybooloptional
Whether to display or just return the string.

Default:true

Return

string|false Disabled attribute if at least one menu exists, false if not.

Source

function wp_nav_menu_disabled_check( $nav_menu_selected_id, $display = true ) {
	global $one_theme_location_no_menus;

	if ( $one_theme_location_no_menus ) {
		return false;
	}

	return disabled( $nav_menu_selected_id, 0, $display );
}

Changelog

Version Description
5.3.1 The $display parameter was added.
3.6.0 Introduced.