Skip to content

Main NavigationApps Themes Integrations Frontends

HTTP APIs

Store API

Administration

Learning

Appearance

Sidebar Navigation

Docs

Concepts

Commerce

Catalog

Products

Checkout

Cart

Orders

Payments

Content

Shopping Experiences (CMS)

Framework

Architecture

Storefront

Administration

Data Abstraction Layer

Messaging

Migrations

Rules

HTTP Cache

Elasticsearch

Flow

Extensions

Apps

Plugins

API

Store API

Admin API

Guides

Installation

Community Setups

Dockware

Requirements

Template

Devenv

Extensions

Plugins

Plugin fundamentals

Add plugin configuration

Use plugin configuration

Database migrations

Dependency injection

Listening to events

Add custom service

Adjusting a service

Add plugin dependencies

Add custom CLI commands

Add scheduled task

Using custom fields of type media

Adding NPM dependencies

Adding Composer dependencies

Plugin lifecycle methods

Checkout

Cart

Add cart collector/processor

Add cart items

Add cart discounts

Add cart validator

Change price of items in cart

Customize price calculation

Tax provider

Document

Add custom document

Add custom document type

Order

Using the state machine

Listen to order changes

Payment

Add payment plugin

Customize payment provider

Content

CMS

Add CMS block

Add CMS element

Add CMS element via AdminExtensionSDK

Add data to CMS element

Mail

Add data to mails

Add mail templates

Media

Prevent Deletion of Media Files Referenced in your Plugins

Add custom media extension

SEO

Add custom SEO URLs

Sitemap

Add custom sitemap entries

Modifying sitemap entries

Stock

Implementing your own stock storage

Loading Stock Information from a different Source

Reading and Writing Stock

Elasticsearch

Add product entity extension to elasticsearch

Framework

Data Handling / DataAbstractionLayer

Reading data

Writing data

Adding custom complex data

Adding complex data to existing entities

Replacing associated data

Removing associated data

Adding data associations

Adding data translations

Using database events

Using flags

Field inheritance

Versioning entities

Adding Data Indexer

Custom Fields

Add custom field

Fetching data from "entity selection" custom field

Event

Add custom event

Finding events

Message Queue

Add message to queue

Add message handler

Add middleware

Rule

Add custom rules

Store API

Add store API route

Add caching for Store API route

Override existing route

Filesystem

Filesystem - Flysystem

Flow

Add Flow Builder action

Add Flow Builder trigger

Rate Limiter

Add Rate Limiter to API Route

Administration

Add custom module

Add custom component

Add custom route

Add menu entry

Writing templates

Adding snippets

Adding Mixins

Using Mixins

Adding Services

Extending Services

Adding permissions

Using the data handling

Adding error handling

Customize modules

Override existing routes

Add tab to existing module

Customizing components

Using assets

Using Directives

Add custom input field to existing component

Using base components

Add custom styles

Using the data grid component

Extending Webpack

Using utility functions

Adding responsive behavior

The Shopware object

Add filter

Using filter

Using custom fields

Add custom data to the search

Add shortcuts

Add rule assignment configuration

Handling media

Injecting services

Modify dynamic product groups blacklist

The Sanitizer helper

Using Vuex Stores

Storefront

Customize templates

Add custom controller

Add caching to custom controller

Add dynamic content via AJAX calls

Add custom Javascript

Override existing Javascript

Add custom assets

Add custom styling

Add custom icons

Add custom page

Add custom pagelet

Add translations

Add custom listing filters

Fetching data with Javascript

Add data to storefront page

Add cookie to manager

Reacting to cookie consent changes

Reacting to javascript events

Working with media and thumbnails

Remove Javascript plugin

Add custom field in the storefront

Add custom sorting for product listing

Add SCSS variables

Add SCSS variables via Subscriber

Using a modal window

Using the datepicker plugin

Use nested line items

Add custom twig functions

Testing

End-to-end testing

Jest unit tests in Shopware's administration

Jest unit tests in Shopware's storefront

PHP unit testing

API

Custom Pricing

Multi Inventory

Plugin Base Guide

Plugins for Symfony developers

Themes

Theme base guide

Create a first theme

