Skip to content

Fix incorrect service registration example in custom document type guide #1990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix incorrect service registration example in custom document type guide #1990

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9979426
Initial plan
Copilot Oct 31, 2025
dd4070a
Fix incorrect service registration example for ExampleDocumentRenderer
Copilot Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions guides/plugins/plugins/checkout/document/add-custom-document-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,15 +341,35 @@ Here's what the function does:

Depending on the file type we either get the content with `$this->fileRendererRegistry->render()` or we need to create the content on our own.
`DocumentFileRendererRegistry` acts as a central registry for document file renderers based on file extensions (e.g., .pdf, .html). It delegates the rendering of documents to the appropriate renderer implementation.
Therefore, for each registered service that extends the `AbstractDocumentTypeRenderer`, the content of the document can be generated. New types of `AbstractDocumentTypeRenderer` services can be added with `document_type.renderer` as the tag name and the file extension as a key.

```xml
<service id="Shopware\Core\Checkout\Document\Service\PdfRenderer">
...
<tag name="document_type.renderer" key="pdf"/>
</service>
### Registering the renderer in the service container

Now we need to register our custom `ExampleDocumentRenderer` in the service container. Create or update your `services.xml` file:

::: code-group

```xml [PLUGIN_ROOT/src/Resources/config/services.xml]
<?xml version="1.0" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">

<services>
<service id="Swag\BasicExample\Core\Checkout\Document\Render\ExampleDocumentRenderer">
<argument type="service" id="order.repository"/>
<argument type="service" id="Shopware\Core\Checkout\Document\Service\DocumentConfigLoader"/>
<argument type="service" id="Shopware\Core\System\NumberRange\ValueGenerator\NumberRangeValueGeneratorInterface"/>
<argument type="service" id="Shopware\Core\Checkout\Document\Service\DocumentFileRendererRegistry"/>
<tag name="document.renderer"/>
</service>
</services>
</container>
```

:::

Note that we're using the tag `document.renderer` to register our custom document renderer. The tag name matches what was mentioned earlier - your renderer has to be registered using the tag `document.renderer`.

### Adding a document type template

Let's have a quick look at an example document type template. Go ahead and create a new file at the path `<plugin root>/src/Resources/views/documents/example_document.html.twig`.
Expand Down