説明
パラメータ
- $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['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
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。
さくらのVPSでKUSANAGI#2(2018年5月27日 更新)
今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。