more doco

This commit is contained in:
redmatrix 2015-11-09 18:25:18 -08:00
parent fba2603304
commit c0260ff701
7 changed files with 41 additions and 4 deletions

View file

@ -1 +0,0 @@
[h2]app_menu[/h2]

View file

@ -1 +1,5 @@
[h2]cron[/h2]
Called when cron task (include/poller.php) is executed. The hook data is a string representing the current time (UTC).

View file

@ -1 +1,3 @@
[h2]cron_daily[/h2]
Called when cron task (include/poller.php) performs a cron_daily operation. The hook data is a string representing the current time (UTC).

View file

@ -1 +1,3 @@
[h2]cron_weekly[/h2]
Called when cron task (include/poller.php) performs a cron_weekly operation. The hook data is a string representing the current time (UTC).

View file

@ -1 +1,19 @@
[h2]smilie[/h2]
Called when processing translation of emoticons. It is passed an array containing two sub-arrays:
array(
'texts' => array('text1','text2',...),
'icons' => array('icon1','icon2',...)
);
texts is the emoticon text - for example ':-)' for a traditional smile face.
icons is the HTML used as a replacement. For example
'<img class="smiley" src="https://localhost/images/smiley-smile.gif" alt=":-)" />'
If adding or removing an entry from either array, the corresponding element from the matching array must also
be added or removed. Emoticons less than three characters in length or not recommended as they get triggered
incorrectly quite often. Extended emoticons are indicated by convention using a preceding colon, for example
:walrus_kissing_a_baby

View file

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

View file

@ -40,9 +40,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/api_perm_is_allowed]api_perm_is_allowed[/zrl]
Called when perm_is_allowed() is executed from an API call.
[zrl=[baseurl]/help/hook/app_menu]app_menu[/zrl]
Used to register plugins as apps
[zrl=[baseurl]/help/hook/atom_author]atom_author[/zrl]
Called when generating an author or owner element for an Atom ActivityStream feed