summaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-07-26 16:24:17 -0400
committerJoey Hess <joey@kitenet.net>2010-07-26 16:33:42 -0400
commitc401b6958af7e12c1c2c46f870691bfb0a998fd3 (patch)
treeea0d991a16d08022209bb71d9202f1e4127c849b /doc/plugins/write.mdwn
parentb300bc9650a40885cd8c6e0a646436539aed95c1 (diff)
Add new disable hook, allowing plugins to perform cleanup after they have been disabled.
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 2e3902388..10b4df835 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -600,6 +600,13 @@ function of the ikiwiki wrapper when it is being generated.
The code runs before anything else -- in particular it runs before
the suid wrapper has sanitized its environment.
+### disable
+
+ hook(type => "disable", id => "foo", call => \&disable);
+
+This hook is only run when a previously enabled plugin gets disabled
+during ikiwiki setup. Plugins can use this to perform cleanups.
+
## Exported variables
Several variables are exported to your plugin when you `use IkiWiki;`