説明
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
関連
お勧め
子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（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）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここではホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。