harukin/core
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document the stream_item hook before I forget

Browse Source
This commit is contained in:
zotlabs 2016-12-12 20:28:13 -08:00
parent 3c0358c9cf
commit ca44ce5f8c
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/hook/stream_item.bb Normal file
View File

@ -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.

3
doc/hooklist.bb
View File

@ -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