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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

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

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

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。