]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
response
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index 8071f323edae969cee3ef4327f2bf8a2e70cce46..10b4df835f9fde4eac70f6980727fbad8a7aa562 100644 (file)
@@ -198,11 +198,9 @@ value is ignored.
 
        hook(type => "filter", id => "foo", call => \&filter);
 
-Runs on the raw source of a page, before anything else touches it, and can
-make arbitrary changes. The function is passed named parameters "page",
-"destpage", "content" and "fullpage". "fullpage" is a true value if,
-and only if, a full page's content is being filtered, e.g. as opposed
-to a directive parameter. It should return the filtered content.
+Runs on the full raw source of a page, before anything else touches it, and
+can make arbitrary changes. The function is passed named parameters "page",
+"destpage", and "content". It should return the filtered content.
 
 ### preprocess
 
@@ -602,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;`