研究 WordPress 注册菜单位置 register_nav_menus 的实现逻辑 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress 注册菜单位置 register_nav_menus 实现逻辑剖析

各位同学们，今天我们来深入研究 WordPress 中 register_nav_menus 函数的实现逻辑。这个函数是 WordPress 主题开发中非常重要的一个环节，它允许主题开发者定义主题支持的导航菜单位置，从而让用户可以在 WordPress 后台管理这些菜单。

1. register_nav_menus 函数的基本使用

首先，我们回顾一下 register_nav_menus 函数的基本用法。它通常在主题的 functions.php 文件中被调用，并且需要放在 after_setup_theme 动作钩子上执行。

<?php
function my_theme_setup() {
    register_nav_menus(
        array(
            'primary'   => __( 'Primary Menu', 'my-theme' ),
            'secondary' => __( 'Secondary Menu', 'my-theme' ),
            'footer'    => __( 'Footer Menu', 'my-theme' )
        )
    );
}
add_action( 'after_setup_theme', 'my_theme_setup' );
?>

这段代码注册了三个菜单位置：primary，secondary 和 footer。键名（例如 ‘primary’）是菜单位置的 ID，键值（例如 ‘Primary Menu’）是在 WordPress 后台显示的菜单位置描述。

2. register_nav_menus 函数的源码分析

现在我们深入到 WordPress 的核心代码，看看 register_nav_menus 函数是如何实现的。 register_nav_menus 函数位于 wp-includes/theme.php 文件中。

/**
 * Registers multiple navigation menus in a theme.
 *
 * @since 3.0.0
 *
 * @param array $locations An associative array of menu location identifiers
 *                         (key) and descriptions (value).
 */
function register_nav_menus( $locations = array() ) {
    global $_wp_registered_nav_menus;

    if ( ! is_array( $locations ) ) {
        return;
    }

    foreach ( $locations as $location => $description ) {
        register_nav_menu( $location, $description );
    }
}

可以看到，register_nav_menus 函数接收一个数组作为参数，这个数组包含了菜单位置的 ID 和描述。它遍历这个数组，并对每一个菜单位置调用 register_nav_menu 函数。

3. register_nav_menu 函数的源码分析

接下来，我们看看 register_nav_menu 函数的实现。它也在 wp-includes/theme.php 文件中。

/**
 * Registers a navigation menu.
 *
 * @since 3.0.0
 *
 * @param string $location    Menu location identifier.
 * @param string $description Menu description.
 */
function register_nav_menu( $location, $description ) {
    global $_wp_registered_nav_menus;

    if ( empty( $location ) ) {
        return;
    }

    if ( empty( $description ) ) {
        return;
    }

    $_wp_registered_nav_menus[ $location ] = wp_kses_data( $description );
}

register_nav_menu 函数接收菜单位置的 ID 和描述作为参数。它首先检查这些参数是否为空，如果为空，则直接返回。否则，它将菜单位置的 ID 和描述存储在全局变量 $_wp_registered_nav_menus 中。wp_kses_data 函数用于对描述进行简单的安全过滤，移除潜在的危险 HTML 标签。

4. 全局变量 $_wp_registered_nav_menus

$_wp_registered_nav_menus 是一个全局数组，用于存储所有注册的菜单位置。它在 wp-includes/theme.php 文件中被声明。

global $_wp_registered_nav_menus;
$_wp_registered_nav_menus = array();

这个数组的键是菜单位置的 ID，值是菜单位置的描述。例如，如果主题注册了 primary 菜单位置，那么 $_wp_registered_nav_menus['primary'] 的值就是 Primary Menu。

5. 如何在主题中使用注册的菜单位置

注册了菜单位置之后，如何在主题中使用它们呢？可以使用 wp_nav_menu 函数。

<?php
wp_nav_menu( array( 'theme_location' => 'primary' ) );
?>

这段代码会在主题中显示 primary 菜单。theme_location 参数指定了要显示的菜单位置的 ID。

6. wp_nav_menu 函数的实现逻辑

wp_nav_menu 函数位于 wp-includes/nav-menu-template.php 文件中。它的作用是根据指定的参数生成导航菜单的 HTML 代码。

wp_nav_menu 函数的实现比较复杂，这里我们只关注与注册菜单位置相关的部分。

首先，wp_nav_menu 函数会检查 theme_location 参数是否有效。它会检查全局变量 $_wp_registered_nav_menus 中是否存在指定的菜单位置 ID。

if ( isset( $args['theme_location'] ) ) {
    $theme_locations = get_nav_menu_locations();
    if ( isset( $theme_locations[ $args['theme_location'] ] ) ) {
        $args['menu'] = $theme_locations[ $args['theme_location'] ];
    } else {
        // If the theme location is invalid, silently bail.
        return false;
    }
}

这段代码首先调用 get_nav_menu_locations 函数获取所有已分配给菜单位置的菜单 ID。然后，它检查 theme_location 参数指定的菜单位置 ID 是否存在于 get_nav_menu_locations 函数返回的数组中。如果存在，则将对应的菜单 ID 赋值给 args['menu'] 参数。如果不存在，则直接返回 false。

7. get_nav_menu_locations 函数的实现逻辑

get_nav_menu_locations 函数位于 wp-includes/nav-menu.php 文件中。它的作用是获取所有已分配给菜单位置的菜单 ID。

