関数リファレンス/get user by

説明

user データのフィールドとデータを取得する関数です。ここで得られるフィールドは、wp_users データベーステーブル内の関連するコラムと共に、以下に示します。

• 'id' - ID
• 'slug' - user_nicename
• 'email' - user_email
• 'login' - user_login

使い方

<?php $user = get_user_by( $field, $value ); ?>

パラメータ

$field

（string） （必須） 'id', 'slug', 'email', 'login' のいづれか。

初期値： なし

$value

（string / integer） （必須） この値を検索します。

初期値： なし

戻り値

(mixed) 

WP_User オブジェクト。ユーザーが見つからない場合は false。 $field が存在しない場合も false 。

用例

デフォルトの使い方

$user = get_user_by( 'email', 'user@example.com' );
echo 'User is ' . $user->first_name . ' ' . $user->last_name;

注意点

• WP_User::get_data_by() を使用します。

改訂履歴

• 3.3.0 にて、 wpdb の代わりに WP_User::get_data_by() を用いるように変更されました。
• 2.8.0 にて導入。

ソースファイル

get_user_by() は wp-includes/pluggable.php にあります。

関連項目

get_userdata()

最新英語版： WordPress Codex » Function Reference/get user by （最新版との差分）

関数リファレンス、テンプレートタグ目次もご覧ください。