Option extends Base_Route implements Route
REST controller for the option route.
Tags
Interfaces, Classes and Traits
- Route
Table of Contents
- $model : Abstract_Model
- The model.
- $rest_base : mixed
- create() : WP_REST_Response|WP_Error
- Create a option
- delete() : WP_REST_Response|WP_Error
- Delete a option
- get() : WP_REST_Response|WP_Error
- Retrieve a option by ID.
- get_all() : WP_REST_Response|WP_Error
- Retrieve all options.
- get_all_by_group() : WP_REST_Response|WP_Error
- Retrieve all options.
- permission_callback() : bool
- Permission callback to access the routes.
- register_routes() : mixed
- Register the REST routes.
- reorder() : WP_REST_Response|WP_Error
- Reorder the options
- update() : WP_REST_Response|WP_Error
- Update a option
- get_option_schema() : mixed
- Retrieves the option schema for the update and create endpoints.
Properties
$model
The model.
protected
Abstract_Model
$model
Tags
$rest_base
protected
mixed
$rest_base
= 'options'
Tags
Methods
create()
Create a option
public
create(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —delete()
Delete a option
public
delete(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —get()
Retrieve a option by ID.
public
get(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —get_all()
Retrieve all options.
public
get_all(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —get_all_by_group()
Retrieve all options.
public
get_all_by_group(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —permission_callback()
Permission callback to access the routes.
public
permission_callback() : bool
Tags
Return values
bool —register_routes()
Register the REST routes.
public
register_routes() : mixed
Tags
Return values
mixed —reorder()
Reorder the options
public
reorder(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —update()
Update a option
public
update(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —get_option_schema()
Retrieves the option schema for the update and create endpoints.
private
get_option_schema() : mixed