Shopware's twig functions
In Shopware, we extend Twig's functionality by custom ones. See our own actions below.
WARNING
No official support for the twig {% use %} tag
Try to avoid importing blocks from the core templates with the {% use %} tag for horizontal reuse in twig. Twig documentation - use tag.
The {% use %} tag does not consider the template inheritance similar to {% sw_extends %}`.
Furthermore, templates which are imported via {% use %} are not allowed to have additional twig statements outside of twig blocks. Therefore, changes in core templates which are imported via {% use %} might break your app or plugin.
Functions
| Function | Description | Notes |
|---|---|---|
sw_extends | Inherits from another file with support for multi inheritance. The API is the same like in twigs default extends | --- |
sw_include | Includes template partials with support for multi inheritance. The API is the same like in twigs default include | --- |
sw_icon | Displays an icon from a given icon set | See Add custom icon guide for details. |
sw_thumbnails | Renders a tag with correctly configured “srcset” and “sizes” attributes based on the provided parameters | See Add thumbnail guide for more information. |
config | Gets a value from the system config (used by plugins and global settings) for the given sales channel | See Reading the configuration values |
theme_config | Gets a value from the current theme | See Theme configuration |
Filter
| Filter | Description | Notes |
|---|---|---|
replace_recursive | Enables recursive replacement in addition to twig's default replace filter | To see an example, see the guide on add custom JavaScript |
currency | Adopts currency formatting: The currency symbol and the comma setting. | --- |
sw_sanitize | Filters tags and attributes from a given string. By default, twig's auto escaping is on, so this filter explicitly allows basic HTML tags like <i%gt;, <b>,... | --- |
Extensions
| Extension | Description | Notes |
|---|---|---|
sw_breadcrumb_full() | Returns all categories defined in the breadcrumb as an array | Contains functionalities of sw_breadcrumb_types and sw_breadcrumb_build_types |
sw_breadcrumb() | Returns the category tree as array. Entry points of the SalesChannel ( e.g. footer, navigation) are filtered out. | Deprecated in 6.5.0 |
sw_breadcrumb_types() | Yields the types of the categories within the breadcrumb | Deprecated in 6.5.0 |
sw_breadcrumb_build_types() | returns the same as sw_breadcrumb_types, only without another repository call | Deprecated in 6.5.0 |
seoUrl() | Returns seo URL of given route | --- |
searchMedia() | Resolves media ids to media objects | See Add media guide for details. |
rawUrl() | Returns full URL | --- |
