get_user_by

説明

mixed get_user_by( string $field, mixed $value )
ユーザ情報の一部を指定し、マッチするユーザ情報を取得する。

パラメータ

  • $field
    ユーザ情報のフィールド名。
    フィールド名意味
    idユーザID
    [4.4.0]IDユーザID
    loginログイン名
    slugユーザのスラッグ
    emailメールアドレス
  • $value
    検索するフィールドの値として数値または文字列を指定。

返り値

パラメータ$field$valueで指定されたユーザにマッチするユーザ情報(オブジェクト)を返す。$fieldが無効な値か、該当するユーザが存在しない場合はfalseを返す。ユーザ情報の内容は、 get_userdata関数を参照。

注意

パラメータ$fieldが'id'で検索する場合、内部ではget_userdata関数を使用する。

[4.4.0]パラメータ$fieldに'ID'が指定できるようになった。意味は'id'と同じ。


使用例

  • ログイン名が'editor'のユーザ情報を取得する。
    <?php $user_data = get_user_by( 'login', 'editor' ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2018年05月27日 10:51



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。