How to Configure a Redirect without a custom Controller
Edit this pageWarning: You are browsing the documentation for Symfony 4.0, which is no longer maintained.
Read the updated version of this page for Symfony 7.0 (the current stable version).
How to Configure a Redirect without a custom Controller
Sometimes, a URL needs to redirect to another URL. You can do that by creating a new controller action whose only task is to redirect, but using the RedirectController of the FrameworkBundle is even easier.
You can redirect to a specific path (e.g. /about
) or to a specific route
using its name (e.g. homepage
).
Redirecting Using a Path
Assume there is no default controller for the /
path of your application
and you want to redirect these requests to /app
. You will need to use the
urlRedirectAction()
action to redirect to this new url:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# config/routes.yaml
# load some routes - one should ultimately have the path "/app"
controllers:
resource: ../src/Controller/
type: annotation
prefix: /app
# redirecting the homepage
homepage:
path: /
controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction
defaults:
path: /app
permanent: true
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
<!-- config/routes.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
http://symfony.com/schema/routing/routing-1.0.xsd">
<!-- load some routes - one should ultimately have the path "/app" -->
<import resource="../src/Controller/"
type="annotation"
prefix="/app"
/>
<!-- redirecting the homepage -->
<route id="homepage" path="/">
<default key="_controller">Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction</default>
<default key="path">/app</default>
<default key="permanent">true</default>
</route>
</routes>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
// config/routes.php
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
$routes = new RouteCollection();
// load some routes - one should ultimately have the path "/app"
$appRoutes = $loader->import("../src/Controller/", "annotation");
$appRoutes->setPrefix('/app');
$routes->addCollection($appRoutes);
// redirecting the homepage
$routes->add('homepage', new Route('/', array(
'_controller' => 'Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction',
'path' => '/app',
'permanent' => true,
)));
return $routes;
In this example, you configured a route for the /
path and let the
RedirectController
redirect it to /app
. The permanent
switch
tells the action to issue a 301
HTTP status code instead of the default
302
HTTP status code.
Redirecting Using a Route
Assume you are migrating your website from WordPress to Symfony, you want to
redirect /wp-admin
to the route sonata_admin_dashboard
. You don't know
the path, only the route name. This can be achieved using the
redirectAction()
action:
1 2 3 4 5 6 7 8 9 10
# config/routes.yaml
# ...
admin:
path: /wp-admin
controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController::redirectAction
defaults:
route: sonata_admin_dashboard
permanent: true
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<!-- config/routes.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
http://symfony.com/schema/routing/routing-1.0.xsd">
<!-- ... -->
<route id="admin" path="/wp-admin">
<default key="_controller">Symfony\Bundle\FrameworkBundle\Controller\RedirectController::redirectAction</default>
<default key="route">sonata_admin_dashboard</default>
<default key="permanent">true</default>
</route>
</routes>
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// config/routes.php
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
$routes = new RouteCollection();
// ...
$routes->add('admin', new Route('/wp-admin', array(
'_controller' => 'Symfony\Bundle\FrameworkBundle\Controller\RedirectController::redirectAction',
'route' => 'sonata_admin_dashboard',
'permanent' => true,
)));
return $routes;
Caution
Because you are redirecting to a route instead of a path, the required
option is called route
in the redirect()
action, instead of path
in the urlRedirect()
action.