Add metatags hook (favicon, seo, etc.) (#275)

loic425 · web-flow · commit 7311f977fbd9 · 2025-08-25T09:48:21.000+02:00
This pull request adds: * a hook for adding metatags * documentation for the hook Solves #274
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -12,6 +12,7 @@
   * [Customizing the menu](cookbook/admin_panel/menu.md)
   * [Configuring the security access](cookbook/admin_panel/security.md)
   * [Customizing the page titles](cookbook/admin_panel/page_titles.md)
+  * [Customizing the metatags](cookbook/admin_panel/metatags.md)
 * [How to use in a DDD architecture](cookbook/ddd_architecture.md)
   * [Architecture overview](cookbook/ddd_architecture/overview.md)
   * [Resource configuration](cookbook/ddd_architecture/resource_configuration.md)
diff --git a/docs/cookbook/admin_panel.md b/docs/cookbook/admin_panel.md
@@ -6,3 +6,4 @@
 * [Customizing the menu](admin_panel/menu.md)
 * [Configuring the security access](admin_panel/security.md)
 * [Customizing the page titles](admin_panel/page_titles.md)
+* [Customizing the metatags](admin_panel/metatags.md)
diff --git a/docs/cookbook/admin_panel/metatags.md b/docs/cookbook/admin_panel/metatags.md
@@ -0,0 +1,51 @@
+# Customizing the metatags
+
+## Adding metatags
+
+To add new `<head>` meta tags, you can use the `sylius_admin#metatags` hook. This is useful for adding a favicon or SEO meta tags, for example.
+You can register your own Twig template for meta tags via YAML or PHP.
+
+{% tabs %}
+{% tab title="YAML" %}
+{% code title="config/packages/sylius_bootstrap_admin_ui.yaml" lineNumbers="true" %}
+```yaml
+# ...
+sylius_twig_hooks:
+    hooks:
+        # ...
+        'sylius_admin.base#metatags':
+            favicon:
+                template: 'favicon.html.twig'
+            seo_metatags:
+                template: 'seo_metatags.html.twig'
+```
+{% endcode %}
+{% endtab %}
+
+{% tab title="PHP" %}
+{% code title="config/packages/sylius_bootstrap_admin_ui.php" lineNumbers="true" %}
+```php
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // ...
+
+    // Define your own Twig template for the favicon.
+    $containerConfigurator->extension('sylius_twig_hooks', [
+        'hooks' => [
+            'sylius_admin.base#metatags' => [
+                'favicon' => [
+                    'template' => 'favicon.html.twig',
+                ],
+                'seo_metatags' => [
+                    'template' => 'seo_metatags.html.twig',
+                ],
+            ],
+        ],
+
+    ]);
+};
+```
+{% endcode %}
+{% endtab %}
+{% endtabs %}
diff --git a/src/AdminUi/templates/base.html.twig b/src/AdminUi/templates/base.html.twig
@@ -9,7 +9,10 @@
 
     <title>{% block title %}{% apply striptags %}{% hook generic_hook ~ '#base_title' %}{% endapply %}{% endblock %}</title>
 
-    {% block metatags %}{% endblock %}
+    {% block metatags %}
+        {% hook generic_hook ~ '#metatags' %}
+    {% endblock %}
+
     {% block stylesheets %}
         {% hook generic_hook ~ '#stylesheets' %}
     {% endblock %}
