函数文档

register_nav_menu()

💡 云策文档标注

概述

register_nav_menu() 函数用于为 WordPress 主题注册单个导航菜单位置。它通过调用 register_nav_menus() 实现,并自动启用自定义菜单支持,无需额外调用 add_theme_support('menus')。

关键要点

  • 注册单个导航菜单位置,参数包括 $location(位置标识符,如 slug)和 $description(描述文本),均为必需。
  • 自动启用主题的自定义菜单支持,简化了开发流程。
  • 内部实现基于 register_nav_menus(),使用数组参数传递位置和描述。
  • 注册后,可使用 wp_nav_menu() 函数来显示自定义菜单。
  • 如需注册多个菜单位置,建议直接使用 register_nav_menus() 函数。

代码示例

add_action( 'after_setup_theme', 'register_primary_menu' );

function register_primary_menu() {
    register_nav_menu( 'primary', __( 'Primary Menu', 'theme-text-domain' ) );
}

📄 原文内容

Registers a navigation menu location for a theme.

Parameters

$locationstringrequired
Menu location identifier, like a slug.
$descriptionstringrequired
Menu location descriptive text.

More Information

  • See register_nav_menus() for creating multiple menus at once.
  • This function automatically registers custom menu support for the theme therefore you do not need to call add_theme_support( 'menus' );
  • This function actually works by simply calling register_nav_menus() in the following way:
register_nav_menus( array( $location => $description ) );
  • You may use wp_nav_menu() to display your custom menu.
  • Source

    function register_nav_menu( $location, $description ) {
    	register_nav_menus( array( $location => $description ) );
    }
    

    Changelog

    Version Description
    3.0.0 Introduced.

    User Contributed Notes