Plugin API

From GeeklogWiki
Revision as of 17:46, 23 May 2009 by Dirk (talk | contribs) (draft version of a page to list all Plugin API functions)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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).


Installation

API Function Description
PLG_chkVersion Called to check if a plugin upgrade is required
PLG_enableStateChange Inform plugin that it's about to be enabled or disabled
PLG_install (not currently used)
PLG_migrate Site migration underway; plugin should migrate its data
PLG_uninstall Plugin should uninstall itself or provide data for uninstallation
PLG_upgrade Plugin should upgrade itself