分析 WordPress `get_user_by()` 函数的源码：如何根据不同字段查询用户。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！今天给大家唠唠WordPress里一个非常重要的函数——get_user_by()。这玩意儿就像个万能钥匙，能帮你从数据库里捞出用户信息，不过它不是靠蛮力，而是靠你提供的“线索”。

开场白：用户数据的寻宝游戏

想象一下，你手里拿着藏宝图，上面写着“埋藏宝藏的地方在… latitude: 34.0522, longitude: -118.2437”，你肯定直接拿着GPS就去了。get_user_by() 就像这个GPS，而你提供的“latitude”和“longitude”就是它搜索的字段。

正题：get_user_by() 的基本用法

get_user_by() 的语法很简单：

<?php
$user = get_user_by( string $field, string|int $value );
?>

$field: 你要搜索的字段名，就像藏宝图上的“latitude”。
$value: 你要搜索的值，就像藏宝图上的“34.0522”。
返回值：如果找到用户，返回一个 WP_User 对象；没找到，返回 false。

支持的字段类型：你的寻宝指南

get_user_by() 支持以下这些字段（也就是“藏宝图上的各种线索”）：

字段 (Field)	数据类型	说明
`id`	整数	用户的ID。这是最直接的方式，就像你知道了宝藏的精确坐标。
`email`	字符串	用户的邮箱地址。这就像你知道了宝藏埋在“某某邮箱所有人家的后院”，需要查一下邮箱主人才能找到。
`slug`	字符串	用户的别名 (user_nicename)。这就像你知道宝藏埋在“外号叫小飞侠的人家的后院”，需要找到这个外号对应的人。
`login`	字符串	用户的登录名 (user_login)。这就像你知道宝藏埋在“用户名叫admin的人家的后院”，直接输入用户名就能找到。

实战演练：代码才是硬道理

咱们来写几个例子，让你更直观地感受一下 get_user_by() 的威力。

通过 ID 获取用户：

<?php
$user_id = 123; // 假设用户ID是123
$user = get_user_by('id', $user_id);

if ($user) {
    echo '用户ID: ' . $user->ID . '<br>';
    echo '用户名: ' . $user->user_login . '<br>';
    echo '邮箱: ' . $user->user_email . '<br>';
} else {
    echo '找不到ID为 ' . $user_id . ' 的用户';
}
?>

通过邮箱获取用户：

<?php
$user_email = '[email protected]';
$user = get_user_by('email', $user_email);

if ($user) {
    echo '用户ID: ' . $user->ID . '<br>';
    echo '用户名: ' . $user->user_login . '<br>';
    echo '邮箱: ' . $user->user_email . '<br>';
} else {
    echo '找不到邮箱为 ' . $user_email . ' 的用户';
}
?>

通过用户名获取用户：

<?php
$user_login = 'admin';
$user = get_user_by('login', $user_login);

if ($user) {
    echo '用户ID: ' . $user->ID . '<br>';
    echo '用户名: ' . $user->user_login . '<br>';
    echo '邮箱: ' . $user->user_email . '<br>';
} else {
    echo '找不到用户名为 ' . $user_login . ' 的用户';
}
?>

源码剖析：get_user_by() 内部是怎么工作的？

现在，咱们来扒一扒 get_user_by() 的源码，看看它内部是怎么实现的。以下是简化后的代码片段（完整代码可以在 WordPress 核心文件中找到，通常在 wp-includes/user.php）：

<?php
function get_user_by( $field, $value ) {
    global $wpdb;

    $func = 'get_user_by_' . $field; // 根据字段名构建函数名

    if ( function_exists( $func ) ) {
        return call_user_func( $func, $value ); // 调用对应的函数
    }

    // 默认情况，如果找不到特定的函数，则使用通用查询
    $user = null;

    switch ( $field ) {
        case 'id':
            if ( ! is_numeric( $value ) ) {
                return false; // ID必须是数字
            }
            $value = intval( $value );
            $user = get_userdata( $value ); // 使用 get_userdata() 获取用户信息
            break;
        case 'slug':
            $user = get_user_by_slug( $value ); // 调用 get_user_by_slug()
            break;
        case 'email':
            $user = get_user_by_email( $value ); // 调用 get_user_by_email()
            break;
        case 'login':
            $user = get_user_by_login( $value ); // 调用 get_user_by_login()
            break;
        default:
            return false; // 不支持的字段
    }

    if ( empty( $user->ID ) ) {
        return false; // 没找到用户
    }

    return $user;
}
?>

代码解读：

