summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2009-01-01 17:47:20 +0100
committerintrigeri <intrigeri@boum.org>2009-01-01 17:47:20 +0100
commita8105f68590c7aa56fc37ec62df854546a119060 (patch)
tree9340919727fb53ddb27f95c4d53f2da247dd0087 /doc/plugins
parentb24f236dfa2903805bc233a7fc97101d912ae3ee (diff)
rename: pass the CGI and session to the rename hook
The po plugin remame + canrename hook combination will need this. Signed-off-by: intrigeri <intrigeri@boum.org>
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index a927b1629..a1e14cb94 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -392,9 +392,13 @@ new page.
hook(type => "rename", id => "foo", call => \&renamepages);
When a page or set of pages is renamed, the referenced function is
-called, and passed a reference to an array of hashes with keys:
-`src`, `srcfile`, `dest`, `destfile`, `required`. It can modify
-the array.
+called, and is passed:
+
+* a reference to an array of hashes with keys: `src`, `srcfile`,
+ `dest`, `destfile`, `required`. Such a hook function can modify
+ the array.
+* a CGI object
+* a session object
### getsetup