GF_REST_Entry_Notes_Controller
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:7
Details
- Kind:
class - Namespace:
(global) - Extends: GF_REST_Controller
Properties
| Property | Type | Description |
|---|---|---|
$rest_base | string | Base for the REST request. |
Methods
| Method | Description |
|---|---|
register_routes() | Register the routes for the objects of the controller. |
get_items() | Get all notes for one entry. |
create_item() | Create one note. |
get_items_permissions_check() | Check if a given request has access to get items. |
get_item_permissions_check() | Check if a given request has access to get a specific item. |
create_item_permissions_check() | Check if a given request has access to create items. |
prepare_item_for_response() | Prepare the item for the REST response. |
update_item_permissions_check() | Check if a given request has access to update a specific item. |
delete_item_permissions_check() | Check if a given request has access to delete a specific item. |
Method Reference
register_routes()
public function register_routes()
Register the routes for the objects of the controller.
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:17
get_items()
public function get_items( $request )
Get all notes for one entry.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:52
create_item()
public function create_item( $request )
Create one note.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:113
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.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:149
get_item_permissions_check()
public function get_item_permissions_check( $request )
Check if a given request has access to get a specific item.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
- WP_Error |
bool
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:171
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.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:184
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
- WP_REST_Response — Returns the item wrapped in a WP_REST_Response object
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:232
update_item_permissions_check()
public function update_item_permissions_check( $request )
Check if a given request has access to update a specific item.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
- WP_Error |
bool
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:269
delete_item_permissions_check()
public function delete_item_permissions_check( $request )
Check if a given request has access to delete a specific item.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$request | WP_REST_Request | Full data about the request. |
Returns
- WP_Error |
bool
Since: 2.4.18
Source: includes/webapi/v2/includes/controllers/class-controller-entry-notes.php:293