What is a Regex Route?

A Regex Route allows you to define highly customized and flexible URL patterns using regular expressions. This is helpful when standard route types like Literal or Segment are too limited.

Use Case Examples:

Full Example

Step 1: Route Configuration (module/Application/config/module.config.php)

use Application\Controller\MainController;

'router' => [
  'routes' => [
    'archive' => [
      'type' => \Laminas\Router\Http\Regex::class,
      'options' => [
        'regex' => '/archive/(?<year>[0-9]{4})/(?<month>[0-9]{2})',
        'defaults' => [
          'controller' => MainController::class,
          'action' => 'show',
        ],
        'spec' => '/archive/%year%/%month%',
      ],
    ],
  ],
],

Step 2: Controller Setup (module\Application\src\Controller\MainController.php)

namespace Application\Controller;

use Laminas\Mvc\Controller\AbstractActionController;
use Laminas\View\Model\ViewModel;

class MainController extends AbstractActionController
{
  public function showAction()
  {
    $year = $this->params()->fromRoute('year');
    $month = $this->params()->fromRoute('month');

    return new ViewModel([
      'year' => $year,
      'month' => $month,
    ]);
  }
}

Step 3: View File (view/application/main/show.phtml)

<h2>Archive Page</h2>
<p>Year: <?= $this->escapeHtml($year) ?></p>
<p>Month: <?= $this->escapeHtml($month) ?></p>

Access in Browser