Question

wp_set_current_user( int $id,  string $name = '' )

通过用户 ID 或名称修改当前用户。

此函数可以被插件替换，如果没有插件替换，则使用 WordPress 内置的函数，函数的作用是通过用户 ID 或名称修改当前用户。如果不知道用户ID，设置 $id 为 null 然后指定一个用户名称。

一些 WordPress 功能需要基于此函数而不是登录的用户，wp_set_current_user() 提供了对未登录的某用户进行编辑和一些操作的能力。

---

description

Set $id to null and specify a name if you do not know a user’s ID.

Some WordPress functionality is based on the current user and not based on the signed in user. Therefore, it opens the ability to edit and perform actions on users who aren’t signed in.

---

参数

$id

(int)
(Required)
User ID

$name

(string)
(Optional)
User's usernameDefault value: ''

---

返回值

(WP_User) Current user User object

---

源代码

File: wp-includes/pluggable.php

function wp_set_current_user($id, $name = '') {
	global $current_user;

	// If `$id` matches the user who's already current, there's nothing to do.
	if ( isset( $current_user )
		&& ( $current_user instanceof WP_User )
		&& ( $id == $current_user->ID )
		&& ( null !== $id )
	) {
		return $current_user;
	}

	$current_user = new WP_User( $id, $name );

	setup_userdata( $current_user->ID );

	/**
	 * Fires after the current user is set.
	 *
	 * @since 2.0.1
	 */
	do_action( 'set_current_user' );

	return $current_user;
}

---

更新日志

Version	description
2.0.3	Introduced.

---

相关函数

Uses

• wp-includes/class-wp-user.php:WP_User::__construct()
• wp-includes/pluggable.php:set_current_user
• wp-includes/plugin.php:do_action()
• wp-includes/user.php:setup_userdata()

---

Used By

• wp-includes/class-wp-customize-manager.php:WP_Customize_Manager::_publish_changeset_values()
• wp-includes/user.php:_wp_get_current_user()
• wp-includes/rest-api.php:rest_cookie_check_errors()
• wp-admin/includes/class-wp-importer.php:WP_Importer::set_user()
• wp-includes/pluggable-deprecated.php:set_current_user()
• wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::login()

---

使用示例

Note that setting the current user does not log in that user. This example will set the current user and log them in.

注意，设置当前用户不会登录该用户，此示例将使用 wp_set_auth_cookie 函数登录用户。

$user_id = 12345;
$user = get_user_by( 'id', $user_id ); 
if( $user ) {
	wp_set_current_user( $user_id, $user->user_login );
	wp_set_auth_cookie( $user_id );
	do_action( 'wp_login', $user->user_login );
}