Class CMB2_REST_Controller_Boxes

CMB2 objects/boxes endpoint for WordPres REST API. Allows access to boxes configuration data.

CMB2_REST_Controller_Boxes

Direct known subclasses

CMB2_REST_Controller_Fields

Package: CMB2
Category: WordPress_Plugin
License: GPL-2.0+
Author: CMB2 team
Since: 2.2.3
Link: https://cmb2.io
Todo: Add better documentation.
Todo: Research proper schema.
Located at includes/rest-api/CMB2_REST_Controller_Boxes.php

Methods summary

`public`	# `__construct( WP_REST_Server $wp_rest_server )` Constructor Constructor Since 2.2.3 Overrides `CMB2_REST_Controller::__construct`
`public`	# `register_routes( )` Register the routes for the objects of the controller. Register the routes for the objects of the controller. Since 2.2.3 Overrides `WP_REST_Controller::register_routes`
`public WP_Error\|boolean`	# `get_items_permissions_check( WP_REST_Request $request )` Check if a given request has access to get boxes. Check if a given request has access to get boxes. Parameters `$request` Full data about the request. Returns WP_Error\|boolean Since 2.2.3 Overrides `WP_REST_Controller::get_items_permissions_check`
`public WP_Error\|WP_REST_Response`	# `get_items( WP_REST_Request $request )` Get all public CMB2 boxes. Get all public CMB2 boxes. Parameters `$request` Full data about the request. Returns WP_Error\|WP_REST_Response Since 2.2.3 Overrides `WP_REST_Controller::get_items`
`public WP_Error\|boolean`	# `get_item_permissions_check( WP_REST_Request $request )` Check if a given request has access to a box. By default, no special permissions needed, but filtering return value. Check if a given request has access to a box. By default, no special permissions needed, but filtering return value. Parameters `$request` Full details about the request. Returns WP_Error\|boolean Since 2.2.3 Overrides `WP_REST_Controller::get_item_permissions_check`
`public WP_Error\|boolean`	# `get_item_permissions_check_filter( boolean $can_access = true )` Check by filter if a given request has access to a box. By default, no special permissions needed, but filtering return value. Check by filter if a given request has access to a box. By default, no special permissions needed, but filtering return value. Parameters `$can_access` Whether the current request has access to view the box by default. Returns WP_Error\|boolean Since 2.2.3
`public WP_Error\|WP_REST_Response`	# `get_item( WP_REST_Request $request )` Get one CMB2 box from the collection. Get one CMB2 box from the collection. Parameters `$request` Full data about the request. Returns WP_Error\|WP_REST_Response Since 2.2.3 Overrides `WP_REST_Controller::get_item`
`public array`	# `get_rest_box( )` Get a CMB2 box prepared for REST Get a CMB2 box prepared for REST Returns array Since 2.2.3
`protected array`	# `prepare_links( CMB2_REST $cmb )` Return an array of contextual links for box/boxes. Return an array of contextual links for box/boxes. Parameters `$cmb` CMB2_REST object to build links from. Returns array Array of links Since 2.2.3

Methods inherited from CMB2_REST_Controller

get_cb_results(), get_intial_request_type(), get_intial_route(), get_item_schema(), get_query_string(), initiate_request(), initiate_rest_box(), initiate_rest_edit_box(), initiate_rest_read_box(), maybe_hook_callback_and_apply_filters(), maybe_hook_registered_callback(), maybe_unhook_registered_callback(), prepare_item(), prepare_item_for_response()

Properties summary

`protected string`	`$rest_base` The base of this controller's route. The base of this controller's route.	# `'boxes'`
`protected string`	`$namespace_base` The combined $namespace and $rest_base for these routes. The combined $namespace and $rest_base for these routes.	# `''`

Properties inherited from CMB2_REST_Controller

$field, $namespace, $object_id, $object_type, $request, $request_type, $rest_box, $route, $server

`public`	# `__construct( WP_REST_Server $wp_rest_server )` Constructor Constructor Since 2.2.3 Overrides `CMB2_REST_Controller::__construct`
`public`	# `register_routes( )` Register the routes for the objects of the controller. Register the routes for the objects of the controller. Since 2.2.3 Overrides `WP_REST_Controller::register_routes`
`public WP_Error\|boolean`	# `get_items_permissions_check( WP_REST_Request $request )` Check if a given request has access to get boxes. Check if a given request has access to get boxes. Parameters `$request` Full data about the request. Returns WP_Error\|boolean Since 2.2.3 Overrides `WP_REST_Controller::get_items_permissions_check`
`public WP_Error\|WP_REST_Response`	# `get_items( WP_REST_Request $request )` Get all public CMB2 boxes. Get all public CMB2 boxes. Parameters `$request` Full data about the request. Returns WP_Error\|WP_REST_Response Since 2.2.3 Overrides `WP_REST_Controller::get_items`
`public WP_Error\|boolean`	# `get_item_permissions_check( WP_REST_Request $request )` Check if a given request has access to a box. By default, no special permissions needed, but filtering return value. Check if a given request has access to a box. By default, no special permissions needed, but filtering return value. Parameters `$request` Full details about the request. Returns WP_Error\|boolean Since 2.2.3 Overrides `WP_REST_Controller::get_item_permissions_check`
`public WP_Error\|boolean`	# `get_item_permissions_check_filter( boolean $can_access = true )` Check by filter if a given request has access to a box. By default, no special permissions needed, but filtering return value. Check by filter if a given request has access to a box. By default, no special permissions needed, but filtering return value. Parameters `$can_access` Whether the current request has access to view the box by default. Returns WP_Error\|boolean Since 2.2.3
`public WP_Error\|WP_REST_Response`	# `get_item( WP_REST_Request $request )` Get one CMB2 box from the collection. Get one CMB2 box from the collection. Parameters `$request` Full data about the request. Returns WP_Error\|WP_REST_Response Since 2.2.3 Overrides `WP_REST_Controller::get_item`
`public array`	# `get_rest_box( )` Get a CMB2 box prepared for REST Get a CMB2 box prepared for REST Returns array Since 2.2.3
`protected array`	# `prepare_links( CMB2_REST $cmb )` Return an array of contextual links for box/boxes. Return an array of contextual links for box/boxes. Parameters `$cmb` CMB2_REST object to build links from. Returns array Array of links Since 2.2.3

Packages

Classes

Functions

Hooks

Class CMB2_REST_Controller_Boxes

Direct known subclasses

Methods summary

Since

Overrides

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Returns

Since

Parameters

Returns

Since

Methods inherited from CMB2_REST_Controller

Methods inherited from WP_REST_Controller

Properties summary

Properties inherited from CMB2_REST_Controller