diff --git a/guides/plugins/apps/app-scripts/custom-endpoints.md b/guides/plugins/apps/app-scripts/custom-endpoints.md index 47e5283a26..699def9fd9 100644 --- a/guides/plugins/apps/app-scripts/custom-endpoints.md +++ b/guides/plugins/apps/app-scripts/custom-endpoints.md @@ -129,6 +129,8 @@ Additionally, it is also possible to redirect to an existing route: For a complete overview of the available data and services, refer to the [reference documentation](../../../../resources/references/app-reference/script-reference/script-hooks-reference.md#storefront-hook). +To make such a page reachable under a readable path like `/imprint` or `/blog/my-post`, declare an SEO URL for it in your manifest. See the [SEO URLs for App Routes](../storefront/seo-urls.md) guide. + ## Manipulate HTTP-headers to API responses ::: info diff --git a/guides/plugins/apps/storefront/seo-urls.md b/guides/plugins/apps/storefront/seo-urls.md new file mode 100644 index 0000000000..eb2323b041 --- /dev/null +++ b/guides/plugins/apps/storefront/seo-urls.md @@ -0,0 +1,145 @@ +--- +nav: + title: SEO URLs for App Routes + position: 30 + +--- + +# SEO URLs for App Routes + +## Overview + +Storefront pages rendered by [app scripts](../app-scripts/custom-endpoints.md#storefront-endpoints) live under `/storefront/script/{hook}`. That path is technical and cannot carry an entity id. With `` and `` elements in the `` section of your `manifest.xml`, Shopware gives those pages SEO URLs, the same way it does for products and categories. + +::: info +This feature was introduced in Shopware 6.7.16.0 and is not available in earlier versions. +::: + +There are two kinds of SEO URLs: + +- A **static** SEO URL (``) maps a fixed path such as `/imprint` to one of your storefront scripts. +- An **entity-bound** SEO URL (``) generates one URL per entity from a Twig template, for example `/blog/{{ ceBlog.translated.title }}`, and passes the entity id to your script. + +## Prerequisites + +You need an app with at least one storefront script. Read the [App Base Guide](../app-base-guide.md) and the [Custom Endpoints](../app-scripts/custom-endpoints.md) guide first. Both kinds of SEO URLs point at scripts stored in `Resources/scripts/storefront-/`. + +## Static SEO URLs + +Declare a `` with one or more `` elements. The `name` identifies the route inside your app and is also the default script hook. + +```xml + + + + SwagCompanyPages + ... + + + + imprint + impressum + + + +``` + +With this manifest, `/imprint` and `/impressum` run the scripts in `Resources/scripts/storefront-imprint/`. Shopware writes one SEO URL per storefront sales channel domain. It picks the `` of the domain language and falls back to the shop's default language. Query parameters of the request stay available as `hook.query`. + +Set the `hook` attribute when the script folder should differ from the route name: + +```xml + + imprint + +``` + +## Entity-bound SEO URLs + +Declare an `` with an `entity` attribute and a ``. The entity can be one of your [custom entities](../custom-data/custom-entities.md) or a core entity such as `product`. + +```xml + + + blog/{{ ceBlog.translated.title }} + + +``` + +Shopware generates one SEO URL per entity and language from the template and keeps it up to date whenever the entity is written. Like the SEO URLs of products and categories, this follows the indexing behaviour of the write (for example the `indexing-behavior` header of the Sync API, or `indexing-skip: app_seo_url.seo-url` to skip it), and `bin/console dal:refresh:index` rebuilds them. The template context exposes the entity under its camel-cased name, so `ce_blog` becomes `ceBlog` and `product` becomes `product`. Every field of the entity is available, translated fields through `translated`. + +The generated URL resolves to `/storefront/script/blog-detail?id=`, so your script receives the id as `hook.query.id`: + +```twig +// Resources/scripts/storefront-blog-detail/script.twig +{% set post = services.store.search('ce_blog', { 'ids': [hook.query.id] }).first %} + +{% do hook.page.addExtension('post', post) %} + +{% do hook.setResponse( + services.response.render('@SwagBlog/storefront/page/blog/detail.html.twig', { 'page': hook.page }) +) %} +``` + +### Permissions + +Your app needs `` permission for the entity and for every association your `` uses. A template that reads `product.manufacturer.name` needs both entities: + +```xml + + + {{ product.manufacturer.name }}/{{ product.translated.name }} + + + + product + product_manufacturer + +``` + +Your own [custom entities](../custom-data/custom-entities.md#permissions) need no extra permission: your app has full access to them anyway. The generated paths are public, so only use fields in the template that may appear in a URL. + +### Merchant configuration + +Entity-bound routes appear in the Administration under *Settings > SEO* as `storefront.app..`, for example `storefront.app.SwagBlog.blog-detail`. Merchants can adjust the template per sales channel and override single URLs like they do for products. Changing a template regenerates the URLs automatically. Your `` is only the initial value: app updates don't overwrite a template that already exists. Changing the `entity` of a route resets every template of that route, including sales channel overrides. Declare a new `name` if a route needs a fresh template for the same entity. + +## Linking to your pages + +Use the `seoUrl` Twig function with the technical route and parameters in your storefront templates. The placeholder is replaced with the SEO URL when the page is rendered: + +```twig + + {{ post.translated.title }} + + + + {{ 'swag-company-pages.imprint'|trans }} + +``` + +## Lifecycle + +- **Install and update**: Shopware stores the declared routes and creates the default SEO URL template for entity-bound routes that don't have one yet. Routes that an update no longer declares lose their SEO URLs and templates. +- **Activation and update**: The static SEO URLs are written right away. The entity-bound URLs are generated through the message queue, so make sure a [worker](../../../hosting/infrastructure/message-queue.md) processes messages. +- **Hook changes**: Changing the `hook` of a route keeps its SEO URLs, including the merchant's edits, and points them at the new script. +- **Deactivation and uninstall**: The app's SEO URLs are marked as deleted and stop resolving. Uninstalling also removes the SEO URL templates, unless the merchant keeps the app data. +- **New sales channel domains**: Like product URLs, the static SEO URLs for a new domain show up on the next activation or update of the app, or after `bin/console dal:refresh:index`. + +## Validation rules + +The manifest schema checks the structure of both elements: + +- `name` and `hook` must match `[a-z0-9]+(-[a-z0-9]+)*`, and `name` must be unique across all `` and `` elements of the app. +- A `` needs at least one non-empty ``. +- An `` needs an `entity` attribute and a non-empty ``. + +On app `install` and `update`, Shopware also checks: + +- Static paths must not contain characters that aren't allowed in URLs and must not yet be used by a storefront route such as `/account`, by another app or by an existing SEO URL. +- A script hook belongs to the first app that declares it in an SEO URL. Within your app, a hook can be used by at most one `` and at most one ``. +- The `entity` of an `` must exist and must not be a mapping or translation entity, and your app needs the [permissions](#permissions) described above. + +## Limitations + +- SEO URLs are generated for storefront sales channels only. Headless sales channels are not supported yet. +- No `hreflang` links are generated for app routes. diff --git a/resources/references/app-reference/manifest-reference.md b/resources/references/app-reference/manifest-reference.md index 5766129a9d..914a571cd5 100644 --- a/resources/references/app-reference/manifest-reference.md +++ b/resources/references/app-reference/manifest-reference.md @@ -42,7 +42,7 @@ Validates that the Shopware instance is publicly reachable, which is necessary f ## Storefront -Can be omitted if your app template needs higher load priority than other plugins/apps. For more details, follow the [storefront guide](../../../guides/plugins/apps/storefront/index.md). +Configure the template load priority of your app and declare SEO URLs for pages rendered by your storefront scripts. For more details, follow the [storefront guide](../../../guides/plugins/apps/storefront/index.md) and the [SEO URLs for App Routes](../../../guides/plugins/apps/storefront/seo-urls.md) guide. <<< @/docs/snippets/config/app/storefront.xml diff --git a/snippets/config/app/storefront.xml b/snippets/config/app/storefront.xml index 901ab89800..c3152265b7 100644 --- a/snippets/config/app/storefront.xml +++ b/snippets/config/app/storefront.xml @@ -5,5 +5,12 @@ 100 + + imprint + impressum + + + blog/{{ ceBlog.translated.title }} +