get_users() の使い方｜説明・引数・注意点

説明

基本構文

get_users( array $args = array() ): array

引数

• $args：role、orderby、number、search、fields など

戻り値

ユーザーの配列。

使い方（サンプル）

$editors = get_users( array( 'role' => 'editor' ) );

注意点

• 既定ではユーザーオブジェクト（WP_User）の配列が返ります。fields で取得項目を絞れます。
• 数が多いサイトでは、number と paged で件数を絞ります。

実務での使いどころ

• 特定のロールのユーザーを、一覧で取得するとき。
• 投稿者の一覧を、ページに出すとき。
• IDだけが必要なとき（'fields' => 'ID'）。

よくあるミスと対処

• number を指定せず、ユーザーが多いサイトで、大量のデータを取得してしまう。
• role を指定せず、すべてのロールのユーザーが対象になる。
• 必要な項目だけでよいのに、fields を指定せず、すべてのデータを取得している。

NG例

$users = get_users(); // ユーザーが多いと、重くなる

OK例

$users = get_users( array(
	'role'    => 'author',
	'number'  => 20,
	'orderby' => 'display_name',
) );

使い分け早見表

関連項目

get_user_by()、count_users()

公式リファレンス：get_users() | Function | WordPress Developer Resources