概要
get_user_by関数は、ユーザ情報の一部を指定し、マッチするユーザ情報を取得するためのWordPressの関数です。この関数は、ユーザーID、ユーザー名、メールアドレス、または別のフィールドを基にユーザーデータを取得します。以下のような場面でよく使用されます。
- コメント投稿者の情報を取得する
- 投稿の著者情報を取得するため
- ユーザーのログイン情報を確認する際
- メールアドレスからユーザーの存在確認を行う
- ユーザーのプロフィール情報を表示するため
- カスタムユーザーメタの取得に利用する
- セキュリティチェックのためのユーザー確認
- APIやプラグインでのユーザー管理の実装
構文
get_user_by( $field, $value );
パラメータ
$field(string) 必須: ユーザーの識別方法を指定します（例: ‘id’, ‘slug’, ‘email’）。$value(mixed) 必須: 指定した$ fieldに基づくユーザーの値。
戻り値
成功した場合、指定したユーザーの WP_User オブジェクトを返します。ユーザーが見つからない場合は false を返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 2.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 |
非推奨または削除されたワードプレスバージョン
現在 get_user_by 関数は非推奨または削除されていません。