summaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2009-01-01 19:48:27 +0100
committerintrigeri <intrigeri@boum.org>2009-01-01 19:48:27 +0100
commitd69fdf64455eb343160bca73443e62e550b3c052 (patch)
treec5888ae433f731f5316bf3f79a83c828308311da /doc/plugins/write.mdwn
parente895157397c4602359f8612e4ce9964bcabc8928 (diff)
editpage: added a cansave hook
Signed-off-by: intrigeri <intrigeri@boum.org>
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 92e372cfa..fff142fa2 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -321,6 +321,21 @@ This hook should avoid directly redirecting the user to a signin page,
since it's sometimes used to test to see which pages in a set of pages a
user can edit.
+### cansave
+
+ hook(type => "cansave", id => "foo", call => \&cansave);
+
+This hook can be used to implement arbitrary access methods to control
+when a page being edited can be saved using the web interface (commits
+from revision control bypass it).
+
+When a page is about to be saved, each registered cansave hook is
+called in turn, and passed the page name, the edited content, a CGI
+object and a session object.
+
+The return value of a cansave hook is interpreted the same as for the
+canedit hook.
+
### canremove
hook(type => "canremove", id => "foo", call => \&canremove);