Get Client IP Address in Symfony 7

Symfony framework is widely used to build robust and scalable web applications. In many scenarios, it becomes essential to retrieve the client's IP address for various reasons such as tracking user activities, implementing security measures, or personalizing user experiences. This tutorial shows how to get client IP address in Symfony 7.

Controller

Accessing the client's IP address within a controller is a straightforward process. Simply include the Request object as an argument in the controller method and utilize the getClientIp method to retrieve the client's IP address.

src/Controller/TestController.php

<?php

namespace App\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class TestController
{
    #[Route('/')]
    public function index(Request $request): Response
    {
        $ip = $request->getClientIp();

        return new Response($ip);
    }
}

Service

For scenarios where the Request object might not be directly available, the service class can inject the RequestStack to access the current request, ensuring a seamless way to retrieve the client's IP address.

src/Service/TestService.php

<?php

namespace App\Service;

use Symfony\Component\HttpFoundation\RequestStack;

class TestService
{
    public function __construct(private RequestStack $requestStack)
    {
    }

    public function process(): void
    {
        $ip = $this->requestStack->getCurrentRequest()?->getClientIp();
    }
}

Template

In Twig templates, Symfony provides direct access to the client's IP address through the app.request.clientIp variable, offering a convenient method for integrating IP information directly into the view layer.

templates/test/index.html.twig

{{ app.request.clientIp }}

src/Controller/TestController.php

<?php

namespace App\Controller;

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

class TestController extends AbstractController
{
    #[Route('/')]
    public function index(): Response
    {
        return $this->render('test/index.html.twig');
    }
}