概要
get_userdatabylogin関数は、WordPressにおいて特定のユーザー名に基づいて、そのユーザーの情報を取得するための関数です。この関数は、ユーザ情報を取得する際に便利で、主に以下のような機能実装時に使用されます。
- ユーザーのプロフィールページの表示
- コメントの表示におけるユーザー情報の取得
- カスタムロールに基づくアクセス権管理
- ユーザー情報に基づいたコンテンツのカスタマイズ
- ウェブサイトの管理者向けのユーザーリストを表示
- メール通知の送信におけるユーザー情報の取得
- ログイン履歴を表示するためのユーザー情報の取得
- ユーザーに基づいた統計情報の分析
構文
get_userdatabylogin( $login );
パラメータ
$login(string): ユーザー名を指定します。
戻り値
WP_User: 指定したユーザー名に基づくユーザー情報オブジェクトが返されます。ユーザーが存在しない場合は、nullが返されます。
関連する関数
使用可能なWordPressバージョン
この関数は、WordPress 1.5.0から使用可能です。
コアファイルのパス
wp-includes/user.php
サンプルコード
サンプルコード1: ユーザー情報の取得
$login = 'example_user';
$user_info = get_userdatabylogin($login);
if ($user_info) {
echo 'ユーザーID: ' . $user_info->ID;
}
このコードは、指定されたユーザー名に基づいてユーザー情報を取得し、そのユーザーIDを表示します。
サンプルコード2: ユーザー情報の表示
$login = 'example_user';
$user_info = get_userdatabylogin($login);
if ($user_info) {
echo 'ユーザー名: ' . $user_info->user_login;
echo 'メール: ' . $user_info->user_email;
}
このコードは、指定したユーザー名に基づいてユーザー情報を取得し、そのユーザー名とメールアドレスを表示します。
サンプルコード3: ユーザーのプロフィールリンクを生成
$login = 'example_user';
$user_info = get_userdatabylogin($login);
if ($user_info) {
$profile_link = get_edit_user_link($user_info->ID);
echo 'プロフィール編集リンク: ' . $profile_link;
}
このコードは、ユーザー名に基づいてユーザー情報を取得し、そのユーザーのプロフィール編集リンクを生成して表示します。
サンプルコード4: ユーザーのロールの取得
$login = 'example_user';
$user_info = get_userdatabylogin($login);
if ($user_info) {
$user_roles = $user_info->roles;
echo 'ユーザーロール: ' . implode(', ', $user_roles);
}
このコードは、指定したユーザー名に基づいてユーザー情報を取得し、そのユーザーのロールを取得して表示します。
サンプルコード5: ユーザーが存在するかのチェック
$login = 'example_user';
$user_info = get_userdatabylogin($login);
if ($user_info) {
echo 'ユーザーに関する情報が見つかりました。';
} else {
echo '指定されたユーザーは存在しません。';
}
このコードは、指定されたユーザー名に基づいてユーザー情報の取得を試み、ユーザーが存在するかどうかをチェックして結果を表示します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨または削除されたバージョン
get_userdatabylogin関数は、特定のバージョンにおいて非推奨または削除されていません。現在もWordPressで使用可能です。