详解 WordPress `wp_set_current_user()` 函数的源码：如何设置当前登录用户。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！今天咱们来聊聊WordPress里一个至关重要的函数——wp_set_current_user()。这个函数就像一个魔术师，能瞬间让你变成网站里的任何一个用户，当然，前提是你得有这个权限。别担心，今天我会把这个魔术的秘密彻底扒开，让大家都能玩转它。

一、开场白：wp_set_current_user() 是个啥？

想象一下，你开发了一个WordPress插件，需要模拟不同用户的行为来测试功能。或者，你在做一个用户切换功能，让管理员可以快速切换到其他用户身份。这时，wp_set_current_user() 就派上大用场了。简单来说，它负责设置全局变量 $current_user，这个变量存储了当前登录用户的所有信息。

二、源码剖析：wp-includes/pluggable.php，走起！

咱们直接钻到源码里看看，wp_set_current_user() 藏在 wp-includes/pluggable.php 文件里。

/**
 * Sets the current user.
 *
 * @since 2.0.0
 *
 * @global WP_User $current_user
 *
 * @param int    $id User ID.
 * @param string $name Optional. User login name.
 */
function wp_set_current_user( $id, $name = '' ) {
    global $current_user, $wp_roles;

    $id = (int) $id;

    if ( empty( $id ) ) {
        $current_user = wp_get_current_user(); // 默认获取当前用户
        return;
    }

    if ( empty( $current_user ) || $id !== $current_user->ID ) {
        $current_user = get_userdata( $id );
    }

    if ( empty( $current_user->ID ) ) {
        $current_user = wp_get_current_user(); // 获取失败，尝试获取当前用户
        return;
    }

    wp_cache_set( $id, $current_user, 'users' );

    if ( is_user_member_of_blog( $id, get_current_blog_id() ) ) {
        if ( is_object( $wp_roles ) ) {
            $current_user->get_role_caps();
        }
    } else {
        $current_user->caps = array();
        $current_user->roles = array();
    }

    /**
     * Fires after the current user is set.
     *
     * @since 2.1.0
     *
     * @param WP_User $current_user WP_User object of the current user.
     */
    do_action( 'set_current_user', $current_user );
}

三、逐行解读：这代码到底干了啥？

声明全局变量：
```
global $current_user, $wp_roles;
```
这行代码声明了两个全局变量：$current_user 和 $wp_roles。$current_user 是我们要设置的核心，它是一个 WP_User 对象，包含了用户的所有信息。$wp_roles 是一个 WP_Roles 对象，用于管理用户角色和权限。
类型转换：
```
$id = (int) $id;
```
确保传入的 $id 是一个整数，避免一些潜在的错误。
处理空 ID：
```
if ( empty( $id ) ) {
    $current_user = wp_get_current_user(); // 默认获取当前用户
    return;
}
```
如果 $id 为空，则调用 wp_get_current_user() 获取当前登录用户的信息。wp_get_current_user() 会尝试从 cookie 中读取用户信息，或者返回一个匿名用户对象。
判断是否需要更新 $current_user：
```
if ( empty( $current_user ) || $id !== $current_user->ID ) {
    $current_user = get_userdata( $id );
}
```
如果 $current_user 还没有被设置，或者传入的 $id 与当前 $current_user 的 ID 不同，则调用 get_userdata() 获取指定 ID 的用户数据。get_userdata() 会从数据库中读取用户信息，并创建一个 WP_User 对象。
再次检查用户数据是否获取成功：
```
if ( empty( $current_user->ID ) ) {
    $current_user = wp_get_current_user(); // 获取失败，尝试获取当前用户
    return;
}
```
如果 get_userdata() 获取用户数据失败（例如，ID 不存在），则再次调用 wp_get_current_user() 尝试获取当前登录用户的信息。
缓存用户数据：
```
wp_cache_set( $id, $current_user, 'users' );
```
将获取到的用户数据缓存起来，以便下次快速访问。WordPress 使用对象缓存来提高性能。
检查用户是否是博客的成员：
```
if ( is_user_member_of_blog( $id, get_current_blog_id() ) ) {
    if ( is_object( $wp_roles ) ) {
        $current_user->get_role_caps();
    }
} else {
    $current_user->caps = array();
    $current_user->roles = array();
}
```
如果用户是当前博客的成员，则调用 $current_user->get_role_caps() 获取用户的角色和权限。否则，将用户的角色和权限清空。get_role_caps() 方法会根据用户的角色，从数据库中读取相应的权限，并设置到 $current_user->caps 数组中。
触发 set_current_user 钩子：
```
/**
 * Fires after the current user is set.
 *
 * @since 2.1.0
 *
 * @param WP_User $current_user WP_User object of the current user.
 */
do_action( 'set_current_user', $current_user );
```
触发 set_current_user 钩子，允许其他插件或主题在用户设置完成后执行一些操作。例如，可以记录用户登录日志，或者更新用户的一些自定义字段。

四、重点难点：WP_User 对象和权限系统

wp_set_current_user() 最终的目标是设置 $current_user 这个 WP_User 对象。所以，理解 WP_User 对象和WordPress的权限系统至关重要。

WP_User 对象：

WP_User 对象包含了用户的各种信息，例如 ID、用户名、邮箱、角色、权限等等。

// 一些常用的 WP_User 对象的属性
$user_id = $current_user->ID;
$user_login = $current_user->user_login;
$user_email = $current_user->user_email;
$user_roles = $current_user->roles; // 角色数组
$user_caps = $current_user->caps; // 权限数组

权限系统：

WordPress 使用角色和权限来管理用户的访问控制。每个用户可以拥有一个或多个角色，每个角色都对应一组权限。例如，管理员角色拥有所有权限，而投稿者角色只能发布和编辑自己的文章。

