WordPress.org

Codex

Function Reference/wp set current user

Contents

Description

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

Changes the current user by ID or name.

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. wp_set_current_user() opens the ability to edit and perform actions on users who aren't signed in.

Usage

<?php wp_set_current_user( $id, $name ); ?>

Parameters

$id
(integer) (required) User ID
Default: None
$name
(string) (optional) User's username
Default: ''

Return Values

WP_User (object) 
WP_User object with the current user.

Examples

Notes

  • This function can be replaced via plugins. If plugins do not redefine these functions, then this will be used instead.
  • Uses: WP_User object
  • Uses: setup_userdata()
  • Uses: do_action() Calls 'set_current_user' hook after setting the current user.

Change Log

Since: 2.0.4

Source File

wp_set_current_user() is located in wp-includes/pluggable.php.

Related

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/wp_set_current_user"

Codex Resources