wp_list_users

パラメータ

• $args
  オプションを連想配列を指定（省略時はarray()）。ユーザー情報の取得に関連するパラメータは次の通り。

  キー	型	内容
  'orderby'	string	ソート対象の項目名を指定（省略時は'name'）
  'order'	string	ソート順として'ASC'または'DESC'を指定（省略時は'ASC'）
  'number'	int	取得件数を指定（省略時は''）
  'exclude'	string | array	取得するユーザーIDを配列またはカンマ区切りの文字列で指定（省略時は''）
  'include'	string | array	除外するユーザーIDを配列またはカンマ区切りの文字列で指定（省略時は''）

  出力に関連するパラメータは次の通り。

  キー	型	内容
  'echo'	bool	ユーザーリストを出力（表示）する場合はtrueを指定（省略時はtrue）
  'exclude_admin'	bool	ユーザー情報のdisplay_nameが'admin'を除外する場合はtrueを指定（省略時はtrue）
  'show_fullname'	bool	ユーザー情報のfirst_nameとlast_nameを連結したものを適用する場合はtrueを、display_nameを適用する場合はfalseを指定（省略時はfalse）
  'html'	bool	'style'キーの内容を適用する場合はtrueを指定（省略時はtrue）
  'style'	bool	li要素で取得する場合は'list'をを指定（省略時は'list'）
  'feed'	string	ユーザーフィードリンク用のテキストを指定（省略時は''）
  'feed_image'	string	ユーザーフィードリンク用の画像URLを指定（省略時は''）
  'feed_type'	string	ユーザーフィードのタイプ（'rss2'や'atom'など）を指定（省略時は''）

返り値

注意

パラメータ$argsには、 get_users関数で使われるものがあるが、省略時に適用される内容はget_users関数とは異なるので注意したい。

パラメータ$args['html']がfalseの場合はカンマ区切りとなり、$args['html']をtrueにし、$args['style']に'list'以外が指定された場合もカンマ区切りとなる（この関数内のカンマ区切りはカンマの後にスペースが入る）。

使用例

• ユーザーリストを出力する。

  wp_list_users();

• ユーザーリストを取得する。

  wp_list_users( array( 'echo' => false ) );

フィルター

$query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );

アクション

ソースファイル