diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Plugins.md | 171 |
1 files changed, 107 insertions, 64 deletions
diff --git a/doc/Plugins.md b/doc/Plugins.md index 090790d46..70a8726c7 100644 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -4,14 +4,10 @@ This is an early specification and hook details may be subject to change. Please see the sample addon 'randplace' for a working example of using some of these features. The facebook addon provides an example of integrating both "addon" and "module" functionality. Addons work by intercepting event hooks - which must be registered. Modules work by intercepting specific page requests (by URL path). -You must register all addons/plugins with the system in the .htconfig.php file. - - $a->config['system']['addon'] = 'plugin1name, plugin2name, another_name'; Plugin names cannot contain spaces and are used as filenames. Each addon must contain both an install and an uninstall function based on the addon/plugin name. For instance "plugin1name_install()". These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require. The install and uninstall functions will also be called (i.e. re-installed) if the plugin 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". - Register your plugin hooks during installation. register_hook($hookname, $file, $function); @@ -164,126 +160,173 @@ Your module functions will often contain the function plugin_name_content(&$a), $b is (string) HTML of content div -*** = subject to change +A complete list of all hook callbacks with file locations (generated 09-Nov-2011): Please see the source for details of any hooks not documented above. + +boot.php: call_hooks('login_hook',$o); + +boot.php: call_hooks('profile_sidebar_enter', $profile); + +boot.php: call_hooks('profile_sidebar', $arr); + +boot.php: call_hooks("proc_run", $arr); + +include/contact_selectors.php: call_hooks('network_to_name', $s); + +include/api.php: call_hooks('logged_in', $a->user); + +include/api.php: call_hooks('logged_in', $a->user); + +include/queue.php: call_hooks('queue_predeliver', $a, $r); + +include/queue.php: call_hooks('queue_deliver', $a, $params); + +include/text.php: call_hooks('contact_block_end', $arr); + +include/text.php: call_hooks('smilie', $s); -Not yet documented (you may view these within the source code): +include/text.php: call_hooks('prepare_body_init', $item); -**'atom_feed'** *** +include/text.php: call_hooks('prepare_body', $prep_arr); -**'atom_feed_end'** *** +include/text.php: call_hooks('prepare_body_final', $prep_arr); -**'parse_atom'** *** +include/nav.php: call_hooks('page_header', $a->page['nav']); -**'atom_author'** *** +include/auth.php: call_hooks('authenticate', $addon_auth); -**'atom_entry'** *** +include/auth.php: call_hooks('logged_in', $a->user); -A complete list of all hook callbacks with file locations (generated 22-Feb-2011): Please see the source for details of any hooks not documented above. +include/bbcode.php: call_hooks('bbcode',$Text); -boot.php: call_hooks('contact_block_end', $arr); +include/oauth.php: call_hooks('logged_in', $a->user); -boot.php: call_hooks('profile_sidebar_enter', $profile); +include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); -boot.php: call_hooks('profile_sidebar', $arr); +include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); -boot.php: call_hooks("proc_run", $args); +include/acl_selectors.php: call_hooks('contact_select_options', $x); -include/nav.php: call_hooks('page_header', $a->page['nav']); +include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); -include/auth.php: call_hooks('authenticate', $addon_auth); +include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); -include/auth.php: call_hooks('logged_in', $a->user); +include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); -include/bbcode.php: call_hooks('bbcode',$Text); +include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); -include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); +include/notifier.php: call_hooks('notifier_normal',$target_item); -include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); +include/notifier.php: call_hooks('notifier_end',$target_item); -include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr); +include/items.php: call_hooks('atom_feed', $atom); -include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o); +include/items.php: call_hooks('atom_feed_end', $atom); -include/items.php: call_hooks('atom_feed', $atom); +include/items.php: call_hooks('atom_feed_end', $atom); -include/items.php: call_hooks('atom_feed_end', $atom); +include/items.php: call_hooks('parse_atom', $arr); -include/items.php: call_hooks('atom_feed_end', $atom); +include/items.php: call_hooks('post_remote',$arr); -include/items.php: call_hooks('parse_atom', $arr); +include/items.php: call_hooks('atom_author', $o); -include/items.php: call_hooks('post_remote',$arr); +include/items.php: call_hooks('atom_entry', $o); -include/items.php: call_hooks('atom_author', $o); +include/bb2diaspora.php: call_hooks('bb2diaspora',$Text); -include/items.php: call_hooks('atom_entry', $o); +include/cronhooks.php: call_hooks('cron', $d); -include/html2bbcode.php: call_hooks('html2bbcode', $text); +include/html2bbcode.php: call_hooks('html2bbcode', $text); -index.php: call_hooks('init_1'); +include/Contact.php: call_hooks('contact_photo_menu', $args); + +include/conversation.php: call_hooks('display_item', $arr); + +include/conversation.php: call_hooks('display_item', $arr); + +include/conversation.php: call_hooks('item_photo_menu', $args); + +include/conversation.php: call_hooks('jot_tool', $jotplugins); + +include/conversation.php: call_hooks('jot_networks', $jotnets); + +include/plugin.php:if(! function_exists('call_hooks')) { + +include/plugin.php:function call_hooks($name, &$data = null) { + +index.php: call_hooks('init_1'); index.php:call_hooks('app_menu', $arr); index.php:call_hooks('page_end', $a->page['content']); -mod/photos.php: call_hooks('photo_post_init', $_POST); +mod/photos.php: call_hooks('photo_post_init', $_POST); + +mod/photos.php: call_hooks('photo_post_file',$ret); + +mod/photos.php: call_hooks('photo_post_end',$foo); + +mod/photos.php: call_hooks('photo_post_end',$foo); + +mod/photos.php: call_hooks('photo_post_end',$foo); + +mod/photos.php: call_hooks('photo_post_end',intval($item_id)); -mod/photos.php: call_hooks('photo_post_file',$ret); +mod/photos.php: call_hooks('photo_upload_form',$ret); -mod/photos.php: call_hooks('photo_post_end',intval($item_id)); +mod/friendica.php: call_hooks('about_hook', $o); -mod/photos.php: call_hooks('photo_upload_form',$ret); +mod/editpost.php: call_hooks('jot_tool', $jotplugins); -mod/parse_url.php: call_hooks('parse_link', $arr); +mod/editpost.php: call_hooks('jot_networks', $jotnets); -mod/home.php: call_hooks("home_content",$o); +mod/parse_url.php: call_hooks('parse_link', $arr); -mod/contacts.php: call_hooks('contact_edit_post', $_POST); +mod/home.php: call_hooks("home_content",$o); -mod/contacts.php: call_hooks('contact_edit', $arr); +mod/contacts.php: call_hooks('contact_edit_post', $_POST); -mod/settings.php: call_hooks('plugin_settings_post', $_POST); +mod/contacts.php: call_hooks('contact_edit', $arr); -mod/settings.php: call_hooks('settings_post', $_POST); +mod/settings.php: call_hooks('plugin_settings_post', $_POST); -mod/settings.php: call_hooks('plugin_settings', $o); +mod/settings.php: call_hooks('connector_settings_post', $_POST); -mod/settings.php: call_hooks('settings_form',$o); +mod/settings.php: call_hooks('settings_post', $_POST); -mod/network.php: call_hooks('jot_tool', $jotplugins); +mod/settings.php: call_hooks('plugin_settings', $settings_addons); -mod/network.php: call_hooks('jot_networks', $jotnets); +mod/settings.php: call_hooks('connector_settings', $settings_connectors); -mod/network.php: call_hooks('display_item', $arr); +mod/settings.php: call_hooks('settings_form',$o); -mod/xrd.php: call_hooks('personal_xrd', $arr); +mod/register.php: call_hooks('register_account', $newuid); -mod/item.php: call_hooks('post_local_start', $_POST); +mod/like.php: call_hooks('post_local_end', $arr); -mod/item.php: call_hooks('post_local',$datarray); +mod/xrd.php: call_hooks('personal_xrd', $arr); -mod/item.php: call_hooks('post_local_end', $datarray); +mod/item.php: call_hooks('post_local_start', $_POST); -mod/profile.php: call_hooks('profile_advanced',$o); +mod/item.php: call_hooks('post_local',$datarray); -mod/profile.php: call_hooks('jot_tool', $jotplugins); +mod/item.php: call_hooks('post_local_end', $datarray); -mod/profile.php: call_hooks('jot_networks', $jotnets); +mod/profile.php: call_hooks('profile_advanced',$o); -mod/profile.php: call_hooks('display_item', $arr); +mod/profiles.php: call_hooks('profile_post', $_POST); -mod/display.php: call_hooks('display_item', $arr); +mod/profiles.php: call_hooks('profile_edit', $arr); -mod/profiles.php: call_hooks('profile_post', $_POST); +mod/tagger.php: call_hooks('post_local_end', $arr); -mod/profiles.php: call_hooks('profile_edit', $arr); +mod/cb.php: call_hooks('cb_init'); -mod/cb.php: call_hooks('cb_init'); +mod/cb.php: call_hooks('cb_post', $_POST); -mod/cb.php: call_hooks('cb_post', $_POST); +mod/cb.php: call_hooks('cb_afterpost'); -mod/cb.php: call_hooks('cb_afterpost'); +mod/cb.php: call_hooks('cb_content', $o); -mod/cb.php: call_hooks('cb_content', $o); +mod/directory.php: call_hooks('directory_item', $arr); -mod/directory.php: call_hooks('directory_item', $arr); |