3テラバイト

プログラム関連備忘録サイト。主にゲーム。

WordPress

WordPressでユーザー一覧を取得する関数get_usersの使い方

投稿日:

こんにちは、今日はWordPressでユーザー一覧を取得することができる関数get_usersの使い方についてまとめていきます。

確認環境

WordPress 5.5.1

引数

キー説明
blog_idサイトID
role配列、またはカンマ区切りでユーザーが持っている必要のある権限を指定します。
指定した権限を全て持つユーザーを取得できます。
role__in配列でユーザー権限を指定します。
指定した権限のいずれかを持つユーザーを取得できます。
role__not_in配列でユーザー権限を指定します。
指定した権限のいずれかを持つユーザーを除外します。
meta_keyユーザーのmeta_keyを指定します。
meta_valueユーザーのmeta_valueを指定します。
meta_comparemeta_valueの比較演算子を指定します。
デフォルトは’=’で、その他以下の値が指定できます。
‘!=’、 ‘>’、 ‘> =’、 ‘<‘、 ‘<=’、
‘LIKE’、 ‘NOT LIKE’、 ‘IN’、 ‘NOT IN’、 ‘BETWEEN’、 ‘NOTBETWEEN’、’EXISTS’、’NOT EXISTS’、’REGEXP’、’NOT REGEXP’、’RLIKE’
includeリストに含めるユーザーIDを配列で指定します。
excludeリストから除外するユーザーIDを配列で指定します。
search検索キーワードを指定します。
search_columns検索するカラム名の配列を指定します。
以下の値が指定可能です。
‘ID’、 ‘user_login’、 ‘user_email’、 ‘user_url’、 ‘user_nicename’、 ‘display_name’
orderby並べ替えに使用するフィールドを指定します。
以下の値が指定可能です。
‘ID’、’display_name’(または’name’)、’include’、’user_login’(または’login’)、’login__in’、’user_nicename’(または’nicename’)、’nicename__in’、’user_email’(または ‘email’)、 ‘user_url’(または ‘url’)、 ‘user_registered’(または ‘registered’)、 ‘post_count’、 ‘meta_value’、 ‘meta_value_num’
‘meta_value’または ‘meta_value_num’を使用するには、meta_keyも定義する必要があります。
デフォルトは’user_login’です。
order並べ替えを昇順にするか降順にするか指定します。
以下の値が指定可能です。
‘ASC’、 ‘DESC’
offsetオフセット値を指定します。
ページネーション する際等に使用します。
numberクエリの数。
pagedページ数。
count_total条件に合致したユーザー総数をカウントするかどうかをtrueかfalseで指定します。
ページネーション が不要な場合はfalseを指定することによりパフォーマンスが向上します。
デフォルトではtrueになっています。
fieldsどのフィールドを返すかを文字列か配列で指定します。
全てのフィールドを返す場合は’all’で、これがデフォルトになっています。
その他以下の値が指定可能です。
‘ID’、 ‘display_name’、 ‘user_login’、 ‘user_nicename’、 ‘user_email’、 ‘user_url’、 ‘user_registered’
メタフィールドも含める場合は’all_with_meta’を指定します。
who
has_published_posts投稿タイプを指定すると、その投稿タイプの投稿を公開したユーザーのみ取得します。
nicenamenicenameを指定します。
nicename__in配列でuser_nicenameを指定します。
指定したuser_nicenameのいずれかに合致するユーザーを取得できます。
nicename__not_in配列でuser_nicenameを指定します。
指定したuser_nicenameのいずれにも合致しないユーザーを取得できます。
loginuser_loginを文字列で指定します。
login__inuser_loginを配列で指定します。
指定したuser_loginのいずれかに合致するユーザーを取得できます。
login__not_inuser_loginを配列で指定します。
指定したuser_loginのいずれにも合致しないユーザーを取得できます。

リンク

get_users() | Function | WordPress Developer Resources
https://developer.wordpress.org/reference/functions/get_users/

WP_User_Query | Class | WordPress Developer Resources
https://developer.wordpress.org/reference/classes/wp_user_query/

WP_User_Query::prepare_query() | Method | WordPress Developer Resources
https://developer.wordpress.org/reference/classes/WP_User_Query/prepare_query/

-WordPress


comment

メールアドレスが公開されることはありません。

関連記事

no image

WordPressで投稿、ページ、添付ファイル、カテゴリの管理者アクション一覧

こんにちは、今日はWordPressで投稿、ページ、添付ファイル、カテゴリの管理者アクションについてまとめていきます。 確認環境 WordPress 5.5.1 フック一覧 フック名説明post_su …

no image

WordPress管理者ログイン関連アクションフック一覧

こんにちは、今日はWordPressで管理者ログインに関連するアクションフックについてまとめていきます。 確認環境 WordPress 5.5.1 アクションフック一覧 フック名説明login_ini …

no image

WordPressで投稿一覧を取得する関数get_postsの使い方

こんにちは、今日はWordPressで投稿一覧を取得する関数、get_postsの使い方についてまとめていきます。 確認環境 WordPress 5.5.1 引数 キー説明attachment_id添 …

no image

WordPressのリダイレクト、リライト関連フィルターフック一覧

こんにちは、今日はWordPressのリダイレクト、リライト関連フィルターフックについてまとめていきます。 確認環境 WordPress 5.5.3 フィルターフック一覧 フック名説明allowed_ …

no image

WordPress著者、ユーザー関連のフィルターフック一覧

こんにちは、今日はWordPressの著者、ユーザー関連のフィルターフックについてまとめていきます。 確認環境 WordPress 5.5.1 フィルターフック一覧 フック名説明login_body_ …