Product_Component_Shortcode_Controller
- Full name:
\BigCommerce\Rest\Product_Component_Shortcode_Controller - Parent class:
\BigCommerce\Rest\Rest_Controller
Methods
register_routes
public register_routes(): mixedget_rendered_item_params
public get_rendered_item_params(): mixedget_rendered_item_permissions_check
Checks if a given request has access to read the rendered shortcodes.
public get_rendered_item_permissions_check(\WP_REST_Request $request): true|\WP_ErrorParameters:
| Parameter | Type | Description |
|---|---|---|
$request | \WP_REST_Request | Full details about the request. |
Return Value:
True if the request has read access, WP_Error object otherwise.
get_rendered_item_schema
public get_rendered_item_schema(): mixedget_rendered_item
Retrieves a single shortcode
public get_rendered_item(\WP_REST_Request $request): \WP_REST_Response|\WP_ErrorParameters:
| Parameter | Type | Description |
|---|---|---|
$request | \WP_REST_Request | Full details about the request. |
Return Value:
Response object on success, or WP_Error object on failure.
Inherited methods
__construct
Rest_Controller constructor.
public __construct(string $namespace_base, string $version, string $rest_base): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$namespace_base | string | |
$version | string | |
$rest_base | string |
get_namespace
protected get_namespace(): mixedget_base_url
public get_base_url(): mixedparse_result
protected parse_result(mixed $response, mixed $client, mixed $rest_response = true): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$response | mixed | |
$client | mixed | |
$rest_response | mixed |
Automatically generated on 2025-01-21