Path

7x / documentation / ez publish / technical manual / 3.9 / installation / extensions / activating the extension


Caution: This documentation is for eZ Publish legacy, from version 3.x to 6.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

Activating the extension

Each extension needs to be activated, which means that it is being registered for eZ publish to be available from within the eZ publish framework. Every extension can either be activated in the eZ publish administration interface or in a configuration file. Furthermore, the activation can be done either for the whole eZ publish installation or for only certain siteaccesses.

Administration interface

Go to the administration interface of your eZ publish installation and navigate to "Setup / Extensions". The sample extension should be available in the list by the name "ezfoo". Register this extension by activating the checkbox, then click "Apply changes".

Extension configuration

Screenshot of extension configuration in administration interface.

This will activate the extension for all siteaccesses of an eZ publish installation.

Configuration file

Alternativley, an extension can be enabled manually in the site.ini configuration file.

Activating for the whole installation

To do so, edit "site.ini.append[.php]" in the folder

/root_of_ezpublish/settings/override/

If this file does not exist, create it. Locate (or add) the configuration block "[ExtensionSettings]" and add the line which is registering the extension:

[ExtensionSettings]
ActiveExtensions[]=ezfoo

Multiple extensions can be present within the "[ExtensionSettings]" block.

Activating for certain siteaccesses

If you run several virtual sites aka siteaccesses based on a single eZ publish installation and only some of the sites should use the extension, then make the changes in the override file of that siteaccess. This file could be located e.g. at

/root_of_ezpublish/settings/siteaccess/news/site.ini.append[.php]

Notice that the line registering the extension is not called "ActiveExtensions", but "ActiveAccessExtensions":

[ExtensionSettings]
ActiveAccessExtensions[]=ezfoo

Sandro Groganz (06/05/2005 10:11 am)

Sandro Groganz (29/06/2005 11:12 am)


Comments

  • that can break things sometimes...

    You should be aware that (at least until 3.9.2, don't know for more recent) this interface does NOT put the extensions back in the same order they were! That means that if you have an extension of your own that must be included BEFORE others, it may end up at another place in the sequence after writing back.
    I usually verify the site.ini.append.php file after using this, to make sure the order is correct.