Plugin API
From GeeklogWiki
Revision as of 18:30, 23 May 2009 by Dirk (talk | contribs) (switched to using the plugin_ names so things are documented from the plugin's point of view)
Geeklog's Plugin API defines the interface between the core Geeklog code and the plugins. From Geeklog's point of view, all the Plugin API functions are called PLG_something
, which will result in a function plugin_something_foo
being called in the "foo" plugin (if it exists - all the API functions are optional).
For details about Plugin API functions that are not documented yet, please refer to the documented source code of lib-plugins.php
Contents
Installation
API Function | Description |
---|---|
plugin_autouninstall_ | Plugin should provide data for uninstallation |
plugin_chkVersion_ | Called to check if a plugin upgrade is required |
plugin_enablestatechange_ | Inform plugin that it's about to be enabled or disabled |
plugin_install_ | (not currently used) |
plugin_migrate_ | Site migration underway; plugin should migrate its data |
plugin_uninstall_ | Plugin should uninstall itself |
plugin_upgrade_ | Plugin should upgrade itself |