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



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。