[[PageOutline(1-3)]]
= Padre Plugin API =

**See https://metacpan.org/module/Padre::Plugin**

== Overview ==

Padre could be extended by many [wiki:Plugins].

== Methods ==

Each plugin may define some methods which are called by Padre internals:

=== disable ===

Arguments: none

Return value: ignored

The disable method is called when the plugin is disabled:
 * At Padre exit if it has been enabled before
 * Using the PluginManager (manually by the user)

=== enable ===

Arguments: none

Return value: ignored

The enable method is called when the plugin is enabled:
 * At Padre startup if it's enabled in config
 * Using the PluginManager (manually by the user)

=== padre_hooks ===

Arguments: none

Return value: hash reference

Plugins could add hooks to Padre core functions. The "before_save" hook is called just before any open file is flushed to disk.

All valid hooks are listed in [wiki:PluginAPI/Padre_Hooks the list of Padre hooks].

== TODO ==

Add the plugin API documentation here and keep it up to date.