GF_REST_Form_Entries_Controller
Source: includes/webapi/v2/includes/controllers/class-controller-form-entries.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 entries |
create_item() | Create one item from the collection |
get_items_permissions_check() | Check if a given request has access to get items |
create_item_permissions_check() | Check if a given request has access to create items |
get_collection_params() | Get the query params for collections |
get_item_schema() | Get the Entry schema, conforming to JSON Schema. |
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-entries.php:21
get_items()
public function get_items( $request )
Get a collection of entries
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-entries.php:52
create_item()
public function create_item( $request )
Create one item from the collection
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-entries.php:140
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-entries.php:179
create_item_permissions_check()
public function create_item_permissions_check( $request )
Check if a given request has access to create 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-entries.php:203
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-entries.php:260
get_item_schema()
public function get_item_schema()
Get the Entry schema, conforming to JSON Schema.
Returns
array
Since: 2.4-beta-1
Source: includes/webapi/v2/includes/controllers/class-controller-form-entries.php:298