概要
get_user 関数は、ユーザーIDのユーザー情報を取得するために使用されます。この関数は、特定のユーザーに関連するデータを取得する際に便利です。例えば、ユーザープロフィールの表示、ユーザーの投稿データの取得、カスタムフィールドの読み込みなどに使われます。以下は、よく実装される機能の例です:
- ユーザープロフィールの表示
- ユーザーの役割の確認
- 特定のユーザーからの投稿の表示
- ユーザーに関連するメタデータの取得
- 認証されたユーザーの情報表示
- ユーザーリストの生成
- パスワードリセットリンクの生成
- ウェブサイトの管理者情報の表示
構文
get_user($user_id);
パラメータ
$user_id(int) – 取得したいユーザーのID。
戻り値
- ユーザーの情報を含むオブジェクトまたは
null。(ユーザーが見つからない場合)
関連する関数
使用可能なバージョン
- WordPress バージョン 1.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 | 〇 |
サンプルコード
サンプルコード1:ユーザーIDを指定してユーザー情報を取得する
$user_info = get_user(1);
echo 'ユーザー名: ' . $user_info->user_login;
このコードは、IDが1のユーザーの情報を取得して、そのユーザー名を出力します。最初のサンプルです。
サンプルコード2:現在のユーザーの情報を取得する
$current_user = wp_get_current_user();
$user_info = get_user($current_user->ID);
echo 'メールアドレス: ' . $user_info->user_email;
このコードは、現在ログインしているユーザーのメールアドレスを取得し、そのアドレスを表示します。
サンプルコード3:特定のユーザーの役割を確認する
$user_info = get_user(2);
if (in_array('administrator', $user_info->roles)) {
echo 'このユーザーは管理者です。';
}
このコードは、IDが2のユーザーが管理者かどうかを確認し、管理者であればその旨を表示します。
サンプルコード4:ユーザー情報を配列で取得する
$user_info = get_user(3);
$user_data = (array)$user_info;
print_r($user_data);
このコードは、IDが3のユーザー情報を配列に変換し、その内容を表示します。
サンプルコード5:ユーザーの投稿数を取得する
$user_info = get_user(4);
$post_count = count_user_posts($user_info->ID);
echo 'このユーザーの投稿数: ' . $post_count;
このコードは、IDが4のユーザーの投稿数を取得し、その数を表示します。