Difference between revisions of "PLG configChange"

Revision as of 09:55, 2 May 2009

This API function informs plugins about configuration changes:

function PLG_configChange($group, $changes = array())

where $group is either 'Core' for changes in the core configuration (i.e. the global $_CONF array) or the name of a plugin.

$changes is an array of names of the config values that changed, i.e. keys of $_CONF or the plugin's own configuration array. Note that this parameter is optional.

For example: For a plugin 'foo', a change in $_CONF['path'] and $_CONF['site_mail'] would result in a function call like this:

plugin_configchange_foo('Core', array('path', 'site_mail'));

Note: Details about the changes will only be passed on for changes in the Core configuration and for changes in the plugin's own configuration. Plugins will not be notified of the details of changes in other plugins (only about the fact that the configuration of that other plugin changed). This should be considered an "educational measure" so as not to make plugins depend on the internals of other plugins.

For example, when the 'test' configuration option of plugin 'bar' changes, the plugin 'foo' will be called like so:

plugin_configchange_foo('bar');

while the 'bar' plugin itself will receive a call like so:

plugin_configchange_bar('bar', array('test'));