[Translation] Give current locale to LocaleSwitcher::runWithLocale()'s callback

alexandre-daubois · alexandre-daubois · commit 06ea548b360e · 2023-09-20T13:36:27.000+02:00
diff --git a/translation.rst b/translation.rst
@@ -1073,6 +1073,27 @@ of:
         }
     }
 
+.. tip::
+
+    If you need to get the locale used in the callback of the
+    ``runWithLocale()`` method, you can declare the ``$locale`` special
+    argument like this::
+
+        public function someMethod(): void
+        {
+            // "es" will be injected in the `$locale` argument when the callback is executed
+            $this->localeSwitcher->runWithLocale('es', function(string $locale) {
+                // ...
+            });
+
+            // ...
+        }
+
+    .. versionadded:: 6.4
+
+        Declaring a ``$locale`` argument in the callback to inject the locale
+        being used was introduced in Symfony 6.4.
+
 When using :ref:`autowiring <services-autowire>`, type-hint any controller or
 service argument with the :class:`Symfony\\Component\\Translation\\LocaleSwitcher`
 class to inject the locale switcher service. Otherwise, configure your services
