get-users
Retrieve a filtered list of users from a WordPress site by specifying criteria like roles, capabilities, IDs, or slugs, using secure authentication and advanced query parameters.
Instructions
Get a list of users from a WordPress site with advanced filtering options
Input Schema
Name | Required | Description | Default |
---|---|---|---|
capabilities | No | Limit result set to users matching at least one specific capability | |
context | No | Scope under which the request is made | view |
exclude | No | Ensure result set excludes specific IDs | |
hasPublishedPosts | No | Limit result set to users who have published posts | |
include | No | Limit result set to specific IDs | |
offset | No | Offset the result set by a specific number of items | |
order | No | Order sort attribute ascending or descending | asc |
orderby | No | Sort collection by user attribute | name |
page | No | Current page of the collection | |
password | Yes | WordPress application password | |
perPage | No | Maximum number of items to be returned | |
roles | No | Limit result set to users matching at least one specific role | |
search | No | Limit results to those matching a string | |
siteUrl | Yes | WordPress site URL | |
slug | No | Limit result set to users with one or more specific slugs | |
username | Yes | WordPress username | |
who | No | Limit result set to users who are considered authors |