ワードプレスのget_users関数の使用方法・解説

概要

get_users関数は、WordPressサイトに登録されているユーザー情報を取得するための関数です。この関数は、特定の条件やフィルタに基づいてユーザー情報を取得することができ、様々な用途で利用されます。以下は、この関数がよく使用される機能の例です。

1. ユーザー一覧を表示する
2. 管理画面でのユーザー管理機能
3. 特定の役割を持つユーザーの取得
4. ウェブサイトの登録ユーザーの情報をリスト化する
5. フロントエンドでのユーザー情報の表示
6. ユーザーのカスタムフィールド情報の取得
7. 特定のユーザー情報をフィルタリングする
8. APIエンドポイントでのユーザー情報取得

構文

get_users( $args );

パラメータ

• $args (配列)（省略可能）
  • role: 特定のユーザー役割を持つユーザーのみを取得。
  • orderby: 結果を並べる基準（例: ‘ID’, ‘user_login’など）。
  • order: 並び順（’ASC’または’DESC’）。
  • number: 取得するユーザー数の制限。
  • offset: ユーザー取得の開始位置のオフセット。

戻り値

取得したユーザー情報の配列。ユーザーオブジェクトが格納されており、各ユーザーの詳細情報にアクセス可能です。

関連する関数

• get_user_by
• wp_get_current_user

使用可能なバージョン

get_users関数は、WordPress version 2.0.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: 全ユーザーを取得する

ユーザー情報を取得して表示します。

$users = get_users();
foreach ( $users as $user ) {
    echo $user->display_name . '<br>';
}

(引用元: WordPress Codex)

サンプル2: 特定の役割のユーザーを取得する

「editor」役割のユーザーのみ取得します。

$args = array('role' => 'editor');
$editors = get_users($args);
foreach ( $editors as $editor ) {
    echo $editor->display_name . '<br>';
}

(引用元: WordPress Codex)

サンプル3: ユーザーをIDでソート

ユーザー情報をIDの昇順で取得します。

$args = array('orderby' => 'ID', 'order' => 'ASC');
$users = get_users($args);
foreach ( $users as $user ) {
    echo $user->ID . ': ' . $user->display_name . '<br>';
}

(引用元: WordPress Codex)

サンプル4: 制限付きでユーザーを取得

最初の5人のユーザーのみを取得します。

$args = array('number' => 5);
$users = get_users($args);
foreach ( $users as $user ) {
    echo $user->display_name . '<br>';
}

(引用元: WordPress Codex)

サンプル5: オフセットを使った取得

ユーザーの6人目から10人目まで取得します。

$args = array('number' => 5, 'offset' => 5);
$users = get_users($args);
foreach ( $users as $user ) {
    echo $user->display_name . '<br>';
}

(引用元: WordPress Codex)