发布于 由admin

分析 `get_wp_nav_menu_object()` 函数的源码，它如何通过数据库查询获取导航菜单的原始数据？

各位观众老爷，晚上好！今天咱们就来聊聊 WordPress 导航菜单背后的大功臣：get_wp_nav_menu_object() 函数。这玩意儿就像是菜单背后的总调度，负责从数据库里把菜单的原始数据给扒拉出来。咱们今天就来扒一扒它的源码，看看它到底是怎么干活的。

Part 1: 找到入口，一探究竟

首先，我们得知道这个函数在哪儿。它藏在 wp-includes/nav-menu.php 文件里。打开这个文件，找到 get_wp_nav_menu_object() 函数的定义。

/**
 * Retrieve a navigation menu object.
 *
 * @since 3.0.0
 *
 * @param mixed $menu ID, slug, or name of the menu.
 * @return WP_Term|false WP_Term instance on success, false on failure.
 */
function get_wp_nav_menu_object( $menu ) {
    global $wpdb;

    // Bail if no menu was specified.
    if ( empty( $menu ) ) {
        return false;
    }

    $menu_obj = false;

    if ( is_object( $menu ) ) {
        if ( ! empty( $menu->term_id ) ) {
            $menu_obj = $menu;
        }
    }

    if ( ! $menu_obj ) {
        if ( is_numeric( $menu ) ) {
            $menu_obj = get_term( absint( $menu ), 'nav_menu' );
        } else {
            $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
            if ( false === $menu_obj ) {
                $menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
            }
        }
    }

    if ( $menu_obj && ! is_wp_error( $menu_obj ) ) {
        return $menu_obj;
    }

    return false;
}

Part 2: 代码解读，抽丝剥茧

