Plugin Base Guide

Overview

This guide outlines the typical development flow when creating a Shopware plugin, using the recommended static plugin approach. Core concepts apply to all plugin types. Not every plugin requires all steps.

Typical plugin development flow

1. Create the plugin structure
2. Install and activate the plugin
3. Understand the plugin lifecycle
4. Add plugin configuration
5. Register services and use dependency injection
6. Listen to events or decorate services
7. Extend the platform (either or both): Storefront, Administration
8. Add database migrations (if required)
9. Add scheduled tasks or CLI commands (if required)
10. Add configuration: npm, Composer (if required)
11. Write tests: CI and upgrade safety: Configure CI to run static analysis, tests, and produce reproducible artifacts to avoid upgrade regressions.
12. Add diagnostics

Upgrade readiness

Design plugins so that:

• Migrations are idempotent
• Lifecycle logic is minimal and predictable
• Domain logic is encapsulated behind services

Upgrades are easier when the plugin surface area is small and well-structured.

Getting started

The first step is to create the plugin structure.