wp_set_current_user( int $id, string $name = '' )
Changes the current user by ID or name.
Description
Set $id to null and specify a name if you do not know a user’s ID.
Some ClassicPress 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.
Parameters
- $id
-
(Required) User ID
- $name
-
(Optional) User's username
Default value: ''
Return
(WP_User) Current user User object
Source
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 WP-2.0.1
*/
do_action( 'set_current_user' );
return $current_user;
}
Changelog
Version | Description |
---|---|
WP-2.0.3 | Introduced. |