friendica
/
friendica
mirror of https://github.com/friendica/friendica
6
0
Fork 1
Code Issues Packages Projects Releases 1 Wiki Activity

Added PHP part of JavaScript hooks to Addons.md doc

This commit is contained in:
Pascal Deklerck 2018-06-14 15:31:38 +02:00
parent 0eace1ffa4
commit ff0a4a3124
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/Addons.md
View File

@ -71,6 +71,29 @@ Remember to declare it with '&' if you wish to alter it.
JavaScript addon hooks
---
#### PHP part
Make sure your JavaScript addon file (addon/*addon_name*/*addon_name*.js) is listed in the document response.
In your addon install function, add:
Addon::registerHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
In your addon uninstall function, add:
Addon::unregisterHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
Then, add your addon name to the *addon_hooks* template variable array:
function <addon_name>_template_vars($a, &$arr)
{
if (!array_key_exists('addon_hooks',$arr['vars']))
{
$arr['vars']['addon_hooks'] = array();
}
$arr['vars']['addon_hooks'][] = "<addon_name>";
}
#### JavaScript part
Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
Addon_registerHook(type,hookfnstr);