概要
wp_set_current_user関数は、WordPressの現在のユーザ情報を設定するための関数です。主に以下のような機能を実装する際に使用されます。
- ユーザーログインのカスタマイズ
- ユーザーロールの変更
- 管理パネルの制御
- フロントエンドのユーザーインターフェイスの表示制御
- 特定のユーザーに対するアクセス権の設定
- ユーザーのアクティビティトラッキング
- プラグインによるユーザー関連機能の拡張
- REST APIでのユーザーデータの管理
構文
wp_set_current_user( $user_id, $nickname = '' );
パラメータ
$user_id(int) – 設定したいユーザーのID。$nickname(string) – オプション。ユーザーのニックネーム。
戻り値
- (int) 成功した場合は設定されたユーザーのID、失敗した場合は0を返します。
関連する関数
使用可能なバージョン
- この関数はWordPress 2.0.0以降で使用できます。
コアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | 〇 |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
- 現在のところ、
wp_set_current_user関数は非推奨または削除されているバージョンはありません。