diff options
| author | zotlabs <mike@macgirvin.com> | 2016-12-12 20:28:13 -0800 |
|---|---|---|
| committer | zotlabs <mike@macgirvin.com> | 2016-12-12 20:28:13 -0800 |
| commit | ca44ce5f8cb5ab78d8d5f33c71f29d943ea91a8e (patch) | |
| tree | 18f9ca07513663e3e4ac660468fd281b5dc93791 /doc | |
| parent | 3c0358c9cf4e45310edfe528eb7f7936c54abf6d (diff) | |
| download | volse-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')
| -rw-r--r-- | doc/hook/stream_item.bb | 13 | ||||
| -rw-r--r-- | doc/hooklist.bb | 3 |
2 files changed, 16 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. diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 52af9608c..ac3912568 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -542,6 +542,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/smilie]smilie[/zrl] Called when translating emoticons +[zrl=[baseurl]/help/hook/stream_item]stream_item[/zrl] + Called for each item which is rendered for viewing via conversation() + [zrl=[baseurl]/help/hook/tagged]tagged[/zrl] Called when a delivery is processed which results in you being tagged |