Controllers & Routes

Controllers handle HTTP requests and define your plugin's web interface.

Basic Controller

<?php
namespace Plugins\MyPlugin\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

#[Route(name: 'plugin_my_plugin_')]
class MyController extends AbstractController
{
    #[Route('/', name: 'index', methods: ['GET'])]
    public function index(): Response
    {
        return $this->render('@PluginMyPlugin/index.html.twig', [
            'message' => 'Hello from My Plugin!'
        ]);
    }

    #[Route('/dashboard', name: 'dashboard', methods: ['GET'])]
    public function dashboard(): Response
    {
        // Your logic here
        return $this->render('@PluginMyPlugin/dashboard.html.twig');
    }

    #[Route('/api/data', name: 'api_data', methods: ['GET'])]
    public function apiData(): Response
    {
        $data = ['status' => 'ok', 'message' => 'API response'];
        return $this->json($data);
    }
}

Routing Conventions

Automatic URL prefix: /plugins/{plugin-name}/

• Route / becomes /plugins/my-plugin/

• Route /dashboard becomes /plugins/my-plugin/dashboard

• Route /api/data becomes /plugins/my-plugin/api/data

Route naming: plugin_{plugin_name}_{action}

• Must start with plugin_

• Include plugin name in snake_case

• End with action name

#[Route(name: 'plugin_my_plugin_')]  // Prefix
#[Route('/', name: 'index')]         // Full name: plugin_my_plugin_index

Dependency Injection in Controllers

class MyController extends AbstractController
{
    public function __construct(
        private readonly MyService $myService,
        private readonly LoggerInterface $logger,
    ) {}

    #[Route('/process', name: 'process')]
    public function process(): Response
    {
        $result = $this->myService->doSomething();
        $this->logger->info('Processing complete');

        return $this->json(['result' => $result]);
    }
}

Form Handling

#[Route('/settings', name: 'settings', methods: ['GET', 'POST'])]
public function settings(Request $request): Response
{
    $form = $this->createFormBuilder()
        ->add('api_key', TextType::class)
        ->add('enabled', CheckboxType::class)
        ->add('save', SubmitType::class)
        ->getForm();

    $form->handleRequest($request);

    if ($form->isSubmitted() && $form->isValid()) {
        $data = $form->getData();

        // Save settings
        $this->pluginSettings->set('my-plugin', 'api_key', $data['api_key']);

        $this->addFlash('success', 'Settings saved successfully');
        return $this->redirectToRoute('plugin_my_plugin_settings');
    }

    return $this->render('@PluginMyPlugin/settings.html.twig', [
        'form' => $form->createView()
    ]);
}

Security and Permissions

use Symfony\Component\Security\Http\Attribute\IsGranted;

#[Route('/admin', name: 'admin')]
#[IsGranted('ROLE_ADMIN')]
public function admin(): Response
{
    // Only administrators can access
    return $this->render('@PluginMyPlugin/admin.html.twig');
}

#[Route('/configure', name: 'configure')]
#[IsGranted('configure_plugin')]
public function configure(): Response
{
    // Requires configure_plugin permission
    return $this->render('@PluginMyPlugin/configure.html.twig');
}

Template Rendering

Use the @Plugin{Name}/ namespace:

return $this->render('@PluginMyPlugin/index.html.twig', [
    'variable' => 'value'
]);

Templates are located in plugins/my-plugin/templates/.

JSON Responses

#[Route('/api/users', name: 'api_users')]
public function apiUsers(): Response
{
    $users = $this->userRepository->findAll();

    return $this->json([
        'users' => $users,
        'total' => count($users)
    ]);
}

Redirects

// Redirect to route
return $this->redirectToRoute('plugin_my_plugin_dashboard');

// Redirect with parameters
return $this->redirectToRoute('plugin_my_plugin_view', [
    'id' => $item->getId()
]);

// Redirect to external URL
return $this->redirect('https://example.com');

Flash Messages

$this->addFlash('success', 'Operation completed successfully');
$this->addFlash('error', 'An error occurred');
$this->addFlash('warning', 'Please check your settings');
$this->addFlash('info', 'Processing in progress');

Service Registration

Controllers must be tagged in services.yaml:

services:
    Plugins\MyPlugin\Controller\:
        resource: '../../src/Controller/'
        tags: ['controller.service_arguments']

Related Guides

• Plugin Structure - File organization

• Plugin Manifest - Declare routes capability

• Translations - Multi-language support

• Dependencies - Service injection