aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/update_unseen.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hook/update_unseen.bb')
-rw-r--r--doc/hook/update_unseen.bb9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/hook/update_unseen.bb b/doc/hook/update_unseen.bb
new file mode 100644
index 000000000..8fb02c239
--- /dev/null
+++ b/doc/hook/update_unseen.bb
@@ -0,0 +1,9 @@
+[h3]update_unseen[/h3]
+
+Called prior to automatically marking items 'seen'; allowing a plugin the choice to not perform this action.
+
+hook data
+
+[ 'channel_id' => local_channel(), 'update' => 'unset' ];
+
+If 'update' is set to 0 or false on return, the update operation is not performed. \ No newline at end of file