bitPickups/friendica_2019-12_sharedHosting_hotFix
1
1
Fork 0
Code Pull requests Activity

Merge pull request #5214 from abanink/5118

Browse source 
Added PHP part of JavaScript hooks to Addons.md doc
This commit is contained in:
Hypolite Petovan 2018-06-14 10:32:02 -04:00 committed by GitHub
commit 0134fa31d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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 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'. Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
Addon_registerHook(type,hookfnstr); Addon_registerHook(type,hookfnstr);