LLMS_REST_Users_Controller::get_pagination_data_from_query( WP_User_Query $query, array $prepared, WP_REST_Request $request )
Retrieve pagination information from an objects query.
Parameters Parameters
- $query
-
(WP_User_Query) (Required) Objects query result returned by LLMS_REST_Users_Controller::get_objects_query().
- $prepared
-
(array) (Required) Array of collection arguments.
- $request
-
(WP_REST_Request) (Required) Request object.
Return Return
(array) Array of pagination information.
- 'current_page'
(int) Current page number. - 'total_results'
(int) Total number of results. - 'total_pages'
(int) Total number of results pages.
Source Source
File: libraries/lifterlms-rest/includes/abstracts/class-llms-rest-users-controller.php
* @param WP_User_Query $query Objects query result returned by {@see LLMS_REST_Users_Controller::get_objects_query()}.
* @param array $prepared Array of collection arguments.
* @param WP_REST_Request $request Request object.
* @return array {
* Array of pagination information.
*
* @type int $current_page Current page number.
* @type int $total_results Total number of results.
* @type int $total_pages Total number of results pages.
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
| Version | Description |
|---|---|
| 1.0.0-beta.1 | Introduced. |