概要
wp_get_current_user 関数は、現在のユーザ情報を取得するために使用されるWordPressの組み込み関数です。この関数を使用することで、現在サインインしているユーザの情報を簡単に取得することができ、様々な機能を実装する際によく活用されます。具体的には以下のようなケースで使用されることが多いです：
- ユーザの情報を表示するウィジェットを作成する
- ユーザ固有のカスタマイズされたコンテンツを表示する
- ユーザの役割に基づいて権限を管理する
- ユーザの情報を基にしたカスタムメニューを作成する
- 認証が必要な機能を実装する
- フォームの入力内容をユーザに関連付ける
- ユーザのアクティビティをログするプラグインを作成する
- 特定のユーザにのみアクセスを許可するページを作成する
構文
$user = wp_get_current_user();
パラメータ
この関数はパラメータを取らず、常に現在のユーザオブジェクトを返します。
戻り値
wp_get_current_user は WP_User オブジェクトを返します。サインインしていない場合は、ID プロパティは 0 になります。
関連する関数
使用可能なバージョン
この関数は WordPress 2.0.0 以降で使用可能です。
コアファイルのパス
wp-includes/pluggable.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 |
サンプルコード
サンプルコード 1: 現在のユーザ名を表示する
このコードは、現在のユーザ名をページに表示するものです。
$current_user = wp_get_current_user();
if ( $current_user->exists() ) {
echo '現在のユーザ名: ' . esc_html( $current_user->user_login );
}
サンプルコード 2: ユーザの役割をチェックする
このコードでは、現在のユーザが管理者かどうかを確認し、特定のメッセージを表示します。
$current_user = wp_get_current_user();
if ( in_array( 'administrator', (array) $current_user->roles ) ) {
echo 'あなたは管理者です！';
}
サンプルコード 3: プロフィール画像を表示する
このサンプルでは、現在のユーザのプロフィール画像を取得して表示します。
$current_user = wp_get_current_user();
if ( $current_user->exists() ) {
echo get_avatar( $current_user->ID );
}
サンプルコード 4: ユーザの表示名を表示する
このコードは、現在のユーザの表示名を表示します。
$current_user = wp_get_current_user();
if ( $current_user->exists() ) {
echo '表示名: ' . esc_html( $current_user->display_name );
}
サンプルコード 5: ユーザのメールアドレスを表示する
このサンプルでは、現在のユーザのメールアドレスを紙面に表示します。
$current_user = wp_get_current_user();
if ( $current_user->exists() ) {
echo 'メールアドレス: ' . esc_html( $current_user->user_email );
}
これらのサンプルコードはすべて著作権フリーのものであり、WordPressの開発に役立つ基本的な使い方を示しています。