X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FPlugins.md;h=ab8c58eb856801efd20c2cca07e783dbae91f199;hb=b6f1d3bae389a55bec62de847599bccc68b0193b;hp=a30a3f4a71fe1db2f95815ce75717ff69439024e;hpb=9330a6994c1b9aee49a482efe32e84ca1a944c9b;p=friendica.git diff --git a/doc/Plugins.md b/doc/Plugins.md index a30a3f4a71..ab8c58eb85 100644 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -36,11 +36,14 @@ This *should* be 'addon/plugin_name/plugin_name.php' in most cases. $function is a string and is the name of the function which will be executed when the hook is called. +Please also add a README or README.md file to the addon directory. +It will be displayed in the admin panel and should include some further information in addition to the header information. + Arguments --- Your hook callback functions will be called with at least one and possibly two arguments - function myhook_function(&$a, &$b) { + function myhook_function(App $a, &$b) { } @@ -77,9 +80,9 @@ This will include: $a->argc = 3 $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2'); -Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content. -They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms. -You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation. +Your module functions will often contain the function plugin_name_content(App $a), which defines and returns the page body content. +They may also contain plugin_name_post(App $a) which is called before the _content function and typically handles the results of POST forms. +You may also have plugin_name_init(App $a) which is called very early on and often does module initialisation. Templates --- @@ -281,6 +284,11 @@ $b is an array with: 'template' => filename of template 'vars' => array of vars passed to template +### ''acl_lookup_end' +is called after the other queries have passed. +The registered function can add, change or remove the acl_lookup() variables. + + 'results' => array of the acl_lookup() vars Complete list of hook callbacks @@ -338,6 +346,8 @@ include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); +include/acl_selectors.php call_hooks('acl_lookup_end', $results); + include/notifier.php: call_hooks('notifier_normal',$target_item); include/notifier.php: call_hooks('notifier_end',$target_item);