wp_list_users

説明

string wp_list_users( [ array $args = array() ] )
ユーザーリストを取得する。

パラメータ

  • $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'boolli要素で取得する場合は'list'をを指定(省略時は'list')
    'feed'stringユーザーフィードリンク用のテキストを指定(省略時は'')
    'feed_image'stringユーザーフィードリンク用の画像URLを指定(省略時は'')
    'feed_type'stringユーザーフィードのタイプ('rss2'や'atom'など)を指定(省略時は'')

返り値

パラメータ$args['echo']がtrueの場合は何も返さない。$args['echo']がfalseの場合は指定された書式でユーザーリストを返す。

注意

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

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

'html''style'内容
true'list'<li>ユーザー名1</li><li>ユーザー名2</li>
true''ユーザー名1, ユーザー名2
false'list'
false''

使用例

  • ユーザーリストを出力する。
    wp_list_users();
  • ユーザーリストを取得する。
    wp_list_users( array( 'echo' => false ) );

フィルター

[6.1.0]get_users関数でユーザー情報を取得する前に'wp_list_users_args'フィルターを呼び出す。パラメータ$query_argsにはget_users関数のパラメータが、$parsed_argsには本関数が受け取った内容にデフォルト値がマージされた内容が格納されている。
$query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/user.php

最終更新 : 2022年11月08日 13:45



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。