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

Changes the current user by ID or name.

Contents

Description 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 Parameters

$id

(int) (Required) User ID

$name

(string) (Optional) User's username

Default value: ''

Top ↑

Return Return

(WP_User) Current user User object

Top ↑

Source Source

File: wp-includes/pluggable.php 

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.0.3 Introduced.

Top ↑

Top ↑

Used By Used By

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

Publish changeset values.
wp-includes/user.php: _wp_get_current_user()

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

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

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

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

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

Top ↑

User Contributed Notes 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: 0You 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: 0You must log in to vote on the helpfulness of this note
    Contributed by Andrew 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.