$current_user->caps 数组存储了用户拥有的所有权限。例如，如果用户拥有 edit_posts 权限，则 $current_user->caps['edit_posts'] 的值为 true。

五、使用场景：实战演练

说了这么多理论，咱们来点实际的。

插件开发：模拟用户行为

假设你要开发一个插件，用于测试评论功能。你需要模拟不同用户的评论行为，例如管理员、编辑、作者、投稿者等等。

// 模拟管理员用户
wp_set_current_user( 1 ); // 假设 ID 为 1 的用户是管理员
// 发布一条评论
$comment_data = array(
    'comment_post_ID' => 123,
    'comment_author' => 'Admin',
    'comment_author_email' => '[email protected]',
    'comment_content' => 'This is a test comment from admin.',
    'comment_type' => '',
    'comment_parent' => 0,
    'user_id' => 1,
    'comment_author_IP' => '127.0.0.1',
    'comment_agent' => 'Mozilla/5.0',
    'comment_date' => current_time( 'mysql' ),
    'comment_approved' => 1,
);
wp_insert_comment( $comment_data );

// 模拟作者用户
wp_set_current_user( 2 ); // 假设 ID 为 2 的用户是作者
// 发布一条评论
$comment_data = array(
    'comment_post_ID' => 123,
    'comment_author' => 'Author',
    'comment_author_email' => '[email protected]',
    'comment_content' => 'This is a test comment from author.',
    'comment_type' => '',
    'comment_parent' => 0,
    'user_id' => 2,
    'comment_author_IP' => '127.0.0.1',
    'comment_agent' => 'Mozilla/5.0',
    'comment_date' => current_time( 'mysql' ),
    'comment_approved' => 1,
);
wp_insert_comment( $comment_data );

// 恢复到原来的用户（可选）
wp_set_current_user( get_current_user_id() );

注意： 在测试完成后，最好恢复到原来的用户，避免对网站造成不必要的干扰。

用户切换功能：管理员模拟用户身份

假设你想要开发一个用户切换功能，让管理员可以快速切换到其他用户身份，以便帮助用户解决问题。

// 获取要切换的用户 ID
$user_id = $_GET['switch_to_user']; // 假设通过 GET 参数传递用户 ID

// 验证当前用户是否是管理员
if ( current_user_can( 'administrator' ) ) {
    // 设置当前用户为要切换的用户
    wp_set_current_user( $user_id );

    // 重定向到首页
    wp_redirect( home_url() );
    exit;
} else {
    // 没有权限
    wp_die( 'You do not have permission to switch users.' );
}

警告： 用户切换功能需要非常谨慎地使用，必须确保只有管理员才能使用该功能，并且要做好安全防护，防止恶意用户利用该功能窃取其他用户的身份。

根据用户角色显示不同的内容

global $current_user;
get_currentuserinfo();

if ( in_array( 'administrator', $current_user->roles ) ) {
    echo '<p>欢迎管理员！</p>';
} elseif ( in_array( 'editor', $current_user->roles ) ) {
    echo '<p>欢迎编辑！</p>';
} else {
    echo '<p>欢迎访客！</p>';
}

六、注意事项：别玩脱了！

权限控制： wp_set_current_user() 非常强大，但也很危险。一定要做好权限控制，确保只有授权的用户才能使用它。
安全隐患： 使用不当可能会导致安全漏洞，例如用户身份被冒充。
测试环境： 最好在测试环境中使用，避免对生产环境造成影响。
session 问题： wp_set_current_user() 并不会改变用户的 session 信息。如果需要完全模拟用户身份，还需要手动更新 session 信息。
wp_get_current_user() 的作用： 这个函数用于获取当前的 WP_User 对象。它会首先检查全局变量 $current_user 是否已经设置，如果没有，则会尝试从 cookie 中读取用户信息。
get_userdata() 的作用： 这个函数用于根据用户 ID 获取用户数据。它会从数据库中读取用户信息，并创建一个 WP_User 对象。

七、总结：wp_set_current_user()，用好它，受益无穷！

wp_set_current_user() 是一个非常实用的函数，可以帮助我们模拟用户行为、开发用户切换功能、以及根据用户角色显示不同的内容。但是，在使用时一定要谨慎，做好权限控制和安全防护，避免出现问题。

希望今天的讲解能够帮助大家更好地理解和使用 wp_set_current_user() 函数。如果还有什么问题，欢迎大家留言提问。祝大家编程愉快！

附录：常用函数和全局变量

函数/全局变量	描述
`wp_set_current_user()`	设置当前用户。
`$current_user`	全局变量，存储当前登录用户的 `WP_User` 对象。
`wp_get_current_user()`	获取当前登录用户的 `WP_User` 对象。
`get_userdata()`	根据用户 ID 获取用户数据，并创建一个 `WP_User` 对象。
`current_user_can()`	检查当前用户是否具有指定的权限。
`is_user_member_of_blog()`	检查用户是否是当前博客的成员。
`get_current_blog_id()`	获取当前博客的 ID。
`$wp_roles`	全局变量，存储 `WP_Roles` 对象，用于管理用户角色和权限。
`get_role()`	获取指定角色的信息。
`add_role()`	添加一个新角色。
`remove_role()`	移除一个角色。
`wp_insert_user()`	创建一个新用户。
`wp_update_user()`	更新用户信息。
`wp_delete_user()`	删除用户。
`wp_cache_set()`	将数据存储到对象缓存中。
`wp_cache_get()`	从对象缓存中获取数据。
`wp_redirect()`	重定向到指定的 URL。
`home_url()`	获取网站的首页 URL。
`wp_die()`	显示一个错误信息并停止执行。

希望这份附录能帮助大家更好地理解 WordPress 的用户管理系统。

发表回复 取消回复

发表回复取消回复