wp_set_current_user

Advertisement

Summery Summery

Changes the current user by ID or name.

Syntax Syntax

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

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

(Required) User ID

$name

(Optional) User's username

Default value: ''

Return Return

(WP_User) Current user User object

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;

Advertisement

Changelog Changelog

Changelog
Version Description
2.0.3 Introduced.

Advertisement

Leave a Reply