Documenation

Plugins

Plugins are programs that extend Swiftlet's functionality. They can be installed without modifying any of the original code.

Plugins are stored in the /_plugins/ directory. Swiftlet will scan this directory and include every plugin it finds. Plugins that require a database need to be installed using the plugin installer at /installer/.

To learn about creating plugins, see Creating plugins.

Class

$pluginsLoaded['plugin_name']

Public functions

  • $model->pluginsLoaded['plugin_name']->hook ( string $hook, int $order [ , array $params ] )
    Hook a plugin into the code.
  • $model->pluginsLoaded['plugin_name']->install ( )
    Install a plugin (call the 'install' hook).
  • $model->pluginsLoaded['plugin_name']->upgrade ( )
    Upgrade a plugin (call the 'upgrade' hook).
  • $model->pluginsLoaded['plugin_name']->remove ( )
    Remove a plugin (call the 'remove' hook).
  • $model->pluginsLoaded['plugin_name']->get_version ( )
    Get version number of a plugin.

See also