]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
* Add sessioncgi hook.
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index 90818c42e6777b58e862d366d2b6b4ae3cc86392..416f1b86e63cd8d68ddb0fa9eb34f5de9f5cf6d6 100644 (file)
@@ -208,6 +208,15 @@ object's "name" parameter to the authenticated user's name. Note that
 if the name is set to the name of a user who is not registered,
 a basic registration of the user will be automatically performed.
 
+### sessioncgi
+
+       hook(type => "sessioncgi", id => "foo", call => \&sessioncgi);
+
+Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook
+is only run once a session object is available. It is passed both a CGI
+object and a session object. To check if the user is in fact signed in, you
+can check if the session object has a "name" parameter set.
+
 ### canedit
 
        hook(type => "canedit", id => "foo", call => \&pagelocked);