aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/stream_item.bb
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2016-12-12 20:28:13 -0800
committerzotlabs <mike@macgirvin.com>2016-12-12 20:28:13 -0800
commitca44ce5f8cb5ab78d8d5f33c71f29d943ea91a8e (patch)
tree18f9ca07513663e3e4ac660468fd281b5dc93791 /doc/hook/stream_item.bb
parent3c0358c9cf4e45310edfe528eb7f7936c54abf6d (diff)
downloadvolse-hubzilla-ca44ce5f8cb5ab78d8d5f33c71f29d943ea91a8e.tar.gz
volse-hubzilla-ca44ce5f8cb5ab78d8d5f33c71f29d943ea91a8e.tar.bz2
volse-hubzilla-ca44ce5f8cb5ab78d8d5f33c71f29d943ea91a8e.zip
document the stream_item hook before I forget
Diffstat (limited to 'doc/hook/stream_item.bb')
-rw-r--r--doc/hook/stream_item.bb13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/hook/stream_item.bb b/doc/hook/stream_item.bb
new file mode 100644
index 000000000..30086961d
--- /dev/null
+++ b/doc/hook/stream_item.bb
@@ -0,0 +1,13 @@
+[h2]stream_item[/h2]
+
+
+Called for each item processed for viewing by conversation();
+
+The hook data consists of an array
+
+ array(
+ 'mode' => current mode of conversation()
+ 'item' => item being processed
+ );
+
+ Set item['blocked'] to block the item from viewing. This action will not affect comment or sub-thread counts, so if there are three comments in a conversation and you block one, three comments will still be reported even though only two are visible.