/**
 * Retrieve all registered navigation menu locations and the menu ID assigned to each location.
 *
 * @since 3.0.0
 *
 * @return array Menu location assignments.
 */
function get_nav_menu_locations() {
    $locations = get_theme_mod( 'nav_menu_locations' );

    if ( ! is_array( $locations ) ) {
        $locations = array();
    }

    /**
     * Filters the array of menu locations.
     *
     * @since 3.0.0
     *
     * @param array $locations Array of menu locations.
     */
    return apply_filters( 'theme_mod_nav_menu_locations', $locations );
}

get_nav_menu_locations 函数首先调用 get_theme_mod 函数获取名为 nav_menu_locations 的主题选项。这个主题选项存储了所有已分配给菜单位置的菜单 ID。

get_theme_mod 函数用于获取主题选项的值。主题选项存储在 WordPress 的 wp_options 表中。

如果 get_theme_mod 函数返回的值不是数组，则将其初始化为一个空数组。

最后，get_nav_menu_locations 函数应用一个名为 theme_mod_nav_menu_locations 的过滤器，允许插件或主题修改菜单位置的分配。

8. 菜单位置的分配

用户可以在 WordPress 后台的“外观 -> 菜单”页面将菜单分配给注册的菜单位置。当用户分配一个菜单给一个菜单位置时，WordPress 会将菜单 ID 存储在 nav_menu_locations 主题选项中。

例如，如果用户将 ID 为 10 的菜单分配给 primary 菜单位置，那么 nav_menu_locations 主题选项的值就会变成：

array(
    'primary' => 10
)

9. 总结

我们通过分析register_nav_menus、register_nav_menu、wp_nav_menu 和 get_nav_menu_locations 函数的源码，了解了 WordPress 注册菜单位置的实现逻辑。简单来说，register_nav_menus 注册菜单位置到全局变量，get_nav_menu_locations 从主题配置中获取菜单位置分配，wp_nav_menu 根据菜单位置生成 HTML。理解这些函数的实现逻辑，可以帮助我们更好地开发 WordPress 主题，并可以更灵活地控制导航菜单的显示。

附录：代码示例

下面是一个完整的代码示例，演示了如何注册菜单位置并在主题中使用它们。

<?php
// functions.php

function my_theme_setup() {
    register_nav_menus(
        array(
            'primary'   => __( 'Primary Menu', 'my-theme' ),
            'secondary' => __( 'Secondary Menu', 'my-theme' ),
            'footer'    => __( 'Footer Menu', 'my-theme' )
        )
    );
}
add_action( 'after_setup_theme', 'my_theme_setup' );

// header.php

?>
<nav>
    <?php wp_nav_menu( array( 'theme_location' => 'primary' ) ); ?>
</nav>

// footer.php

?>
<footer>
    <?php wp_nav_menu( array( 'theme_location' => 'footer' ) ); ?>
</footer>

表格总结关键点

函数/变量	作用	存储位置	使用场景
`register_nav_menus`	注册多个菜单位置	全局变量 `$_wp_registered_nav_menus`	主题的 `functions.php` 文件中，通常在 `after_setup_theme` 动作钩子上调用
`register_nav_menu`	注册单个菜单位置	全局变量 `$_wp_registered_nav_menus`	`register_nav_menus` 函数内部调用
`$_wp_registered_nav_menus`	存储所有注册的菜单位置的 ID 和描述	全局变量	`register_nav_menu` 函数用来存储注册的菜单位置信息， `wp_nav_menu` 函数用来检查 `theme_location` 参数是否有效
`wp_nav_menu`	根据指定的参数生成导航菜单的 HTML 代码	无	在主题模板文件中，用于显示导航菜单
`get_nav_menu_locations`	获取所有已分配给菜单位置的菜单 ID	主题选项 `nav_menu_locations`	`wp_nav_menu` 函数内部调用，用于获取与 `theme_location` 参数对应的菜单 ID
主题选项 `nav_menu_locations`	存储所有已分配给菜单位置的菜单 ID	`wp_options` 表	WordPress 后台的“外观 -> 菜单”页面，用户可以将菜单分配给注册的菜单位置

几个值得注意的点

after_setup_theme 动作钩子：确保主题基本功能设置完成后再注册菜单。
全局变量：$_wp_registered_nav_menus 是全局变量，要注意作用域和命名冲突。
主题选项：菜单位置的分配信息存储在主题选项中，方便用户自定义。
安全过滤：wp_kses_data 函数用于对菜单描述进行安全过滤，防止 XSS 攻击。

注册菜单位置的意义

通过 register_nav_menus 注册菜单位置，主题开发者能够标准化主题的菜单结构，并为用户提供清晰的管理界面。这使得主题更易于维护和定制，同时也提高了用户体验。

主题开发者如何更好的利用这个机制？

主题开发者应该仔细考虑主题的导航需求，并注册足够数量的菜单位置，以便满足不同用户的需求。命名菜单位置时，应该使用清晰明了的 ID 和描述，方便用户理解和使用。还可以通过 CSS 和 JavaScript 对导航菜单进行美化和增强，提升用户体验。

最后几句话：

register_nav_menus 函数是 WordPress 主题开发的基础，理解它的实现逻辑可以帮助开发者更好地掌握 WordPress 的主题开发技巧。持续学习和实践是成为优秀 WordPress 开发者的关键。希望今天的讲解对大家有所帮助！

WordPress 注册菜单位置 register_nav_menus 实现逻辑剖析

发表回复 取消回复

发表回复取消回复