Redirects via config file

[timkelty]

Description

Adds configurable redirects via config/redirects.php that are only parsed just before serving a 404, so there isn't any added work for normal route/controller requests.

By default, redirects are 302 (temporary) and match the full request path (Craft::$app->getRequest()->getFullPath()) with leading and trailing slashes removed. What is matched can be configured via \craft\web\Redirect::match, which is a callback that takes a \Psr\Http\Message\UriInterface of the URL.

Also provides a \craft\web\ErrorHandler::EVENT_BEFORE_REDIRECT event, should any plugins want to know about a handled redirect.

Note: for future-proofing, named capture group replacement uses PHP/PCRE's native syntax ((?<name>group)) and NOT Yii's similar but different route syntax ((?<name:group)>).

<?php
// config/redirects.php
return [
    // Exact path match
    'redirect/from' => 'redirect/to',

    // Path match with named capture group
    'redirect/from/(?<year>\d{4})' => [
        'to' => 'redirect/to/{year}',
        'matchType' => 'regex',
        'caseSensitive' => false,
    ],

    // Match path and query string
    new \craft\web\Redirect([
        'from' => 'bar=(?<bar>[^&]+)',
        'to' => '/redirect/to/{bar}',
        'match' => fn(\Psr\Http\Message\UriInterface $url) => (string) "{$url->getPath()}?{$url->getQuery()}",
        'matchType' => \craft\enums\MatchType::Regex,
    ]),

    // Match full URL
    'https://craft-5-project.ddev.site/redirect/from/foo/(.+)' => [
        'to' => 'https://redirect.to/{1}',
        'match' => fn(\Psr\Http\Message\UriInterface $url) => (string) $url,
        'matchType' => \craft\enums\MatchType::Regex,
        'statusCode' => 301,
        'caseSensitive' => false,
    ],
];