How to Allow a “/” Character in a Route Parameter

3.4 version

Unmaintained

2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2

How to Allow a “/” Character in a Route Parameter
- Configure the Route

How to Allow a “/” Character in a Route Parameter¶

Sometimes, you need to compose URLs with parameters that can contain a slash /. For example, consider the /share/{token} route. If the token value contains a / character this route won’t match. This is because Symfony uses this character as separator between route parts.

This article explains how you can modify a route definition so that placeholders can contain the / character too.

Configure the Route¶

By default, the Symfony Routing component requires that the parameters match the following regular expression: [^/]+. This means that all characters are allowed except /.

You must explicitly allow / to be part of your placeholder by specifying a more permissive regular expression for it:

Annotations

use Symfony\Component\Routing\Annotation\Route;

class DefaultController
{
    /**
     * @Route("/share/{token}", name="share", requirements={"token"=".+"})
     */
    public function shareAction($token)
    {
        // ...
    }
}

YAML

share:
    path:     /share/{token}
    defaults: { _controller: AppBundle:Default:share }
    requirements:
        token: .+

XML

<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="share" path="/share/{token}">
        <default key="_controller">AppBundle:Default:share</default>
        <requirement key="token">.+</requirement>
    </route>
</routes>

PHP

use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

$routes = new RouteCollection();
$routes->add('share', new Route('/share/{token}', [
    '_controller' => 'AppBundle:Default:share',
], [
    'token' => '.+',
]));

return $routes;

That’s it! Now, the {token} parameter can contain the / character.

Note

If the route includes the special {_format} placeholder, you shouldn’t use the .+ requirement for the parameters that allow slashes. For example, if the pattern is /share/{token}.{_format} and {token} allows any character, the /share/foo/bar.json URL will consider foo/bar.json as the token and the format will be empty. This can be solved by replacing the .+ requirement by [^.]+ to allow any character except dots.

Note

If the route defines several placeholders and you apply this permissive regular expression to all of them, the results won’t be the expected. For example, if the route definition is /share/{path}/{token} and both path and token accept /, then path will contain its contents and the token, and token will be empty.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.