Backend modules API

Changed in version 12.0

This chapter describes the API that can be used to create custom backend modules in extensions. See the following chapter for a tutorial on how to create custom backend modules.

Backend GUI

Describes the graphical user interface structure of a backend module and defines how the different parts are called.

Backend module configuration

Howto register custom modules provided by extensions.

Toplevel modules

Lists all toplevel modules available by default and explains how to register custom toplevel modules.


The ModuleProvider API, allows extension authors to work with the registered modules.


The PSR-14 BeforeModuleCreationEvent allows extension authors to manipulate the module configuration before it is used to create and register the module.

Button components

The menu button bar of a backend module can hold various components.

Override backend templates

Backend templates can be overridden via page TSconfig. But you should be careful: backend templates are mostly not API and can break on updates.

Tutorial and how to

Learn how to create a backend module step-by-step.