Route

A fluent factory for league/route.

it is recommended to use router along with a dependency injection container, like league/container.

$container = $this->getContainer();
$route = $container->add( RouteInterface::class, function () {
    return new Route(
        $container->get( Router::class ),
        $container->get( ServerRequestInterface::class ),
        $container->get( ResponseResolverInterface::class )
    );
} );

$route
    ->middleware([
         new MyGlobalMiddleware(),
         new SomeGlobalMiddleware()
    ])
    ->file('/absolute/path/to/some/routes/file.php')
    ->rewrite('wp-rewrite-query-var')
    ->dispatch()
    ->resolve();

Middleware

Pass an array of global middleware to be applied to all routes.

$route
    ->middleware([
         new MyGlobalMiddleware(),
         new SomeGlobalMiddleware()
    ])

File

Allows you to include routes from a separate routes file.

$route->file('/absolute/path/to/some/routes/file.php')

Rewrite

Connect the routes to the WordPress rewrite engine. Takes a WP query var name.

$route
    ->rewrite('wp-rewrite-query-var')

Dispatch

Dispatch the router to connect the route with a controller method.

$route
    ->dispatch();

Resolve

Fires the response renderer. You may choose to use CodeZone\WPSupport\Router\ResponseResolver, which renders the PSR7 responses to basic WordPress style or JSON responses.

$route->resolve();

Last modified: 09 September 2024