wp_list_users()


WordPress関数wp_list_users()は、登録されたユーザーをリスト形式で表示するために使用されます。この関数を使用することで、特定の条件に基づいてユーザーリストを出力できます。

構文

wp_list_users( array $args = array() );

引数の説明:

  • $args (array) — 配列形式で指定された引数を受け取ります。以下の項目が含まれます。
    • role (string) — 特定のユーザー権限でフィルタリングします。
    • orderby (string) — ソート順を指定します。例: 'login', 'email', 'registered'。
    • order (string) — 昇順または降順を指定します。例: 'ASC', 'DESC'。
    • number (int) — 表示するユーザー数を制限します。
    • search (string) — 指定した文字列を含むユーザーを検索します。

例 1: 全てのユーザーを表示

以下のコードは全ての登録ユーザーを表示します。

<?php
wp_list_users();
?>

例 2: 管理者権限を持つユーザーのみを表示

以下のコードは管理者権限を持つユーザーのみをリストします。

<?php
wp_list_users( array( 'role' => 'administrator' ) );
?>

例 3: 名前順でユーザーを並べ替え

以下のコードはログイン名でユーザーを昇順に並べ替えます。

<?php
wp_list_users( array( 'orderby' => 'login', 'order' => 'ASC' ) );
?>

例 4: 特定の文字列を含むユーザーを検索

以下のコードはログイン名に「test」を含むユーザーを検索して表示します。

<?php
wp_list_users( array( 'search' => '*test*' ) );
?>

例 5: 表示するユーザー数を制限

以下のコードは最初の5人のユーザーのみを表示します。

<?php
wp_list_users( array( 'number' => 5 ) );
?>

例 6: 特定の順序でフィルタリングされたユーザーのリスト

次のコードはメールアドレスで並べ替え、降順でユーザーをリストします。

<?php
wp_list_users( array( 'orderby' => 'email', 'order' => 'DESC' ) );
?>

関連機能：