wp_list_users
List WordPress users with filtering by role or search to view roles, registration dates, and activity status.
Instructions
Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.
Usage Examples:
• List all users: wp_list_users
• Search users: wp_list_users --search="john"
• Filter by role: wp_list_users --roles=["editor","author"]
• Find admins: wp_list_users --roles=["administrator"]
• Combined search: wp_list_users --search="smith" --roles=["subscriber"]
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "wp_list_users"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | The ID of the WordPress site to target (from mcp-wordpress.config.json). Required if multiple sites are configured. | |
| roles | No | Limit results to users with specific roles. | |
| search | No | Limit results to those matching a search term. |