[Routing] Document the effect of setting locale
on a route with locale prefixes
#19825
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using localized routes and importing a collection of routes, the imported routes can be prefixed with a different prefix for each locale (as documented in Localized Routes (i18n)). This makes it easy to have localized routes for
/en/about-us
and/nl/over-ons
without having to define multiple routes.This behavior is implemented in the
Symfony\Component\Routing\Loader\Configurator\Traits\PrefixTrait
by replacing the original route with a cloned version for each locale prefix.However, any route which has a default value for the
_locale
parameter will only be prefixed with the prefix for that locale and will not be cloned for the other locale prefixes.I stumbled upon this because I was trying to implement a route which should be available only for a single locale. I couldn't find any mention of this behavior in the routing documentation.