説明
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
関連
お勧め
query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)
投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。各種リンクを取得する関数一覧(2014年6月12日 更新)
サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。
子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)
少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)
「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。
JavaScriptテンプレートを使ってみた(2018年8月21日 更新)
「前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。