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



お勧め

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

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

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない(2011年9月27日 更新)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。