説明
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
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた（2019年11月5日 更新）
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta（generator）タグを取り除く（2018年5月27日 更新）
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する（2013年8月13日 更新）
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。