get_users

パラメータ

• $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'

返り値

注意

使用例

• すべてのユーザー情報を取得する。
  <?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' ) ); ?>

フィルター

アクション

ソースファイル