RestController
in package
REST Controller
Manages REST API route registration and provides route URLs to JavaScript
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- add_block_route_data() : array<string|int, mixed>
- add_route_data() : array<string|int, mixed>
- Add route URLs to localized script data
- initialize() : void
- Initialize REST controller
- register_rest_routes() : void
- Register REST routes
- add_default_args() : array<string|int, mixed>
- Decorates REST API routes with default args
Properties
$excluded
private
array<string|int, mixed>
$excluded
= []
$routes
private
array<string|int, mixed>
$routes
= []
Methods
__construct()
public
__construct(array<string|int, mixed> $routes[, array<string|int, mixed> $excluded = [] ]) : mixed
Parameters
- $routes : array<string|int, mixed>
-
Array of route instances
- $excluded : array<string|int, mixed> = []
-
Array of route class names to exclude from script data
add_block_route_data()
public
add_block_route_data(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed>add_route_data()
Add route URLs to localized script data
public
add_route_data(AssetDataApi $asset_data) : array<string|int, mixed>
Makes REST routes available to JavaScript via wcStripeSettings.restRoutes
Parameters
- $asset_data : AssetDataApi
-
Localized script data
Return values
array<string|int, mixed>initialize()
Initialize REST controller
public
initialize() : void
register_rest_routes()
Register REST routes
public
register_rest_routes() : void
add_default_args()
Decorates REST API routes with default args
private
add_default_args(array<string|int, mixed>|array<string|int, array<string|int, mixed>> $routes) : array<string|int, mixed>
Adds default permission_callback to allow public access (individual routes should implement their own auth if needed)
Parameters
- $routes : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
-
Route configuration