• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp set current user

提供: WordPress Codex 日本語版
移動先: 案内検索

この関数はプラグインによって置換できます。もしプラグインがこの関数を定義していない場合は、この関数が使われます。

IDまたは名前を元に現在のユーザーを変更します。

もしユーザーのIDがわからなければ、$idnullをセットし、$nameにユーザー名をセットしてください。

WordPressの機能のうち幾つかのものはサインインしたユーザーではなく、カレントユーザーの情報を使います。wp_set_current_user()を利用することで、サインインしていないユーザーのように振る舞うことができるようになります。

使用法

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


引数

$id
integer) (必須) ユーザーID
初期値: なし
$name
string) (オプション) ユーザー名
初期値: ''

戻り値

{Return|WP_User|オブジェクト|現在のユーザーのWP_Userオブジェクトを返す}}


使用例

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 object
  • 使用している関数: setup_userdata()
  • 使用している関数: do_action() 現在のユーザーをセットした後に、 'set_current_user' フックを呼び出します。


改訂履歴

Since: 2.0.4

ソースファイル

wp_set_current_user()wp-includes/pluggable.phpに定義されています。

カレントユーザー関数: get_current_user_id()/ en, get_currentuserinfo(), wp_get_current_user()/ en, wp_set_current_user(), current_user_can(), current_user_can_for_blog()/ en


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/wp_set_current_user最新版との差分