get_users()


WordPress関数get_users()は、サイトのユーザー情報を取得するために使用される関数です。この関数は、様々な条件でフィルタリングしてユーザーリストを取得することができます。

シンタックス

get_users( array $args = array() );

引数の説明:

  • $args (array) — ユーザーをフィルタリングするためのオプション配列。
  • role (string) — 特定のロールを持つユーザーのみを取得する。
  • meta_key (string) — 特定のメタキーを持つユーザーをフィルタリングする。
  • meta_value (string) — 特定のメタキーに一致する値を持つユーザーをフィルタリングする。
  • orderby (string) — ユーザーの並び替え基準（例: ‘ID’, ‘display_name’）。
  • order (string) — 並び替えの順序（’ASC’ または ‘DESC’）。

例1: 全てのユーザーのリストを取得する

次のコードは、全てのユーザーを取得して表示します。

<?php
$users = get_users();
foreach ( $users as $user ) {
    echo $user->display_name;
}
?>

例2: 特定のロールを持つユーザーを取得する

管理者ユーザーのみを取得するコードです。

<?php
$admins = get_users( array( 'role' => 'administrator' ) );
foreach ( $admins as $admin ) {
    echo $admin->display_name;
}
?>

例3: メタデータでフィルタリングする

特定のメタキーと値を持つユーザーを取得するコードです。

<?php
$users = get_users( array( 'meta_key' => 'favorite_color', 'meta_value' => 'blue' ) );
foreach ( $users as $user ) {
    echo $user->display_name;
}
?>

例4: ユーザーの並び替え

表示名で昇順に並び替えたユーザーを取得するコードです。

<?php
$users = get_users( array( 'orderby' => 'display_name', 'order' => 'ASC' ) );
foreach ( $users as $user ) {
    echo $user->display_name;
}
?>

例5: IDでユーザーを取得する

特定のIDを持つユーザーを取得するコードです。

<?php
$user = get_users( array( 'include' => array( get_current_user_id() ) ) );
echo $user[0]->display_name;
?>

関連機能：