X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/fd2b2f386f30cf2ba578da8a8174dd60ae024adc..5bee98156aaee2ea796703ecd5df2d4a25e9d9b8:/doc/plugins/write.mdwn?ds=inline diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 2e3902388..31bb64e68 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -179,8 +179,8 @@ function is passed no values. This allows a plugin to manipulate the list of files that need to be built when the wiki is refreshed. The function is passed a reference to an -array of files that will be rebuilt, and can modify the array, either -adding or removing files from it. +array of files that will be rebuilt. It should return an array reference +that is a modified version of its input. It can add or remove files from it. ### scan @@ -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;`