wp_set_current_user( int|null $id, string $name =  ): WP_User

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 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.

Parameters

$idint|nullrequired
User ID.
$namestringoptional
User’s username.

Default:''

Return

WP_User Current user User object.

More Information

This function can be replaced via plugins. If plugins do not redefine these functions, then this will be used instead.

Source

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

	// If `$id` matches the current user, there is 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;
}

Hooks

do_action( ‘set_current_user’ )

Fires after the current user is set.

Changelog

VersionDescription
2.0.3Introduced.

User Contributed Notes

  1. Skip to note 3 content

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

    $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, $user );
    }
  2. Skip to note 4 content

    Attention!
    Running this function will affect everything related to the current(real) user, after it. You must restore the real user:

    $original_user_id = get_current_user_id(); // For example the real user ID is 7
    wp_set_current_user( 15 );
    
    // get_current_user_id() now returns 15
    // Do other stuff here...
    // ...
    // get_current_user_id() still returns 15
    
    // Restore the original user.
    wp_set_current_user( $original_user_id );
    
    // get_current_user_id() now returns 7

You must log in before being able to contribute a note or feedback.