better-route: CORS and preflight
Define an explicit origin policy and attach it before declaring the routes that should inherit it.
use BetterRoute\Middleware\Cors\CorsMiddleware;
use BetterRoute\Middleware\Cors\CorsPolicy;
$cors = new CorsMiddleware(new CorsPolicy(
allowedOrigins: ['https://app.example.com'],
allowedMethods: ['GET', 'POST', 'PATCH', 'DELETE', 'OPTIONS'],
allowCredentials: true,
maxAgeSeconds: 600,
));
$router->middleware([$cors]);
$router->get('/catalog', $catalog)->publicRoute();
$router->patch('/account', $update)
->protectedByMiddleware('cookieNonce')
->middleware([$cookieNonce]);
$router->options('/account', static fn () => null)
->publicRoute();
Router middleware is captured when each route is declared. Add global/group CORS before declaring those routes, or attach it per route.
1.1 WordPress bridge
CorsMiddleware implements WordPressRouteMiddlewareInterface. During Router::register(), every matched route is registered with WordPressCorsBridge.
The bridge:
- answers a matched preflight on
rest_pre_dispatchbefore the normal route callback/middleware auth flow; - returns
204for allowed preflight; - returns
403 cors_origin_deniedfor a disallowed origin when rejection is enabled; - removes WordPress core CORS headers for matched routes and emits the configured policy on
rest_pre_serve_request; - preserves unrelated
Varytokens while managingVary: Origin.
This prevents WordPress core from broadening or contradicting the application allowlist. It affects only registered Better Route paths carrying this middleware.
Every raw route denies by default in 1.1. If an explicit Router::options() route is needed, call publicRoute() or another deliberate permission method. Keep business logic out of preflight handlers.
Defaults
Default allowed request headers include:
AuthorizationContent-TypeIdempotency-KeyIf-MatchIf-None-MatchX-Request-IDX-WP-Nonce
Default exposed response headers include ETag, Idempotency-Replayed, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.
Add Retry-After to exposedHeaders if browser JavaScript must read it from a 429 response.
Validation and security
CorsPolicy validates configured origins, methods, request header names, response header names, and non-negative max age. Invalid tokens or header-injection characters throw during construction.
Never combine wildcard origin with credentials:
// Throws InvalidArgumentException.
new CorsPolicy(['*'], allowCredentials: true);
Use * only for a non-credentialed public API. With credentials, list exact http/https origins. CORS is a browser policy, not authentication or CSRF protection; keep auth/nonce/signature middleware in place.
rejectDisallowedOrigins: false omits CORS headers for a disallowed origin instead of returning 403. Use that only when non-browser callers should continue and browsers should enforce the denial by absence of headers.
Smoke checks
curl -i -X OPTIONS 'https://example.com/wp-json/myapp/v1/account' \
-H 'Origin: https://app.example.com' \
-H 'Access-Control-Request-Method: PATCH' \
-H 'Access-Control-Request-Headers: Authorization, Content-Type, If-Match'
Verify:
- allowed origin gets
204and only configured CORS headers; - denied origin gets 403 or no CORS headers according to policy;
- credentials never appear with
Access-Control-Allow-Origin: *; - normal success and error responses get the same authoritative allow-origin policy;
- WordPress core does not leave a second/conflicting allow-origin header.
Related skills
- Use
br-routesfor raw OPTIONS access intent. - Use
br-auth-middlewarefor identity; CORS does not authenticate. - Use
br-etag-cacheandbr-rate-limitingwhen exposing their headers to browser code.
References
- Verified source paths:
src/Middleware/Cors/CorsMiddleware.phpsrc/Middleware/Cors/CorsPolicy.phpsrc/Middleware/Cors/WordPressCorsBridge.phpsrc/Middleware/WordPressRouteMiddlewareInterface.php