概要
get_currentuserinfo関数は、現在のユーザ情報を読み込むための関数です。この関数を使用することで、WordPressのユーザに関連する情報を簡単に取得できます。例えば、ログインしているユーザの役割やメールアドレス、IDなどの情報を扱う際に利用されます。
この関数は、次のような機能を実装する際によく利用されます。
- ユーザのロールや権限を確認する際
- カスタムユーザプロファイルの表示
- 会員制サイトでのユーザ情報の取得
- ユーザダッシュボードの構築
- カスタムコンテンツへのアクセス制限
- ユーザ情報に基づくコンテンツの表示
- ログイン情報やプロファイルの編集機能
- メール通知やお知らせの送信
構文
get_currentuserinfo();
パラメータ
この関数は、パラメータを受け取りません。
戻り値
この関数は戻り値を持たず、グローバル変数$current_userに現在のユーザ情報を格納します。
関連する関数
使用可能なワードプレスのバージョン
get_currentuserinfo関数は、WordPress 4.5以降で非推奨となっています。
コアファイルのパス
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 |
サンプルコード
サンプル1: 現在のユーザのメールアドレスを表示
get_currentuserinfo(); // ユーザ情報を取得
echo 'メールアドレス: ' . $current_user->user_email; // ユーザのメールアドレスを表示
これは、ログインしているユーザのメールアドレスを表示するサンプルです。
サンプル2: ユーザが管理者か確認する
get_currentuserinfo(); // ユーザ情報を取得
if (in_array('administrator', $current_user->roles)) {
echo 'あなたは管理者です';
} else {
echo '管理者ではありません';
}
このコードは、現在のユーザが管理者であるかどうかを確認します。
サンプル3: ユーザ名を使用して挨拶
get_currentuserinfo(); // ユーザ情報を取得
echo 'こんにちは、' . $current_user->user_login . 'さん！'; // ユーザ名で挨拶
これは、現在のユーザに対し、個別に挨拶するサンプルです。
サンプル4: 特定のユーザ情報をチェック
get_currentuserinfo(); // ユーザ情報を取得
if ($current_user->ID == 1) {
echo 'これは特別なユーザです';
}
このコードは、特定のユーザID（ここでは1）を持つユーザがログインしているかを確認します。
サンプル5: ログインしていない場合の処理
get_currentuserinfo(); // ユーザ情報を取得
if (!$current_user->ID) {
echo 'ログインしてください';
}
このサンプルコードは、ユーザがログインしていない場合にメッセージを表示します。