Extension system

eZ publish is built in a modular way. Much is created with a plug-in system. This allow us to easily extend the functionality of eZ publish. However, we should try to avoid changing the kernel of eZ publish. This is to make it easier to upgrade to a newer eZ publish version later. New datatypes, workflow events and so on should be created as extensions. This will also make it easier to share your extensions with other eZ publish users.

Setting up an extension

All extensions have a separate directory placed in the extension/ directory in the eZ publish root directory. The extension must then be activated in site.ini (or preferably the override). Just add the extension directory name to the ActiveExtensions[] array in the ExtensionSettings block.

settings/override/site.ini.append:

[ExtensionSettings]

ActiveExtensions[]=myExtension

ActiveExtensions[]=anotherExtension

However, if you want to activate an extension from siteaccess you must use the ActiveAccessExtensions[] array instead:

settings/siteaccess/mydesign/site.ini.append

[ExtensionSettings]

ActiveAccessExtensions[]=myExtension

ActiveAccessExtensions[]=anotherExtension

This will activate the extensions placed in extension/myExtension/ and extension/anotherExtension/.

Directory structure

We have a new directory structure inside the directory of our extension: