KnpMenu

The admin comes with KnpMenu integration. It integrates a menu with the KnpMenu library. This menu can be a SonataAdmin service, a menu created with a Knp menu provider or a route of a custom controller.

To add a custom controller entry in the admin menu:

Create your controller:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
        use Symfony\Component\HttpFoundation\Response;

final class BlogController
{
    /**
     * @Route("/blog", name="blog_home")
     */
    public function blogAction(): Response
    {
        // ...
    }

    /**
     * @Route("/blog/article/{articleId}", name="blog_article")
     */
    public function ArticleAction(string $articleId): Response
    {
        // ...
    }
}
    

Add the controller route as an item of the menu:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            news:
                label:                ~
                translation_domain:   ~
                items:
                    - sonata.news.admin.post
                    - route:        blog_home
                        label:        Blog
                    - route:        blog_article
                        route_params: { articleId: 3 }
                        label:        Article
    

If you want to show your route to user with different roles, you can configure this for each route. If this is not set, group roles will be checked.

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            news:
                label:                ~
                translation_domain:   ~
                items:
                    - sonata.news.admin.post
                    - route:        blog_home
                        label:        Blog
                        roles:        ['ROLE_FOO', 'ROLE_BAR']
                    - route:        blog_article
                        route_params: { articleId: 3 }
                        label:        Article
                roles: ['ROLE_ADMIN', 'ROLE_SONATA_ADMIN']
    

You can also override the template of knp_menu used by sonata. The default one is `@SonataAdmin/Menu/sonata_menu.html.twig`:

        1
2
3
4
5
        # config/packages/sonata_admin.yaml

sonata_admin:
    templates:
        knp_menu_template: '@ApplicationAdmin/Menu/custom_knp_menu.html.twig'
    

Now you have a menu group which contains a link to a sonata admin via its id, to your blog and to a specific article.

As seen above, the main way to declare your menu is by declaring items in your sonata admin config file. In some cases you may have to create a more complex menu depending on your business logic. This is possible by using a menu provider to populate a whole menu group. This is done with the provider config value.

The following configuration uses a menu provider to populate the menu group my_group:

        1
2
3
4
5
6
7
8
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            my_group:
                provider: 'MyBundle:MyMenuProvider:getMyMenu'
                icon: 'fas fa-edit' # html is also supported
    

With KnpMenuBundle you can create a custom menu by using a builder class or by declaring it as a service. Please see the Knp documentation for further information.

In sonata, whatever the implementation you choose, you only have to provide the menu alias to the provider config key:

If you are using a builder class, your menu alias should be something like MyBundle:MyMenuProvider:getMyMenu.
If you are using a service, your menu alias is the alias set in the knp_menu.menu tag. In the following example this is my_menu_alias:

        1
2
3
        <service id="my_menu_provider" class="MyBundle/MyDirectory/MyMenuProvider">
    <tag name="knp_menu.menu" alias="my_menu_alias"/>
</service>
    

Please note that when using the provider option, you can't set the menu label via the configuration. It is done in your custom menu.

You can modify the menu via events. You can register as many listeners as you want for the event with name sonata.admin.event.configure.menu.sidebar:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
        // src/EventListener/MenuBuilderListener.php

namespace App\EventListener;

use Sonata\AdminBundle\Event\ConfigureMenuEvent;

final class MenuBuilderListener
{
    public function addMenuItems(ConfigureMenuEvent $event): void
    {
        $menu = $event->getMenu();

        $child = $menu->addChild('reports', [
            'label' => 'Daily and monthly reports',
            'route' => 'app_reports_index',
        ])->setExtras([
            'icon' => 'fas fa-bar-chart', // html is also supported
        ]);
    }
}
    

        1
2
3
4
5
6
7
        # config/services.yaml

services:
    app.menu_listener:
        class: App\EventListener\MenuBuilderListener
        tags:
            - { name: kernel.event_listener, event: sonata.admin.event.configure.menu.sidebar, method: addMenuItems }
    

Please see the Using events to allow a menu to be extended for further information.

You can modify the menu to hide some menu items. You need to add the show_in_dashboard option in your admin services or remove menu items from the sonata_admin dashboard group configuration:

        1
2
3
4
5
6
        # config/services.yaml

sonata_admin.admin.post:
    class: Sonata\AdminBundle\Admin\PostAdmin
    tags:
        - { name: sonata.admin, model_class: Sonata\AdminBundle\Entity\Post, controller: Sonata\AdminBundle\Controller\CRUDController, manager_type: orm, group: admin, label: Post, show_in_dashboard: false }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            news:
                label:                ~
                translation_domain:   ~
                items:
                  # comment or remove the sonata.news.admin.post declaration to hide it from the menu.
                  #  - sonata.news.admin.post
                    - route:        blog_home
                      label:        Blog
                    - sonata.news.admin.news
    

You can add the keep_open option to menu group to keep that group always open and ignore open/close effects:

        1
2
3
4
5
6
7
8
9
10
11
12
13
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            sonata.admin.group.content:
                keep_open:          true
                label:              sonata_media
                translation_domain: SonataMediaBundle
                icon:               'fas fa-image' # html is also supported
                items:
                    - sonata.media.admin.media
                    - sonata.media.admin.gallery
    

The navigation side bar with a group which uses "keep_open" option

You can modify the menu to show menu item without treeview. You need to add option on_top in your admin services or in sonata_admin dashboard group configuration:

        1
2
3
4
5
6
        # config/services.yaml

sonata_admin.admin.post:
    class: Sonata\AdminBundle\Admin\PostAdmin
    tags:
        - { name: sonata.admin, model_class: Sonata\AdminBundle\Entity\Post, controller: Sonata\AdminBundle\Controller\CRUDController, manager_type: orm, group: admin, label: Post, on_top: true }
    

        1
2
3
4
5
6
7
8
9
10
11
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            news:
                on_top:             true
                label:              ~
                translation_domain: ~
                items:
                    - sonata.news.admin.post
    

In this screenshot, we add on_top option to Tag and Blog Post admin services.

Your can't use this option for two or more items at the same time:

        1
2
3
4
5
6
7
8
9
10
11
12
13
        # config/packages/sonata_admin.yaml

sonata_admin:
    dashboard:
        groups:
            news:
                on_top:            true
                label:              ~
                translation_domain: ~
                items:
                    - sonata.news.admin.post
                    - route:        blog_home
                      label:        Blog
    

In this case you have an exception: "You can't use on_top option with multiple same name groups".

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

TOC

Version

KnpMenu

Add a custom controller entry in the menu

Using a menu provider

Extending the menu

Hiding menu items

Keeping menu group open

Show menu item without treeview

Become a Symfony contributor