Differences Plugins and Apps vs Themes

Theme configuration

Add SCSS Styling and JavaScript to a Theme

Override Bootstrap variables in a Theme

Add assets to a Theme

Add custom icons

Theme inheritance

Theme with Bootstrap styling

Theme inheritance configuration

Apps

App Starter Guides

Starter Guide - Read and write data

Starter Guide - Add an API endpoint

Starter Guide - Create Admin Extensions

App SDKs

Official PHP SDK

Getting started

Lifecycle

Context

Signing

HTTP-client

Events

Official Symfony bundle

App Scripts

Cart manipulation

Data loading

Custom endpoints

Storefront

Apps as themes

Add cookies to the consent manager

Administration

Add custom action button

Add custom module

Flow Builder

Add custom flow action from app system

Add custom flow trigger from app system

Custom Data

Custom fields

Custom entities

Content

CMS

Add custom CMS blocks

Rule Builder

Add custom rule conditions

App Base Guide

Configuration

Tax provider

Payment

Webhook

Client-side communication to the app backend

Overview

Hosting

Installation & Updates

Deployments

Deployment with Deployer

Building without Database

Cluster Setup

Extension Management

Configurations

Shopware

HTML sanitizer

Stock

Framework

SameSite protection

Performance

Cache

Custom cache invalidation

Session

Increment Storage

Lock Storage

Number Ranges

Performance Tweaks

Infrastructure

Elasticsearch

Set up Elasticsearch

Debugging Elasticsearch

Filesystem

Rate Limiter

Database Cluster

Message Queue

Scheduled Task

Reverse HTTP Cache

Integrations / API

General Concepts

Search Criteria

Request Headers

Generated Reference

API Versioning

Products

Extensions

Migration Assistant

Concept

Profile and Connection

DataSelection and DataSet

Migration Context

Premapping

Gateway and Reader

Convert and Mapping

Logging

Writer

Media Processing

Guides

Extending a Shopware migration profile

Extending the Migration Connector

Decorating a Shopware Migration Assistant converter

Creating a new migration profile

Concept

Guides

B2B Suite

Concepts

System architecture

Basic conventions

Method structure

Line Item List

Guides

Core

Dependency injection

Store API

REST API

Listing service

CRUD service

Assignment service

Audit Log

Exception

Currency

Entity based ACL

Overloading classes

Storefront Authentication

Installation

Storefront

Ajax Panel

Product Search

Complex views

Modal component

Company

ACL and Routing

Extending the Storefront

Administration

Example Plugins

B2B Components

Employee management

Concept

Entities & Schema

API Route Restriction for Employees

Guides

Create permissions via app

Create permissions via plugin

Advanced Search

Installation

Define a custom Elasticsearch Definition

Add more fields to product search

Configure Searchable Fields

Language analyzers

Cross search

Extending search template

Modify search logic

Search and suggest routes

Completion

PaaS

CLI Setup

Repository

Build & Deploy

Setup Template

Theme Build

Elasticsearch

RabbitMQ

Fastly

Digital Sales Rooms

Digital Sales Rooms installation

Self-hosted Mercure installation

Developers' checklist

Sample Mercure Configuration on StackHero

PWA

SaaS

Community Edition

Plugins

Commercial

Resources

References

API Reference

Core Reference

DAL Reference

Fields Reference

Flags Reference

Filters Reference

Aggregations Reference

Commands Reference

Flow Reference

Rules Reference

Architecture Reference

Assets

Implement architecture decision records

Control clone behavior

Implement sales channel context token requirement

Implement new changelog

Feature flag system

Document template refactoring

Implement app system inside platform

Implement individual sorting

Merchant registration

Handling feature flags

Unified notification titles

Import acl privileges from other roles

Custom field label loading in storefront

The best practice to always re fetch the data after saving

Creating events

DAL join filter

Add login required annotation

Decoration pattern

Removing API version

Deprecation strategy

Nested line items

When to use plain sql or DAL

Introduce eslint on vue admin

Introduce jest fail on console

Move storefront scripts to head

Storefront coding standards

Make platform stand alone

Refactor admin build process to webpack multi compiler mode

