aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/tagged.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hook/tagged.bb')
-rw-r--r--doc/hook/tagged.bb15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/hook/tagged.bb b/doc/hook/tagged.bb
index 5add76713..05d081d07 100644
--- a/doc/hook/tagged.bb
+++ b/doc/hook/tagged.bb
@@ -1 +1,16 @@
[h2]tagged[/h2]
+
+
+This hook is called when a delivery is made which results in the recipient being tagged.
+
+The hook data is an array containing
+
+ array(
+ 'channel_id' => int,
+ 'item' => item structure of the delivered item from database,
+ 'body' => the body of the referenced item
+
+ );
+
+ Note: This hook is called before secondary delivery chains are invoked in the case of tagging a forum. This means that permissions and some item attributes will be those of the item before being re-packaged and before ownership of this item is given to the forum.
+