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

Changes the current user by ID or name.

Contents

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.

Top ↑

Parameters

$id int|null Required
User ID.
$name string Optional
User's username.

Default: ''

Top ↑

Return

WP_User Current user User object.

Top ↑

More Information

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

Top ↑

Source

File: wp-includes/pluggable.php. View all references 

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;
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Used By

Used By
Used By Description
WP_Customize_Manager::_publish_changeset_values() wp-includes/class-wp-customize-manager.php

Publishes the values of a changeset.
_wp_get_current_user() wp-includes/user.php

Retrieves the current user object.
rest_cookie_check_errors() wp-includes/rest-api.php

Checks for errors when using cookie-based authentication.
WP_Importer::set_user() wp-admin/includes/class-wp-importer.php
wp_logout() wp-includes/pluggable.php

Logs the current user out.
set_current_user() wp-includes/pluggable-deprecated.php

Changes the current user by ID or name.
wp_xmlrpc_server::login() wp-includes/class-wp-xmlrpc-server.php

Logs user in.
Show 2 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.0.3 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Andrei Surdu —

    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.