get_user_by()


WordPressのget_user_by()関数は、指定されたフィールドと値に基づいてユーザーオブジェクトを取得するために使用されます。

構文

get_user_by( string $field, string|int $value );

引数の説明:

  • $field(string) — ユーザーを検索するためのフィールド。’id’, ‘slug’, ‘email’, ‘login’のいずれかを使用できます。
  • $value(string|int) — 指定されたフィールドに対応する値。

例1: IDを使用してユーザーを取得

この例では、ユーザーIDを使用してユーザーオブジェクトを取得します。

$user = get_user_by('id', 2); if ($user) { echo 'ユーザー名: ' . $user->user_login; }

例2: メールアドレスを使用してユーザーを取得

この例では、メールアドレスを使用してユーザーオブジェクトを取得します。

$user = get_user_by('email', 'example@example.com'); if ($user) { echo 'ユーザー名: ' . $user->user_login; }

例3: ログイン名を使用してユーザーを取得

この例では、ログイン名を使用してユーザーオブジェクトを取得します。

$user = get_user_by('login', 'admin'); if ($user) { echo 'ユーザー名: ' . $user->user_login; }

例4: スラッグを使用してユーザーを取得

この例では、ユーザースラッグを使用してユーザーオブジェクトを取得します。

$user = get_user_by('slug', 'user-slug'); if ($user) { echo 'ユーザー名: ' . $user->user_login; }

例5: ユーザーが存在しない場合の処理

この例では、ユーザーが存在しない場合の処理を行います。

$user = get_user_by('id', 999); if (!$user) { echo 'ユーザーが見つかりませんでした。'; }

例6: ユーザーのメタデータを取得

この例では、取得したユーザーオブジェクトからメタデータを取得します。

$user = get_user_by('id', 2); if ($user) { $bio = get_user_meta($user->ID, 'description', true); echo 'ユーザーの説明: ' . $bio; }

例7: ユーザーのロールを確認

この例では、取得したユーザーオブジェクトのロールを確認します。

$user = get_user_by('id', 2); if ($user) { $roles = $user->roles; echo 'ユーザーのロール: ' . implode(', ', $roles); }

例8: ユーザーの表示名を取得

この例では、取得したユーザーオブジェクトの表示名を取得します。

$user = get_user_by('id', 2); if ($user) { echo 'ユーザーの表示名: ' . $user->display_name; }

注意点

  • ユーザーが存在しない場合、get_user_by()はfalseを返します。
  • ユーザーオブジェクトを取得した後、必ず存在チェックを行ってください。
  • パフォーマンスを考慮し、頻繁に使用する場合はキャッシュを活用してください。

関連機能：