Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Ahondev/portfolio-v2/llms.txt
Use this file to discover all available pages before exploring further.
WP SSR Framework ships two completely independent routers: a Web Router that intercepts every front-end request before WordPress ever renders a template, and an API Router built on top of the WP REST API that exposes a clean /api/v1/ namespace. Both are configured in plain PHP files you edit directly — no admin UI, no database rows, no rewrite-rule archaeology.
Web Router
The Web Router owns every non-WordPress URL. On every request WebRouter::handleRequest() runs early in the WordPress boot cycle and either serves a response or returns false to fall through to normal WordPress processing.Routes are registered in configuration/routes/web.php using the WebRoute facade (aliased as Route inside that file).Static routes
// configuration/routes/web.php
use Ahon\WPCMS\Routing\Web\WebRoute as Route;
Route::get('/', 'Accueil', [HomeController::class, 'home']);
Route::get('/agence', 'Agence', [HomeController::class, 'agence']);
Route::get('/devis', 'Devis', [HomeController::class, 'devis']);
Route::get('/contact', 'Contact', [HomeController::class, 'contact']);
WebRoute::get() signature:WebRoute::get(string $path, string $name, array $controller): WebRouteDefinition
| Parameter | Type | Description |
|---|
$path | string | Absolute URL path, e.g. /contact |
$name | string | Human-readable page title used for WP registration |
$controller | array | Two-element array: [ControllerClass::class, 'method'] |
WebRoute::post() signature:WebRoute::post(string $path, string $controller, string $name, bool $auth = false): WebRouteDefinition
| Parameter | Type | Description |
|---|
$path | string | Absolute URL path, e.g. /submit |
$controller | string | Controller class name |
$name | string | Human-readable route name |
$auth | bool | When true, requires an active WordPress session |
WebRouteDefinition object, which stores the HTTP method, path, controller class, and action name.CPT routes
Route::CPT() is a convenience helper that binds an archive and a single route for a Custom Post Type in one call. The path serves as the base URL prefix.Route::CPT('/services', Service::class, ServiceController::class);
Route::CPT('/realisations', Realisation::class, RealisationController::class);
Route::CPT('/blog', Article::class, BlogController::class);
WebRoute::CPT(string $path, string $postType, string $controller): void
| Parameter | Type | Description |
|---|
$path | string | Base URL prefix, e.g. /blog |
$postType | string | EloquentCPT class that exposes a $model static property |
$controller | string | Controller class implementing CPTControllerInterface |
GET /blog → calls BlogController::archive()GET /blog/my-article-slug → looks up the post by slug, then calls BlogController::single(?EloquentCPT $post)
Route groups
Use Route::group() to apply a shared prefix to several routes at once:Route::group('/admin', [
Route::get('/dashboard', 'Dashboard', [AdminController::class, 'dashboard']),
Route::get('/settings', 'Settings', [AdminController::class, 'settings']),
]);
WebRoute::group(string $prefix, array $route_ids): void
Dispatch flow
WebRouter::handleRequest() executes the following logic on every inbound request:Skip WordPress-owned paths
Requests starting with /wp/, /api/, /uploads/, /admin, or /client are ignored immediately — WordPress handles them normally.
Bot detection & static cache
BotDetector::isBot() inspects the User-Agent. If a bot is detected, the router looks for a pre-generated HTML file under cache/client/static/{slug}.html. When found, it streams the file with X-SSG-Cache: HIT and exits. The ?json=1 query param bypasses the cache even for bots.
Static route lookup
The current URI is matched against the $routes hash map. If an exact match is found the corresponding controller method is called and its output echoed.
CPT route matching
Each registered CPT base path is checked. An exact match dispatches to archive(); a path that starts with the base followed by a slug segment dispatches to single() after fetching the matching WP_Post by slug.
Fall through
If no route matched, handleRequest() returns false and WordPress renders the request normally.
Dev-mode auto page registration
When WP_ENV=development, every call to addRoute() also calls registerPage() internally. This inserts a WordPress Page post whose slug mirrors the route path, so that ACF field groups scoped to post_type = page are always available for the route in the WordPress admin — without you having to create pages by hand.// Happens automatically in development — no action required
$router->registerPage($route); // wp_insert_post([...]) if page doesn't exist
API Router
The API Router registers REST routes under the api/v1 namespace, reachable at:
/wp-json/api/v1/… — standard WP REST URL/api/v1/… — short URL via Nginx/Apache rewrite rule
Routes are loaded from configuration/routes/api.php — your application routes file.Registering routes
// configuration/routes/api.php
use Ahon\WPCMS\Routing\Api\ApiRoute as Route;
Route::post('/contact', [ContactController::class, 'contact']);
Route::post('/devis', [ContactController::class, 'devis']);
ApiRoute::get(string $path, array $controller, bool $auth = false): ApiRouteDefinition
ApiRoute::post(string $path, array $controller, bool $auth = false): ApiRouteDefinition
ApiRoute::put(string $path, array $controller, bool $auth = false): ApiRouteDefinition
ApiRoute::patch(string $path, array $controller, bool $auth = false): ApiRouteDefinition
ApiRoute::delete(string $path, array $controller, bool $auth = false): ApiRouteDefinition
| Parameter | Type | Description |
|---|
$path | string | Route path relative to api/v1, e.g. /contact |
$controller | array | [ControllerClass::class, 'method'] |
$auth | bool | When true, requires an active WordPress session (is_user_logged_in()) |
Route groups
Route::group('/ssg', [
Route::post('/page', [SSGController::class, 'page']),
Route::post('/all', [SSGController::class, 'all']),
Route::delete('/delete', [SSGController::class, 'delete']),
]);
Route::group() prepends the prefix to every route definition passed in the array. The grouped routes end up registered as /api/v1/ssg/page, /api/v1/ssg/all, etc.Middleware
Chain ->middlewares() on any route definition to attach one or more middleware classes. Each middleware must implement a handle(WP_REST_Request $request) method that returns true to continue, false to deny, or a WP_Error to return a custom error response.Route::get('/health', [AppController::class, 'health'])
->middlewares([
\Ahon\WPCMS\App\Middlewares\HealthAuthGuard::class,
]);
Authentication
Set $auth = true to require a logged-in WordPress user. The check runs in the REST permission_callback before any middleware:Route::get('/protected', [SecureController::class, 'index'], true);
WordPress session authentication relies on the standard X-WP-Nonce header or cookie authentication. If you need token-based auth, implement it as a middleware instead.
