WP_REST_Abilities_V1_List_Controller::get_collection_params │ public │ WP 6.9.0

Retrieves the query params for collections.

Method of the class: WP_REST_Abilities_V1_List_Controller{}

No Hooks.

Returns

Array. mixed> Collection parameters.

Usage

$WP_REST_Abilities_V1_List_Controller = new WP_REST_Abilities_V1_List_Controller();
$WP_REST_Abilities_V1_List_Controller->get_collection_params(): array;

Changelog

WP_REST_Abilities_V1_List_Controller::get_collection_params() WP REST Abilities V1 List Controller::get collection params code ^{WP 6.9.1}

public function get_collection_params(): array {
	return array(
		'context'  => $this->get_context_param( array( 'default' => 'view' ) ),
		'page'     => array(
			'description' => __( 'Current page of the collection.' ),
			'type'        => 'integer',
			'default'     => 1,
			'minimum'     => 1,
		),
		'per_page' => array(
			'description' => __( 'Maximum number of items to be returned in result set.' ),
			'type'        => 'integer',
			'default'     => 50,
			'minimum'     => 1,
			'maximum'     => 100,
		),
		'category' => array(
			'description'       => __( 'Limit results to abilities in specific ability category.' ),
			'type'              => 'string',
			'sanitize_callback' => 'sanitize_key',
			'validate_callback' => 'rest_validate_request_arg',
		),
	);
}