List WordPress Users
wp_list_usersList WordPress users with search, role filters, and pagination. Use edit context to include roles and capabilities for security audits.
Instructions
List users on the WP site. Use context='edit' to see roles/capabilities (requires admin).
Args:
limit (number): Page size, 1-100. Default 20.
offset (number): Pagination offset.
search (string): Optional keyword filter (matches username, email, name).
roles (string[]): Optional filter to users in these roles.
orderby (enum): id | name | registered_date | slug | include. Default 'name'.
order (enum): asc | desc. Default 'asc'.
context (enum): view | embed | edit. Default 'view'. Use 'edit' to get roles/capabilities.
response_format (enum): markdown | json. Default 'markdown'.
Returns: Paginated envelope of WPUserItem objects with shape: { id, name, slug, url, description, link, roles?, capabilities?, registered_date? }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum results to return (1-100). Default 20. | |
| order | No | Sort direction. | asc |
| roles | No | Filter to users in any of these roles (e.g. ['administrator', 'editor']). | |
| offset | No | Number of results to skip for pagination. Default 0. | |
| search | No | Search term to match against username, email, name. | |
| context | No | WP REST context. 'edit' returns roles/capabilities/email but requires list_users capability. | view |
| orderby | No | Sort field. | name |
| response_format | No | Output format: 'markdown' for human-readable, 'json' for machine-readable. | markdown |