Gold/Docs/Anatomy of a Plugin

From Mahara Wiki

< User:Gold‎ | Docs


The barebones of a plugin. This is intended to become a developer reference.

How to get your plugin seen by the system

The Plugin will either live in the htdocs directory, for a stand alone plugin, or the directory of the plugin that it extends.

The following conditions and methods need to be implemented by your Plugin.

  • Your plugin needs to extend the Plugin abstract class.
  • get_plugintype_name() : machine readable name for the type of Plugin. Allows for plugins to be extensible and grouped.
  • get_plugin_display_name() : Optional human readable name for your Plugin.