API / Minn\Rest / UserListArgs

UserListArgs final class

Minn\Rest\UserListArgs · public/minn/src/Minn/Rest/UserListArgs.php · 47 lines

The WP_User_Query arguments a user list request makes, as the reference makes them before rest_user_query (probe rest-user-lists): each declared parameter the request carries under its query name (a search wrapped in wildcards), the offset (the page's when none is given), the orderby name mapped to the query's, the published authors (every REST post type, for a reader who may not list users), the authors shorthand, the search columns (a reader who may not list users searches names and logins only), and ids alone for a HEAD request.

Used by 1

UsersController

Constants and properties

private	`MAPPINGS` = `array ( 'exclude' => 'exclude', 'include' => 'include', 'order' => 'order', 'per_page' => 'number', 'search' => 'search', 'roles' => 'role__in', 'capabilities' => 'capability__in', 'slug' => 'nicename__in', )`
private	`ORDERBY` = `array ( 'id' => 'ID', 'include' => 'include', 'name' => 'display_name', 'registered_date' => 'registered', 'slug' => 'user_nicename', 'include_slugs' => 'nicename__in', 'email' => 'user_email', 'url' => 'user_url', )`
private	`COLUMNS` = `array ( 'email' => 'user_email', 'name' => 'display_name', 'id' => 'ID', 'username' => 'user_login', 'slug' => 'user_nicename', )`
private	`PUBLIC_COLUMNS` = `array ( 0 => 'ID', 1 => 'user_login', 2 => 'user_nicename', 3 => 'display_name', )`

Public

static

of(WP_REST_Request $wp, array $registered, string $method, array $types, string $reader): array#

The arguments before plugins see them, for a reader who is a 'lister' (may list users) or 'public'.

`$registered`	`array<string, mixed>`	the collection, as rest_user_collection_params left it
`$types`	`array<string, string>`	the REST post types, by name

@return array<string, mixed>