构建函数名： $func = 'get_user_by_' . $field; 这行代码根据你传入的字段名，动态地构建一个函数名。例如，如果你传入的 $field 是 'email'，那么 $func 就变成了 'get_user_by_email'。
调用特定函数： call_user_func( $func, $value ); 这行代码会尝试调用第一步构建的函数。WordPress 内部针对 id、slug、email、login 这几个字段，都定义了对应的函数，例如 get_user_by_email()。
默认处理： 如果 WordPress 找不到对应的特定函数，就会进入 switch 语句，根据 $field 的值进行处理。
ID 特殊处理： 对于 id 字段，它会先验证 $value 是否是数字，然后使用 get_userdata() 函数来获取用户信息。get_userdata() 是 WordPress 内部用于根据用户 ID 获取用户数据的核心函数。
其他字段的特殊处理： 对于 slug、email、login 字段，它会分别调用 get_user_by_slug()、get_user_by_email()、get_user_by_login() 这些函数。这些函数最终会构建 SQL 查询语句，从数据库中查询用户信息。
返回值： 如果找到了用户，就返回一个 WP_User 对象；否则，返回 false。

更深入的源码探险：以 get_user_by_email() 为例

咱们再深入一步，看看 get_user_by_email() 函数的源码（简化版）：

<?php
function get_user_by_email( $email ) {
    global $wpdb;

    $email = trim( $email );

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

    $user = wp_cache_get( 'get_user_by_email:' . $email, 'users' );

    if ( $user ) {
        return $user;
    }

    $sql = $wpdb->prepare(
        "SELECT * FROM {$wpdb->users} WHERE user_email = %s",
        $email
    );

    $user = $wpdb->get_row( $sql );

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

    $user = new WP_User( $user );

    wp_cache_set( 'get_user_by_email:' . $email, $user, 'users' );

    return $user;
}
?>

代码解读：

去除空格： $email = trim( $email ); 这行代码会去除邮箱地址两端的空格，防止因为空格导致查询失败。
缓存： wp_cache_get( 'get_user_by_email:' . $email, 'users' ); 这行代码会尝试从缓存中获取用户信息。WordPress 使用缓存来提高性能，避免每次都查询数据库。
构建 SQL 查询语句： $sql = $wpdb->prepare(...); 这行代码会构建 SQL 查询语句，用于从数据库中查询用户信息。$wpdb->prepare() 函数用于防止 SQL 注入攻击，保证安全性。
执行查询： $user = $wpdb->get_row( $sql ); 这行代码会执行 SQL 查询，并返回查询结果。
创建 WP_User 对象： $user = new WP_User( $user ); 这行代码会将查询结果转换为 WP_User 对象。WP_User 对象是 WordPress 中表示用户数据的核心类。
设置缓存： wp_cache_set( 'get_user_by_email:' . $email, $user, 'users' ); 这行代码会将用户信息存入缓存，以便下次更快地获取用户信息。

性能优化：缓存的重要性

从 get_user_by_email() 的源码可以看出，WordPress 非常重视性能优化，使用了缓存机制。每次调用 get_user_by_email() 函数时，它会先尝试从缓存中获取用户信息，如果缓存中没有，才会查询数据库。这可以大大提高性能，减少数据库压力。

安全性：防止 SQL 注入

get_user_by_email() 函数使用了 $wpdb->prepare() 函数来构建 SQL 查询语句，这可以有效地防止 SQL 注入攻击。SQL 注入是一种常见的网络安全漏洞，攻击者可以通过在输入框中输入恶意 SQL 代码，来获取或修改数据库中的数据。$wpdb->prepare() 函数会对输入进行转义处理，防止恶意 SQL 代码被执行。

注意事项：

大小写敏感性： get_user_by('login', $user_login) 对用户名的大小写是敏感的，get_user_by('email', $user_email) 对邮箱的大小写不敏感。
数据类型： 确保你传入的 $value 的数据类型与 $field 对应。例如，id 字段需要传入整数，email 字段需要传入字符串。
返回值： 注意检查返回值是否为 false，以判断是否找到了用户。

总结：get_user_by() 的价值

get_user_by() 函数是 WordPress 开发中非常常用的函数，它提供了一种简单、方便、安全的方式来获取用户信息。通过理解 get_user_by() 的用法和源码，你可以更好地利用它来开发 WordPress 插件和主题，提高你的开发效率和代码质量。它就像一把瑞士军刀，功能强大，使用方便，是每个 WordPress 开发者必备的技能。

希望今天的讲座能帮助你更好地理解 get_user_by() 函数。下次再见！

发表回复 取消回复

发表回复取消回复