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



お勧め

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

Login rebuilder:プラグイン作ってみました(2019年4月22日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。