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



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。