LLMS_REST_API_Keys_Controller::get_collection_params()
Retrieves the query params for the objects collection.
Return Return
(array) Collection parameters.
Source Source
File: libraries/lifterlms-rest/includes/server/class-llms-rest-api-keys-controller.php
public function get_collection_params() {
$params = parent::get_collection_params();
$params['permissions'] = array(
'description' => __( 'Include only API keys matching a specific permission.', 'lifterlms' ),
'type' => 'string',
'enum' => array_keys( LLMS_REST_API()->keys()->get_permissions() ),
);
$params['user'] = array(
'description' => __( 'Include only keys for the specified user(s). Accepts a single id or a comma separated list of ids.', 'lifterlms' ),
'type' => 'string',
);
$params['user_not_in'] = array(
'description' => __( 'Exclude keys for the specified user(s). Accepts a single id or a comma separated list of ids.', 'lifterlms' ),
'type' => 'string',
);
return $params;
}
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0-beta.1 | Introduced. |