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

最終更新 : 2024年11月21日 11:23



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。