]> git.mxchange.org Git - friendica.git/commitdiff
Review updates
authorAdam Magness <adam.magness@gmail.com>
Thu, 18 Jan 2018 00:38:14 +0000 (19:38 -0500)
committerAdam Magness <adam.magness@gmail.com>
Sat, 20 Jan 2018 12:48:22 +0000 (07:48 -0500)
INSTALL.txt
doc/Addons.md [new file with mode: 0644]
doc/Plugins.md [deleted file]
doc/database/db_addon.md

index 5dee845677199f2c15a8362f9e2171ec0bef7b1f..01fe65d118584895bb8c6670d36bb2ab61a10c79 100644 (file)
@@ -141,7 +141,7 @@ installation, it will look like
 $a->config['system']['addon'] = 'js_upload';
 
 This indicates the "js_upload" addon module is enabled. You may add additional 
-addons/addons using this same line in the configuration file. Change it to 
+addons using this same line in the configuration file. Change it to 
 read
 
 $a->config['system']['addon'] = 'js_upload,poormancron';
diff --git a/doc/Addons.md b/doc/Addons.md
new file mode 100644 (file)
index 0000000..5d13107
--- /dev/null
@@ -0,0 +1,473 @@
+Friendica Addon development
+==============
+
+* [Home](help)
+
+Please see the sample addon 'randplace' for a working example of using some of these features.
+Addons work by intercepting event hooks - which must be registered.
+Modules work by intercepting specific page requests (by URL path).
+
+Addon names cannot contain spaces or other punctuation and are used as filenames and function names.
+You may supply a "friendly" name within the comment block.
+Each addon must contain both an install and an uninstall function based on the addon name.
+For instance "addon1name_install()".
+These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
+The install and uninstall functions will also be called (i.e. re-installed) if the addon changes after installation.
+Therefore your uninstall should not destroy data and install should consider that data may already exist.
+Future extensions may provide for "setup" amd "remove".
+
+Addons should contain a comment block with the four following parameters:
+
+    /*
+     * Name: My Great Addon
+     * Description: This is what my addon does. It's really cool.
+     * Version: 1.0
+     * Author: John Q. Public <john@myfriendicasite.com>
+     */
+
+Register your addon hooks during installation.
+
+    Addon::registerHook($hookname, $file, $function);
+
+$hookname is a string and corresponds to a known Friendica hook.
+
+$file is a pathname relative to the top-level Friendica directory.
+This *should* be 'addon/addon_name/addon_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(App $a, &$b) {
+
+    }
+
+
+If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
+
+#### $a
+$a is the Friendica 'App' class.
+It contains a wealth of information about the current state of Friendica:
+
+* which module has been called,
+* configuration information,
+* the page contents at the point the hook was invoked,
+* profile and user information, etc.
+
+It is recommeded you call this '$a' to match its usage elsewhere.
+
+#### $b
+$b can be called anything you like.
+This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
+Remember to declare it with '&' if you wish to alter it.
+
+Modules
+---
+
+Addons may also act as "modules" and intercept all page requests for a given URL path.
+In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
+
+If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.
+These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
+So http://my.web.site/addon/arg1/arg2 would look for a module named "addon" and pass its module functions the $a App structure (which is available to many components).
+This will include:
+
+    $a->argc = 3
+    $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
+
+Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
+They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
+You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
+
+Templates
+---
+
+If your addon needs some template, you can use the Friendica template system.
+Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
+
+Put your tpl files in the *templates/* subfolder of your addon.
+
+In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
+
+    # load template file. first argument is the template name,
+    # second is the addon path relative to friendica top folder
+    $tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
+
+    # apply template. first argument is the loaded template,
+    # second an array of 'name'=>'values' to pass to template
+    $output = replace_macros($tpl,array(
+        'title' => 'My beautiful addon',
+    ));
+
+See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
+
+Current hooks
+-------------
+
+### 'authenticate'
+'authenticate' is called when a user attempts to login.
+$b is an array containing:
+
+    'username' => the supplied username
+    'password' => the supplied password
+    'authenticated' => set this to non-zero to authenticate the user.
+    'user_record' => successful authentication must also return a valid user record from the database
+
+### 'logged_in'
+'logged_in' is called after a user has successfully logged in.
+$b contains the $a->user array.
+
+### 'display_item'
+'display_item' is called when formatting a post for display.
+$b is an array:
+
+       'item' => The item (array) details pulled from the database
+       'output' => the (string) HTML representation of this item prior to adding it to the page
+
+### 'post_local'
+* called when a status post or comment is entered on the local system
+* $b is the item array of the information to be stored in the database
+* Please note: body contents are bbcode - not HTML
+
+### 'post_local_end'
+* called when a local status post or comment has been stored on the local system
+* $b is the item array of the information which has just been stored in the database
+* Please note: body contents are bbcode - not HTML
+
+### 'post_remote'
+* called when receiving a post from another source. This may also be used to post local activity or system generated messages.
+* $b is the item array of information to be stored in the database and the item body is bbcode.
+
+### 'settings_form'
+* called when generating the HTML for the user Settings page
+* $b is the (string) HTML of the settings page before the final '</form>' tag.
+
+### 'settings_post'
+* called when the Settings pages are submitted
+* $b is the $_POST array
+
+### 'addon_settings'
+* called when generating the HTML for the addon settings page
+* $b is the (string) HTML of the addon settings page before the final '</form>' tag.
+
+### 'addon_settings_post'
+* called when the Addon Settings pages are submitted
+* $b is the $_POST array
+
+### 'profile_post'
+* called when posting a profile page
+* $b is the $_POST array
+
+### 'profile_edit'
+'profile_edit' is called prior to output of profile edit page.
+$b is an array containing:
+
+       'profile' => profile (array) record from the database
+       'entry' => the (string) HTML of the generated entry
+
+### 'profile_advanced'
+* called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
+* $b is the (string) HTML representation of the generated profile
+* The profile array details are in $a->profile.
+
+### 'directory_item'
+'directory_item' is called from the Directory page when formatting an item for display.
+$b is an array:
+
+       'contact' => contact (array) record for the person from the database
+    'entry' => the (string) HTML of the generated entry
+
+### 'profile_sidebar_enter'
+* called prior to generating the sidebar "short" profile for a page
+* $b is the person's profile array
+
+### 'profile_sidebar'
+'profile_sidebar is called when generating the sidebar "short" profile for a page.
+$b is an array:
+
+       'profile' => profile (array) record for the person from the database
+       'entry' => the (string) HTML of the generated entry
+
+### 'contact_block_end'
+is called when formatting the block of contacts/friends on a profile sidebar has completed.
+$b is an array:
+
+       'contacts' => array of contacts
+       'output' => the (string) generated HTML of the contact block
+
+### 'bbcode'
+* called during conversion of bbcode to html
+* $b is a string converted text
+
+### 'html2bbcode'
+* called during conversion of html to bbcode (e.g. remote message posting)
+* $b is a string converted text
+
+### 'page_header'
+* called after building the page navigation section
+* $b is a string HTML of nav region
+
+### 'personal_xrd'
+'personal_xrd' is called prior to output of personal XRD file.
+$b is an array:
+
+       'user' => the user record for the person
+       'xml' => the complete XML to be output
+
+### 'home_content'
+* called prior to output home page content, shown to unlogged users
+* $b is (string) HTML of section region
+
+### 'contact_edit'
+is called when editing contact details on an individual from the Contacts page.
+$b is an array:
+
+       'contact' => contact record (array) of target contact
+       'output' => the (string) generated HTML of the contact edit page
+
+### 'contact_edit_post'
+* called when posting the contact edit page.
+* $b is the $_POST array
+
+### 'init_1'
+* called just after DB has been opened and before session start
+* $b is not used or passed
+
+### 'page_end'
+* called after HTML content functions have completed
+* $b is (string) HTML of content div
+
+### 'avatar_lookup'
+'avatar_lookup' is called when looking up the avatar.
+$b is an array:
+
+       'size' => the size of the avatar that will be looked up
+       'email' => email to look up the avatar for
+       'url' => the (string) generated URL of the avatar
+
+### 'emailer_send_prepare'
+'emailer_send_prepare' called from Emailer::send() before building the mime message.
+$b is an array, params to Emailer::send()
+
+    'fromName' => name of the sender
+    'fromEmail' => email fo the sender
+    'replyTo' => replyTo address to direct responses
+    'toEmail' => destination email address
+    'messageSubject' => subject of the message
+    'htmlVersion' => html version of the message
+    'textVersion' => text only version of the message
+    'additionalMailHeader' => additions to the smtp mail header
+
+### 'emailer_send'
+is called before calling PHP's mail().
+$b is an array, params to mail()
+
+    'to'
+    'subject'
+    'body'
+    'headers'
+
+### 'nav_info'
+is called after the navigational menu is build in include/nav.php.
+$b is an array containing $nav from nav.php.
+
+### 'template_vars'
+is called before vars are passed to the template engine to render the page.
+The registered function can add,change or remove variables passed to template.
+$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
+---
+
+Here is a complete list of all hook callbacks with file locations (as of 14-Feb-2012). Please see the source for details of any hooks not documented above.
+
+boot.php:      Addon::callHooks('login_hook',$o);
+
+boot.php:      Addon::callHooks('profile_sidebar_enter', $profile);
+
+boot.php:      Addon::callHooks('profile_sidebar', $arr);
+
+boot.php:      Addon::callHooks("proc_run", $arr);
+
+include/contact_selectors.php: Addon::callHooks('network_to_name', $nets);
+
+include/api.php:                               Addon::callHooks('logged_in', $a->user);
+
+include/api.php:               Addon::callHooks('logged_in', $a->user);
+
+include/queue.php:             Addon::callHooks('queue_predeliver', $a, $r);
+
+include/queue.php:                             Addon::callHooks('queue_deliver', $a, $params);
+
+include/text.php:      Addon::callHooks('contact_block_end', $arr);
+
+include/text.php:      Addon::callHooks('smilie', $s);
+
+include/text.php:      Addon::callHooks('prepare_body_init', $item);
+
+include/text.php:      Addon::callHooks('prepare_body', $prep_arr);
+
+include/text.php:      Addon::callHooks('prepare_body_final', $prep_arr);
+
+include/nav.php:       Addon::callHooks('page_header', $a->page['nav']);
+
+include/auth.php:              Addon::callHooks('authenticate', $addon_auth);
+
+include/bbcode.php:    Addon::callHooks('bbcode',$Text);
+
+include/oauth.php:             Addon::callHooks('logged_in', $a->user);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
+
+include/acl_selectors.php:     Addon::callHooks('contact_select_options', $x);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
+
+include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
+
+include/acl_selectors.php      Addon::callHooks('acl_lookup_end', $results);
+
+include/notifier.php:          Addon::callHooks('notifier_normal',$target_item);
+
+include/notifier.php:  Addon::callHooks('notifier_end',$target_item);
+
+include/items.php:     Addon::callHooks('atom_feed', $atom);
+
+include/items.php:             Addon::callHooks('atom_feed_end', $atom);
+
+include/items.php:     Addon::callHooks('atom_feed_end', $atom);
+
+include/items.php:     Addon::callHooks('parse_atom', $arr);
+
+include/items.php:     Addon::callHooks('post_remote',$arr);
+
+include/items.php:     Addon::callHooks('atom_author', $o);
+
+include/items.php:     Addon::callHooks('atom_entry', $o);
+
+include/bb2diaspora.php:       Addon::callHooks('bb2diaspora',$Text);
+
+include/cronhooks.php: Addon::callHooks('cron', $d);
+
+include/security.php:          Addon::callHooks('logged_in', $a->user);
+
+include/html2bbcode.php:       Addon::callHooks('html2bbcode', $text);
+
+include/Contact.php:   Addon::callHooks('remove_user',$r[0]);
+
+include/Contact.php:   Addon::callHooks('contact_photo_menu', $args);
+
+include/conversation.php:      Addon::callHooks('conversation_start',$cb);
+
+include/conversation.php:                              Addon::callHooks('render_location',$locate);
+
+include/conversation.php:                              Addon::callHooks('display_item', $arr);
+
+include/conversation.php:                              Addon::callHooks('render_location',$locate);
+
+include/conversation.php:                              Addon::callHooks('display_item', $arr);
+
+include/conversation.php:      Addon::callHooks('item_photo_menu', $args);
+
+include/conversation.php:      Addon::callHooks('jot_tool', $jotplugins);
+
+include/conversation.php:      Addon::callHooks('jot_networks', $jotnets);
+
+index.php:     Addon::callHooks('init_1');
+
+index.php:Addon::callHooks('app_menu', $arr);
+
+index.php:Addon::callHooks('page_end', $a->page['content']);
+
+mod/photos.php:        Addon::callHooks('photo_post_init', $_POST);
+
+mod/photos.php:        Addon::callHooks('photo_post_file',$ret);
+
+mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
+
+mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
+
+mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
+
+mod/photos.php:        Addon::callHooks('photo_post_end',intval($item_id));
+
+mod/photos.php:                Addon::callHooks('photo_upload_form',$ret);
+
+mod/friendica.php:     Addon::callHooks('about_hook', $o);
+
+mod/editpost.php:      Addon::callHooks('jot_tool', $jotplugins);
+
+mod/editpost.php:      Addon::callHooks('jot_networks', $jotnets);
+
+mod/parse_url.php:     Addon::callHooks('parse_link', $arr);
+
+mod/home.php:  Addon::callHooks('home_init',$ret);
+
+mod/home.php:  Addon::callHooks("home_content",$o);
+
+mod/contacts.php:      Addon::callHooks('contact_edit_post', $_POST);
+
+mod/contacts.php:              Addon::callHooks('contact_edit', $arr);
+
+mod/settings.php:              Addon::callHooks('addon_settings_post', $_POST);
+
+mod/settings.php:              Addon::callHooks('connector_settings_post', $_POST);
+
+mod/settings.php:      Addon::callHooks('settings_post', $_POST);
+
+mod/settings.php:              Addon::callHooks('addon_settings', $settings_addons);
+
+mod/settings.php:              Addon::callHooks('connector_settings', $settings_connectors);
+
+mod/settings.php:      Addon::callHooks('settings_form',$o);
+
+mod/register.php:      Addon::callHooks('register_account', $newuid);
+
+mod/like.php:  Addon::callHooks('post_local_end', $arr);
+
+mod/xrd.php:   Addon::callHooks('personal_xrd', $arr);
+
+mod/item.php:  Addon::callHooks('post_local_start', $_REQUEST);
+
+mod/item.php:  Addon::callHooks('post_local',$datarray);
+
+mod/item.php:  Addon::callHooks('post_local_end', $datarray);
+
+mod/profile.php:                       Addon::callHooks('profile_advanced',$o);
+
+mod/profiles.php:      Addon::callHooks('profile_post', $_POST);
+
+mod/profiles.php:              Addon::callHooks('profile_edit', $arr);
+
+mod/tagger.php:        Addon::callHooks('post_local_end', $arr);
+
+mod/cb.php:    Addon::callHooks('cb_init');
+
+mod/cb.php:    Addon::callHooks('cb_post', $_POST);
+
+mod/cb.php:    Addon::callHooks('cb_afterpost');
+
+mod/cb.php:    Addon::callHooks('cb_content', $o);
+
+mod/directory.php:                     Addon::callHooks('directory_item', $arr);
diff --git a/doc/Plugins.md b/doc/Plugins.md
deleted file mode 100644 (file)
index 4c2596e..0000000
+++ /dev/null
@@ -1,473 +0,0 @@
-Friendica Addon development
-==============
-
-* [Home](help)
-
-Please see the sample addon 'randplace' for a working example of using some of these features.
-Addons work by intercepting event hooks - which must be registered.
-Modules work by intercepting specific page requests (by URL path).
-
-Addon names cannot contain spaces or other punctuation and are used as filenames and function names.
-You may supply a "friendly" name within the comment block.
-Each addon must contain both an install and an uninstall function based on the addon/addon name.
-For instance "addon1name_install()".
-These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
-The install and uninstall functions will also be called (i.e. re-installed) if the addon changes after installation.
-Therefore your uninstall should not destroy data and install should consider that data may already exist.
-Future extensions may provide for "setup" amd "remove".
-
-Addons should contain a comment block with the four following parameters:
-
-    /*
-     * Name: My Great Addon
-     * Description: This is what my addon does. It's really cool.
-     * Version: 1.0
-     * Author: John Q. Public <john@myfriendicasite.com>
-     */
-
-Register your addon hooks during installation.
-
-    Addon::registerHook($hookname, $file, $function);
-
-$hookname is a string and corresponds to a known Friendica hook.
-
-$file is a pathname relative to the top-level Friendica directory.
-This *should* be 'addon/addon_name/addon_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(App $a, &$b) {
-
-    }
-
-
-If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
-
-#### $a
-$a is the Friendica 'App' class.
-It contains a wealth of information about the current state of Friendica:
-
-* which module has been called,
-* configuration information,
-* the page contents at the point the hook was invoked,
-* profile and user information, etc.
-
-It is recommeded you call this '$a' to match its usage elsewhere.
-
-#### $b
-$b can be called anything you like.
-This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
-Remember to declare it with '&' if you wish to alter it.
-
-Modules
----
-
-Addons/addons may also act as "modules" and intercept all page requests for a given URL path.
-In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
-
-If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.
-These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
-So http://my.web.site/addon/arg1/arg2 would look for a module named "addon" and pass its module functions the $a App structure (which is available to many components).
-This will include:
-
-    $a->argc = 3
-    $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
-
-Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
-They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
-You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
-
-Templates
----
-
-If your addon needs some template, you can use the Friendica template system.
-Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
-
-Put your tpl files in the *templates/* subfolder of your addon.
-
-In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
-
-    # load template file. first argument is the template name,
-    # second is the addon path relative to friendica top folder
-    $tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
-
-    # apply template. first argument is the loaded template,
-    # second an array of 'name'=>'values' to pass to template
-    $output = replace_macros($tpl,array(
-        'title' => 'My beautiful addon',
-    ));
-
-See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
-
-Current hooks
--------------
-
-### 'authenticate'
-'authenticate' is called when a user attempts to login.
-$b is an array containing:
-
-    'username' => the supplied username
-    'password' => the supplied password
-    'authenticated' => set this to non-zero to authenticate the user.
-    'user_record' => successful authentication must also return a valid user record from the database
-
-### 'logged_in'
-'logged_in' is called after a user has successfully logged in.
-$b contains the $a->user array.
-
-### 'display_item'
-'display_item' is called when formatting a post for display.
-$b is an array:
-
-       'item' => The item (array) details pulled from the database
-       'output' => the (string) HTML representation of this item prior to adding it to the page
-
-### 'post_local'
-* called when a status post or comment is entered on the local system
-* $b is the item array of the information to be stored in the database
-* Please note: body contents are bbcode - not HTML
-
-### 'post_local_end'
-* called when a local status post or comment has been stored on the local system
-* $b is the item array of the information which has just been stored in the database
-* Please note: body contents are bbcode - not HTML
-
-### 'post_remote'
-* called when receiving a post from another source. This may also be used to post local activity or system generated messages.
-* $b is the item array of information to be stored in the database and the item body is bbcode.
-
-### 'settings_form'
-* called when generating the HTML for the user Settings page
-* $b is the (string) HTML of the settings page before the final '</form>' tag.
-
-### 'settings_post'
-* called when the Settings pages are submitted
-* $b is the $_POST array
-
-### 'addon_settings'
-* called when generating the HTML for the addon settings page
-* $b is the (string) HTML of the addon settings page before the final '</form>' tag.
-
-### 'addon_settings_post'
-* called when the Addon Settings pages are submitted
-* $b is the $_POST array
-
-### 'profile_post'
-* called when posting a profile page
-* $b is the $_POST array
-
-### 'profile_edit'
-'profile_edit' is called prior to output of profile edit page.
-$b is an array containing:
-
-       'profile' => profile (array) record from the database
-       'entry' => the (string) HTML of the generated entry
-
-### 'profile_advanced'
-* called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
-* $b is the (string) HTML representation of the generated profile
-* The profile array details are in $a->profile.
-
-### 'directory_item'
-'directory_item' is called from the Directory page when formatting an item for display.
-$b is an array:
-
-       'contact' => contact (array) record for the person from the database
-    'entry' => the (string) HTML of the generated entry
-
-### 'profile_sidebar_enter'
-* called prior to generating the sidebar "short" profile for a page
-* $b is the person's profile array
-
-### 'profile_sidebar'
-'profile_sidebar is called when generating the sidebar "short" profile for a page.
-$b is an array:
-
-       'profile' => profile (array) record for the person from the database
-       'entry' => the (string) HTML of the generated entry
-
-### 'contact_block_end'
-is called when formatting the block of contacts/friends on a profile sidebar has completed.
-$b is an array:
-
-       'contacts' => array of contacts
-       'output' => the (string) generated HTML of the contact block
-
-### 'bbcode'
-* called during conversion of bbcode to html
-* $b is a string converted text
-
-### 'html2bbcode'
-* called during conversion of html to bbcode (e.g. remote message posting)
-* $b is a string converted text
-
-### 'page_header'
-* called after building the page navigation section
-* $b is a string HTML of nav region
-
-### 'personal_xrd'
-'personal_xrd' is called prior to output of personal XRD file.
-$b is an array:
-
-       'user' => the user record for the person
-       'xml' => the complete XML to be output
-
-### 'home_content'
-* called prior to output home page content, shown to unlogged users
-* $b is (string) HTML of section region
-
-### 'contact_edit'
-is called when editing contact details on an individual from the Contacts page.
-$b is an array:
-
-       'contact' => contact record (array) of target contact
-       'output' => the (string) generated HTML of the contact edit page
-
-### 'contact_edit_post'
-* called when posting the contact edit page.
-* $b is the $_POST array
-
-### 'init_1'
-* called just after DB has been opened and before session start
-* $b is not used or passed
-
-### 'page_end'
-* called after HTML content functions have completed
-* $b is (string) HTML of content div
-
-### 'avatar_lookup'
-'avatar_lookup' is called when looking up the avatar.
-$b is an array:
-
-       'size' => the size of the avatar that will be looked up
-       'email' => email to look up the avatar for
-       'url' => the (string) generated URL of the avatar
-
-### 'emailer_send_prepare'
-'emailer_send_prepare' called from Emailer::send() before building the mime message.
-$b is an array, params to Emailer::send()
-
-    'fromName' => name of the sender
-    'fromEmail' => email fo the sender
-    'replyTo' => replyTo address to direct responses
-    'toEmail' => destination email address
-    'messageSubject' => subject of the message
-    'htmlVersion' => html version of the message
-    'textVersion' => text only version of the message
-    'additionalMailHeader' => additions to the smtp mail header
-
-### 'emailer_send'
-is called before calling PHP's mail().
-$b is an array, params to mail()
-
-    'to'
-    'subject'
-    'body'
-    'headers'
-
-### 'nav_info'
-is called after the navigational menu is build in include/nav.php.
-$b is an array containing $nav from nav.php.
-
-### 'template_vars'
-is called before vars are passed to the template engine to render the page.
-The registered function can add,change or remove variables passed to template.
-$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
----
-
-Here is a complete list of all hook callbacks with file locations (as of 14-Feb-2012). Please see the source for details of any hooks not documented above.
-
-boot.php:      Addon::callHooks('login_hook',$o);
-
-boot.php:      Addon::callHooks('profile_sidebar_enter', $profile);
-
-boot.php:      Addon::callHooks('profile_sidebar', $arr);
-
-boot.php:      Addon::callHooks("proc_run", $arr);
-
-include/contact_selectors.php: Addon::callHooks('network_to_name', $nets);
-
-include/api.php:                               Addon::callHooks('logged_in', $a->user);
-
-include/api.php:               Addon::callHooks('logged_in', $a->user);
-
-include/queue.php:             Addon::callHooks('queue_predeliver', $a, $r);
-
-include/queue.php:                             Addon::callHooks('queue_deliver', $a, $params);
-
-include/text.php:      Addon::callHooks('contact_block_end', $arr);
-
-include/text.php:      Addon::callHooks('smilie', $s);
-
-include/text.php:      Addon::callHooks('prepare_body_init', $item);
-
-include/text.php:      Addon::callHooks('prepare_body', $prep_arr);
-
-include/text.php:      Addon::callHooks('prepare_body_final', $prep_arr);
-
-include/nav.php:       Addon::callHooks('page_header', $a->page['nav']);
-
-include/auth.php:              Addon::callHooks('authenticate', $addon_auth);
-
-include/bbcode.php:    Addon::callHooks('bbcode',$Text);
-
-include/oauth.php:             Addon::callHooks('logged_in', $a->user);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
-
-include/acl_selectors.php:     Addon::callHooks('contact_select_options', $x);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_pre_' . $selname, $arr);
-
-include/acl_selectors.php:     Addon::callHooks($a->module . '_post_' . $selname, $o);
-
-include/acl_selectors.php      Addon::callHooks('acl_lookup_end', $results);
-
-include/notifier.php:          Addon::callHooks('notifier_normal',$target_item);
-
-include/notifier.php:  Addon::callHooks('notifier_end',$target_item);
-
-include/items.php:     Addon::callHooks('atom_feed', $atom);
-
-include/items.php:             Addon::callHooks('atom_feed_end', $atom);
-
-include/items.php:     Addon::callHooks('atom_feed_end', $atom);
-
-include/items.php:     Addon::callHooks('parse_atom', $arr);
-
-include/items.php:     Addon::callHooks('post_remote',$arr);
-
-include/items.php:     Addon::callHooks('atom_author', $o);
-
-include/items.php:     Addon::callHooks('atom_entry', $o);
-
-include/bb2diaspora.php:       Addon::callHooks('bb2diaspora',$Text);
-
-include/cronhooks.php: Addon::callHooks('cron', $d);
-
-include/security.php:          Addon::callHooks('logged_in', $a->user);
-
-include/html2bbcode.php:       Addon::callHooks('html2bbcode', $text);
-
-include/Contact.php:   Addon::callHooks('remove_user',$r[0]);
-
-include/Contact.php:   Addon::callHooks('contact_photo_menu', $args);
-
-include/conversation.php:      Addon::callHooks('conversation_start',$cb);
-
-include/conversation.php:                              Addon::callHooks('render_location',$locate);
-
-include/conversation.php:                              Addon::callHooks('display_item', $arr);
-
-include/conversation.php:                              Addon::callHooks('render_location',$locate);
-
-include/conversation.php:                              Addon::callHooks('display_item', $arr);
-
-include/conversation.php:      Addon::callHooks('item_photo_menu', $args);
-
-include/conversation.php:      Addon::callHooks('jot_tool', $jotplugins);
-
-include/conversation.php:      Addon::callHooks('jot_networks', $jotnets);
-
-index.php:     Addon::callHooks('init_1');
-
-index.php:Addon::callHooks('app_menu', $arr);
-
-index.php:Addon::callHooks('page_end', $a->page['content']);
-
-mod/photos.php:        Addon::callHooks('photo_post_init', $_POST);
-
-mod/photos.php:        Addon::callHooks('photo_post_file',$ret);
-
-mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
-
-mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
-
-mod/photos.php:                Addon::callHooks('photo_post_end',$foo);
-
-mod/photos.php:        Addon::callHooks('photo_post_end',intval($item_id));
-
-mod/photos.php:                Addon::callHooks('photo_upload_form',$ret);
-
-mod/friendica.php:     Addon::callHooks('about_hook', $o);
-
-mod/editpost.php:      Addon::callHooks('jot_tool', $jotplugins);
-
-mod/editpost.php:      Addon::callHooks('jot_networks', $jotnets);
-
-mod/parse_url.php:     Addon::callHooks('parse_link', $arr);
-
-mod/home.php:  Addon::callHooks('home_init',$ret);
-
-mod/home.php:  Addon::callHooks("home_content",$o);
-
-mod/contacts.php:      Addon::callHooks('contact_edit_post', $_POST);
-
-mod/contacts.php:              Addon::callHooks('contact_edit', $arr);
-
-mod/settings.php:              Addon::callHooks('addon_settings_post', $_POST);
-
-mod/settings.php:              Addon::callHooks('connector_settings_post', $_POST);
-
-mod/settings.php:      Addon::callHooks('settings_post', $_POST);
-
-mod/settings.php:              Addon::callHooks('addon_settings', $settings_addons);
-
-mod/settings.php:              Addon::callHooks('connector_settings', $settings_connectors);
-
-mod/settings.php:      Addon::callHooks('settings_form',$o);
-
-mod/register.php:      Addon::callHooks('register_account', $newuid);
-
-mod/like.php:  Addon::callHooks('post_local_end', $arr);
-
-mod/xrd.php:   Addon::callHooks('personal_xrd', $arr);
-
-mod/item.php:  Addon::callHooks('post_local_start', $_REQUEST);
-
-mod/item.php:  Addon::callHooks('post_local',$datarray);
-
-mod/item.php:  Addon::callHooks('post_local_end', $datarray);
-
-mod/profile.php:                       Addon::callHooks('profile_advanced',$o);
-
-mod/profiles.php:      Addon::callHooks('profile_post', $_POST);
-
-mod/profiles.php:              Addon::callHooks('profile_edit', $arr);
-
-mod/tagger.php:        Addon::callHooks('post_local_end', $arr);
-
-mod/cb.php:    Addon::callHooks('cb_init');
-
-mod/cb.php:    Addon::callHooks('cb_post', $_POST);
-
-mod/cb.php:    Addon::callHooks('cb_afterpost');
-
-mod/cb.php:    Addon::callHooks('cb_content', $o);
-
-mod/directory.php:                     Addon::callHooks('directory_item', $arr);
index eceb3b68b998135155ce8e63944440efbd60088f..cd8a3d44a62bf83b10170db3e8e8e5147d5630b6 100644 (file)
@@ -12,6 +12,6 @@ Table addon
 | plugin_admin  | 1 = has admin config, 0 = has no admin config | tinyint(1) | NO   |     | 0       |                 |
 
 Notes:
-These are addons which have been enabled by the site administrator on the admin/addon page
+These are addons which have been enabled by the site administrator on the addon page
 
 Return to [database documentation](help/database)