説明
array get_users( [ array $args = array() ] )
ユーザー情報を取得する。
パラメータ
- $args絞り込み条件を連想配列で指定する（省略時は、array()）。
キー名 意味 値の例 blog_id ブログIDを指定 1 role ロール（'administrator'、'editor'、'author'、'contributor'、'subscriber'など）を指定 'administrator' meta_key ユーザーメタ情報のキー名を指定 'wp_user_level' meta_value ユーザーメタ情報の値を指定 5 meta_compare ユーザーメタ情報の比較情景（'<'、'>'、'='、'!='など）を指定 '<' include 取得するユーザーIDを配列で指定 array(1,2) exclude 除外するユーザーIDを配列で指定 array(0) search 検索キーワードを指定（キーワードの前後に'*'指定可） 'ad*' search_columns 検索項目（'ID'、'user_login'、'user_email'、'user_url'、'user_nicename'のいずれか）を指定 'display_name''search'で指定した値により異なるorderby ソート対象の項目名を指定（省略時は'user_login'） 'user_nicename' order ソート順として'ASC'または'DESC'を指定（省略時は'DESC'） 'ASC' offset 取得位置を指定（number省略時は無効） 10 number 取得件数を指定 5 fields 取得する項目を配列で指定（省略時はすべて） array( 'ID', 'display_name' ) who 'authors'以外は無効 'authors'
返り値
条件にマッチしたユーザー情報（オブジェクト）の配列を返す。ユーザー情報は次の通り。| 項目名 | 意味 |
|---|---|
| ID | ユーザーID |
| user_login | ログイン名 |
| user_pass | ログインパスワードのハッシュ値 |
| user_nicename | ユーザー名 |
| user_email | メールアドレス |
| user_url | ホームページURL |
| user_registered | 登録日時 |
| user_activation_key | アクティベーションキー |
| user_status | ステータス |
| spam | スパムフラグ |
| deleted | 削除フラグ |
注意
内部ではWP_User_Queryクラスを利用してユーザー情報を取得している。使用例
- すべてのユーザー情報を取得する。<?php $users = get_users(); ?>
- 表示名が'ad'から始まるユーザー情報を取得する。<?php $users = get_users( array( 'search' => 'ad*', 'search_columns' => 'display_name' ); ?>
- 11件目から5件のユーザー情報を取得する。<?php $users = get_users( array( 'offset' => 10, 'number' => 5 ); ?>
- 一部（ここではID、メールアドレス、表示名）のユーザー情報を取得する。<?php $users = get_users( array( 'fields' => array( 'ID','user_email','display_name' ) ); ?>
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/user.php最終更新 : 2017年11月27日 11:09
関連
お勧め
投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）
4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。
ブロックエディターの色設定を変えてみる（2019年12月11日 更新）
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
5.3の新機能：日付とタイムゾーン（2019年10月2日 更新）
「WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。
ショートコードを含んだページを表示する前に何か処理する（2014年5月28日 更新）
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。
Emojin：プラグイン作ってみました（2015年3月21日 更新）
ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。