Make core mail templates independent from storefront urls

Technical concept custom entities

Refactor theme inheritance

Payment flow

Refund handling

App scripting

Preparing data for rule evaluation

Adjust adr approval rules

Increment pattern

Merge e2e projects into a single project

Add possibility for plugin to add a html file

Admin extension API standards

Add feature flag support for storefront scss

Custom app API endpoints

Feature flags for major versions

Controller configuration route defaults

Rule scripting in apps

Domain exceptions

Consistent deprecation notices in core

Reset class state during requests

Extract data handling classes to extension sdk

New nested line items

Available stock

Base context factory

Cache stampede protection

Initial state id loader

Prevent mail updates

Profiler integrations

Redis cart persister

Specify priority of translations in DAL write payloads

Add default cms layouts to products and categories

Integrate app into flow action

Tax providers

Remove static analysis with psalm

Rule condition field abstraction

Integrate app into flow event

Add typescript support for storefront js

Providing the admin extension sdk

Blog concept

Adding the storable flow to implement delay action in flow builder

Add bootstrap util

Mapping of product area

Hide and show cms content

Deprecation handling during phpunit test execution

Test structure

Composer based web updater

Deprecate csrf

Replace drop shadow with box shadow

Run lighthouse test ine2e env

Vue 2.7 update

Atomic theme compilation

Npm packages pre release versions

Image lazy loading

App script product pricing

Deprecate autoload true in DAL associations

Flow storer with scalar values

Follow test pyramid

Unstructured adrs

Native extension system with vue

Admin text editor evaluation

Mocking repositories

Disable css autoprefixer

New language inheritance mechanism for opensearch

Jest test files should be javascript only

Optimise cart cleanup

Experimental features

Stock API

Php enums

Symfony dependency management

Switch to uuidv7

Exception log levels

Store API to app server

Default handle for non specified salutations

Flow builder preview

Feature property for experimental anotation

YYYY MM DD template

App Reference

Script Reference

Cart manipulation services reference

Data loading services reference

Custom endpoint script services reference

Miscellaneous script services reference

Script hooks reference

Product script services reference

Manifest Reference

Webhook Events Reference

Payment Reference

CMS Reference

Entities Reference

Flow Action Reference

Administration Reference

Utils

Mixins

Directives

Storefront Reference

Shopware's twig functions

Storefront plugins

Testing Reference

Custom E2E Commands

E2E Commands

Config Reference

Server

Apache

Nginx

Security

Guidelines

Code

Core guidelines

6.5 new php language features

Adr

Benchmarks

Decorator pattern

Domain exceptions

Extendability

Final and internal

Internal

Unit tests

Writing code for static analysis

Contribution Guidelines

Backward Compatibility

Cart Process

Context Rules & Rule Systems

Dependency Injection & Dependency Handling

Document Code

Events

Page Loader

Platform Domains

Public APIs

Routing

Session and State

Store API

Storefront Controller

Test

Testing guidelines for extensions

Quality guidelines for apps in app system

Quality guidelines for apps in plugin system

Best practices on writing end-to-end tests

Document

Fonts & Formats

Text

Code

General

Methodize Assets

Conceptual Structure

Doc Process

Language & Grammar

Tooling

CLI

Hot Module Reloading using watchers

IDE

Shopware Toolbox

Administration Reference

Resources
References

On this page

Table of Contents for current page

docsmainResources

Administration Reference

This section covers concepts on Utils, Mixins and Directives.

Utils

Mixins

Directives

Ask a question on StackOverflow

Edit this page on GitHub

Previous pageFlow Action Reference

Next pageUtils

info@shopware.com
Worldwide: 00 800 746 7626 0

Product

APIs
SDKs
B2B Suite
Extensions
Headless Storefront

Resources

User Documentation
Design Documentation
E-commerce knowledge
Jump into development
Training & Certification

Community

Forum
Community Day
Stack Overflow
Feedback & Issues

GitHub Channels

Shopware 5
Shopware 6
Development Template
Contribute to the docs
Contribute to platform

News & Updates

Blog
Shopware TV
Announcements
Product Changelog

Terms & Conditions
Privacy policy
Legal notice
Cookie settings