概要
wp_list_users 関数は、WordPress のユーザーリストを取得するための便利な機能です。主に以下のような場合に使用されます。
- ユーザー管理ページの表示
- カスタムダッシュボードウィジェットの作成
- メンバーシップサイトのユーザーリスト表示
- 特定の役割を持つユーザーのフィルタリング
- フロントエンドでのユーザーリストの表示
- コメントの投稿者リストの表示
- ニュースレターへの登録ユーザーの管理
- プロフィールページにおけるユーザー情報の表示
構文
wp_list_users( $args );
パラメータ
$args(array): ユーザーリストを取得する際のオプションを配列で指定します。主なオプションには以下が含まれます。orderby: ユーザーの並び順（デフォルトは ‘display_name’）order: 並び順（’ASC’ または ‘DESC’）number: 取得するユーザーの数role: 取得するユーザーの役割
戻り値
- (string): 指定された条件にマッチするユーザーのリストをHTML形式で返します。
関連する関数
使用可能なバージョン
- WordPress バージョン 2.5.0 以降で使用可能
コアファイルのパス
wp-includes/user.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプル1: 基本的なユーザーリストの表示
このサンプルでは、デフォルトの設定で全てのユーザーをリスト表示します。
<?php
wp_list_users();
?>
サンプル2: 特定の役割のユーザーを表示
このコードは、”subscriber”（登録ユーザー）という役割を持つユーザーのみを表示します。
<?php
wp_list_users( array( 'role' => 'subscriber' ) );
?>
サンプル3: ユーザーをアルファベット順に並べる
このサンプルでは、ユーザーを名前の昇順で並べ替えて表示します。
<?php
wp_list_users( array( 'orderby' => 'display_name', 'order' => 'ASC' ) );
?>
サンプル4: 最初の5人のユーザーを表示
このサンプルコードは、取得するユーザーを5人に制限して表示します。
<?php
wp_list_users( array( 'number' => 5 ) );
?>
サンプル5: ユーザーリストのカスタマイズ
このサンプルでは、カスタムHTMLを使ってユーザーリストを表示します。
<?php
wp_list_users( array( 'style' => 'list', 'echo' => false ) );
?>
これで、wp_list_users 関数に関する基本的な理解が得られ、いくつかのサンプルコードを通じて具体的な使用例を見ることができました。