咱们来一行一行地分析一下这段代码，看看它都做了些啥。

  1. 参数检查:

    if ( empty( $menu ) ) {
    return false;
}

    这段代码首先检查传入的 $menu 参数是否为空。如果为空，直接返回 false，表示没有找到菜单。毕竟，啥都没给，让它找啥呢？

  2. 对象类型判断:

    if ( is_object( $menu ) ) {
    if ( ! empty( $menu->term_id ) ) {
        $menu_obj = $menu;
    }
}

    如果传入的 $menu 是一个对象，它会检查这个对象是否有一个 term_id 属性。如果有，就直接把这个对象赋值给 $menu_obj。这意味着，如果已经有一个菜单对象了，就直接用，不用再去数据库里查了。

  3. 数字类型判断（ID 查询）:

    if ( ! $menu_obj ) {
    if ( is_numeric( $menu ) ) {
        $menu_obj = get_term( absint( $menu ), 'nav_menu' );
    }

    如果 $menu 不是一个对象，那么它会判断 $menu 是否是一个数字。如果是数字，就认为这是一个菜单的 ID，然后使用 get_term() 函数来根据 ID 获取菜单对象。get_term() 函数会去数据库里查询 wp_terms 表，查找 term_id 等于 $menu 的记录，并且 taxonomy 等于 nav_menu 的记录。

  4. 字符串类型判断（Slug 或 Name 查询）:

    else {
    $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
    if ( false === $menu_obj ) {
        $menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
    }
}

    如果 $menu 不是一个数字，那么它就认为这是一个菜单的 slug 或 name。它首先尝试使用 get_term_by() 函数根据 slug 获取菜单对象。如果根据 slug 找不到，就尝试根据 name 获取菜单对象。get_term_by() 函数也会去数据库里查询 wp_terms 表，查找对应的记录。

  5. 错误检查和返回:

    if ( $menu_obj && ! is_wp_error( $menu_obj ) ) {
    return $menu_obj;
}

return false;

    最后，它会检查 $menu_obj 是否存在，并且不是一个 WordPress 错误对象。如果都满足，就返回 $menu_obj，否则返回 false。

Part 3: 数据库查询的真相

虽然 get_wp_nav_menu_object() 函数本身并没有直接执行 SQL 查询，但是它调用了 get_term() 和 get_term_by() 函数，这两个函数会最终执行数据库查询。

  • get_term() 函数:

    get_term() 函数会调用 WP_Term::get_instance() 方法，这个方法会从缓存中查找 term 对象。如果缓存中没有，它会执行以下 SQL 查询：

    SELECT t.*, tt.* FROM wp_terms AS t INNER JOIN wp_term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND t.term_id = %d LIMIT 1

    其中，%s 会被替换为 nav_menu，%d 会被替换为菜单的 ID。

    这个查询会从 wp_terms 表和 wp_term_taxonomy 表中联合查询，找到指定 taxonomy 和 term_id 的 term 对象。

  • get_term_by() 函数:

    get_term_by() 函数也会调用 WP_Term::get_instance() 方法，查找缓存。如果缓存中没有，它会执行以下 SQL 查询：

    SELECT t.*, tt.* FROM wp_terms AS t INNER JOIN wp_term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND t.%s = %s LIMIT 1

    其中，第一个 %s 会被替换为 nav_menu，第二个 %s 会被替换为 slug 或 name，第三个 %s 会被替换为菜单的 slug 或 name。

    这个查询和 get_term() 函数的查询类似，但是它使用 WHERE 子句来根据 slug 或 name 查找 term 对象。

Part 4: 缓存机制的妙用

WordPress 为了提高性能，使用了缓存机制来存储 term 对象。get_term() 和 get_term_by() 函数都会先从缓存中查找 term 对象，如果缓存中没有，才会去数据库里查询。这可以大大减少数据库查询的次数，提高网站的响应速度。

WordPress 使用 WP_Object_Cache 类来实现缓存。这个类可以存储各种类型的对象，包括 term 对象。

Part 5: 举个栗子，代码演示

假设我们有一个菜单，它的 ID 是 3。我们可以使用以下代码来获取这个菜单对象：

$menu_id = 3;
$menu_object = get_wp_nav_menu_object( $menu_id );

if ( $menu_object ) {
    echo "菜单名称: " . $menu_object->name . "<br>";
    echo "菜单 Slug: " . $menu_object->slug . "<br>";
    echo "菜单 ID: " . $menu_object->term_id . "<br>";
} else {
    echo "没有找到菜单";
}

这段代码会输出菜单的名称、slug 和 ID。如果找不到菜单，会输出 "没有找到菜单"。

如果我们知道菜单的 slug 是 "my-menu"，我们可以使用以下代码来获取这个菜单对象：

$menu_slug = 'my-menu';
$menu_object = get_wp_nav_menu_object( $menu_slug );

if ( $menu_object ) {
    echo "菜单名称: " . $menu_object->name . "<br>";
    echo "菜单 Slug: " . $menu_object->slug . "<br>";
    echo "菜单 ID: " . $menu_object->term_id . "<br>";
} else {
    echo "没有找到菜单";
}

这段代码和上面的代码类似，但是它使用 slug 来查找菜单对象。

Part 6: 深入探讨，表格总结

为了让大家更清晰地了解 get_wp_nav_menu_object() 函数的工作原理，我们用一个表格来总结一下：

参数类型 函数行为 数据库查询
空 返回 false 无
对象 如果对象有 term_id 属性，直接返回该对象；否则继续判断。 无
数字（菜单 ID） 调用 get_term( $menu, 'nav_menu' )。该函数先查缓存，如果缓存未命中，则执行 SQL 查询，从 wp_terms 和 wp_term_taxonomy 表中查找 term_id 等于 $menu 且 taxonomy 等于 nav_menu 的记录。 SELECT t.*, tt.* FROM wp_terms AS t INNER JOIN wp_term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = 'nav_menu' AND t.term_id = $menu LIMIT 1
字符串（Slug/Name） 调用 get_term_by( 'slug', $menu, 'nav_menu' )。如果未找到，则调用 get_term_by( 'name', $menu, 'nav_menu' )。这两个函数都先查缓存，如果缓存未命中，则执行 SQL 查询，从 wp_terms 和 wp_term_taxonomy 表中查找 slug 或 name 等于 $menu 且 taxonomy 等于 nav_menu 的记录。 SELECT t.*, tt.* FROM wp_terms AS t INNER JOIN wp_term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = 'nav_menu' AND t.slug = $menu LIMIT 1 (或 t.name = $menu)
其他 返回 false 无

Part 7: 注意事项，避免踩坑

  • 性能优化: 尽量使用菜单 ID 来获取菜单对象，因为根据 ID 查询比根据 slug 或 name 查询更快。
  • 缓存失效: 如果菜单数据发生了变化，需要清除缓存才能看到最新的数据。可以使用 WordPress 的缓存插件来清除缓存。
  • 错误处理: 在使用 get_wp_nav_menu_object() 函数时，一定要检查返回值是否为 false，以避免出现错误。

Part 8: 更进一步，扩展应用

了解了 get_wp_nav_menu_object() 函数的原理，我们可以利用它来做一些有趣的事情，例如：

  • 自定义菜单输出: 可以根据菜单对象的数据，自定义菜单的 HTML 结构。
  • 动态菜单生成: 可以根据用户的角色或权限，动态生成不同的菜单。
  • 多语言菜单: 可以根据用户的语言设置，显示不同语言的菜单。

Part 9: 总结陈词，画上句号

总而言之，get_wp_nav_menu_object() 函数是 WordPress 导航菜单的核心函数之一。它负责从数据库里获取菜单的原始数据，并提供给其他函数使用。了解了这个函数的原理，可以帮助我们更好地理解 WordPress 导航菜单的工作方式，并进行更高级的自定义和扩展。希望今天的分享能帮助大家更上一层楼！感谢各位的观看，咱们下期再见！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注