GF_REST_Form_Results_Controller
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:7
Details
- Kind:
class - Namespace:
(global) - Extends: GF_REST_Controller
Properties
| Property | Type | Description |
|---|---|---|
$rest_base | string |
Methods
| Method | Description |
|---|---|
register_routes() | Register the routes for the objects of the controller. |
get_items() | Get a collection of results. |
get_items_permissions_check() | Check if a given request has access to get items |
prepare_item_for_response() | Prepare the item for the REST response |
get_collection_params() | Get the query params for collections |
Method Reference
register_routes()
public function register_routes()
Register the routes for the objects of the controller.
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:21
get_items()
public function get_items( $request )
Get a collection of results.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:52
get_items_permissions_check()
public function get_items_permissions_check( $request )
Check if a given request has access to get items
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
- WP_Error |
bool
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:75
prepare_item_for_response()
public function prepare_item_for_response( $item, $request )
Prepare the item for the REST response
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$item | mixed | WordPress representation of the item. | |
$request | WP_REST_Request | Request object. |
Returns
mixed
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:99
get_collection_params()
public function get_collection_params()
Get the query params for collections
Returns
array
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-results.php:112