How to Pass Extra Information from a Route to a Controller

Version: 4.1
Edit this page

Warning: You are browsing the documentation for Symfony 4.1, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

How to Pass Extra Information from a Route to a Controller

Parameters inside the defaults collection don't necessarily have to match a placeholder in the route path. In fact, you can use the defaults array to specify extra parameters that will then be accessible as arguments to your controller, and as attributes of the Request object:

  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
# config/routes.yaml
blog:
    path:       /blog/{page}
    controller: App\Controller\BlogController::index
    defaults:
        page: 1
        title: "Hello world!"

Now, you can access this extra parameter in your controller, as an argument to the controller method:

1
2
3
4
public function index($page, $title)
{
    // ...
}

Alternatively, the title could be accessed through the Request object:

1
2
3
4
5
6
7
8
use Symfony\Component\HttpFoundation\Request;

public function index(Request $request, $page)
{
    $title = $request->attributes->get('title');

    // ...
}

As you can see, the $title variable was never defined inside the route path, but you can still access its value from inside your controller, through the method's argument, or from the Request object's attributes bag.

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