説明
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
関連
お勧め
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
ツイート引用が簡単になる仕組み(2012年6月8日 更新)
WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
サイトヘルス機能を使ってみた(2019年4月12日 更新)
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)
ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。