List users
wp_list_usersList WordPress user accounts page by page, optionally filtered by role or search term, and return matching user details plus the total count across all pages.
Instructions
List the user accounts of this site, one page at a time, optionally filtered by role or a search term. Returns users (id, login, email, name = display name, roles) and total, the number of matches across all pages. Needs list_users. One account with first and last name and registration date: wp_get_user; profile fields: wp_get_user_meta.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, starting at 1. Default 1. | |
| role | No | Only users with this role slug, e.g. administrator, editor, author, contributor, subscriber or a role a plugin added. Omitted: every role. | |
| search | No | WordPress picks the fields by the term: with "@" the email, starting with http:// or https:// the URL (on a large multisite network the general fields instead), a number the login (or the exact id), otherwise login, email, URL, nicename and display name; matched anywhere in the field. Omitted: no filter. | |
| per_page | No | Users per page, 1 to 100 (values outside are clamped). Default 20. |