From efdb7a3835bbaad168bf3c4fb1bf46a6d4fe705e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20M=C3=BCller?= <25648755+M-arcus@users.noreply.github.com> Date: Mon, 23 Apr 2018 17:20:16 +0200 Subject: [PATCH] [DOCS] Addons: Restructure hooks --- doc/Addons.md | 375 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 245 insertions(+), 130 deletions(-) diff --git a/doc/Addons.md b/doc/Addons.md index 4df91864b..221c68a81 100644 --- a/doc/Addons.md +++ b/doc/Addons.md @@ -321,184 +321,299 @@ Complete list of hook callbacks Here is a complete list of all hook callbacks with file locations (as of 01-Apr-2018). Please see the source for details of any hooks not documented above. -index.php: Addon::callHooks('init_1'); -index.php: Addon::callHooks('app_menu', $arr); -index.php: Addon::callHooks('page_content_top', $a->page['content']); -index.php: Addon::callHooks($a->module.'_mod_init', $placeholder); -index.php: Addon::callHooks($a->module.'_mod_init', $placeholder); -index.php: Addon::callHooks($a->module.'_mod_post', $_POST); -index.php: Addon::callHooks($a->module.'_mod_afterpost', $placeholder); -index.php: Addon::callHooks($a->module.'_mod_content', $arr); -index.php: Addon::callHooks($a->module.'_mod_aftercontent', $arr); -index.php: Addon::callHooks('page_end', $a->page['content']); +### index.php -include/api.php: Addon::callHooks('logged_in', $a->user); -include/api.php: Addon::callHooks('authenticate', $addon_auth); -include/api.php: Addon::callHooks('logged_in', $a->user); + Addon::callHooks('init_1'); + Addon::callHooks('app_menu', $arr); + Addon::callHooks('page_content_top', $a->page['content']); + Addon::callHooks($a->module.'_mod_init', $placeholder); + Addon::callHooks($a->module.'_mod_init', $placeholder); + Addon::callHooks($a->module.'_mod_post', $_POST); + Addon::callHooks($a->module.'_mod_afterpost', $placeholder); + Addon::callHooks($a->module.'_mod_content', $arr); + Addon::callHooks($a->module.'_mod_aftercontent', $arr); + Addon::callHooks('page_end', $a->page['content']); + +### include/api.php + Addon::callHooks('logged_in', $a->user); + Addon::callHooks('authenticate', $addon_auth); + Addon::callHooks('logged_in', $a->user); -include/enotify.php: Addon::callHooks('enotify', $h); -include/enotify.php: Addon::callHooks('enotify_store', $datarray); -include/enotify.php: Addon::callHooks('enotify_mail', $datarray); -include/enotify.php: Addon::callHooks('check_item_notification', $notification_data); +### include/enotify.php + + Addon::callHooks('enotify', $h); + Addon::callHooks('enotify_store', $datarray); + Addon::callHooks('enotify_mail', $datarray); + Addon::callHooks('check_item_notification', $notification_data); + +### include/conversation.php -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('display_item', $arr); -include/conversation.php: Addon::callHooks('item_photo_menu', $args); -include/conversation.php: Addon::callHooks('jot_tool', $jotplugins); + Addon::callHooks('conversation_start', $cb); + Addon::callHooks('render_location', $locate); + Addon::callHooks('display_item', $arr); + Addon::callHooks('display_item', $arr); + Addon::callHooks('item_photo_menu', $args); + Addon::callHooks('jot_tool', $jotplugins); -include/security.php: Addon::callHooks('logged_in', $a->user); +### include/security.php + + Addon::callHooks('logged_in', $a->user); -include/text.php: Addon::callHooks('contact_block_end', $arr); -include/text.php: Addon::callHooks('poke_verbs', $arr); -include/text.php: Addon::callHooks('prepare_body_init', $item); -include/text.php: Addon::callHooks('prepare_body_content_filter', $hook_data); -include/text.php: Addon::callHooks('prepare_body', $hook_data); -include/text.php: Addon::callHooks('prepare_body_final', $hook_data); +### include/text.php -include/items.php: Addon::callHooks('page_info_data', $data); + Addon::callHooks('contact_block_end', $arr); + Addon::callHooks('poke_verbs', $arr); + Addon::callHooks('prepare_body_init', $item); + Addon::callHooks('prepare_body_content_filter', $hook_data); + Addon::callHooks('prepare_body', $hook_data); + Addon::callHooks('prepare_body_final', $hook_data); -mod/directory.php: Addon::callHooks('directory_item', $arr); +### include/items.php + + Addon::callHooks('page_info_data', $data); -mod/xrd.php: Addon::callHooks('personal_xrd', $arr); +### mod/directory.php + + Addon::callHooks('directory_item', $arr); -mod/ping.php: Addon::callHooks('network_ping', $arr); +### mod/xrd.php + + Addon::callHooks('personal_xrd', $arr); -mod/parse_url.php: Addon::callHooks("parse_link", $arr); +### mod/ping.php + + Addon::callHooks('network_ping', $arr); -mod/manage.php: Addon::callHooks('home_init', $ret); +### mod/parse_url.php + + Addon::callHooks("parse_link", $arr); -mod/acl.php: Addon::callHooks('acl_lookup_end', $results); +### mod/manage.php + + Addon::callHooks('home_init', $ret); -mod/network.php: Addon::callHooks('network_content_init', $arr); -mod/network.php: Addon::callHooks('network_tabs', $arr); +### mod/acl.php + + Addon::callHooks('acl_lookup_end', $results); -mod/friendica.php: Addon::callHooks('about_hook', $o); -mod/subthread.php: Addon::callHooks('post_local_end', $arr); +### mod/network.php + + Addon::callHooks('network_content_init', $arr); + Addon::callHooks('network_tabs', $arr); -mod/profiles.php: Addon::callHooks('profile_post', $_POST); -mod/profiles.php: Addon::callHooks('profile_edit', $arr); +### mod/friendica.php + + Addon::callHooks('about_hook', $o); + +### mod/subthread.php + + Addon::callHooks('post_local_end', $arr); -mod/settings.php: Addon::callHooks('addon_settings_post', $_POST); -mod/settings.php: Addon::callHooks('connector_settings_post', $_POST); -mod/settings.php: Addon::callHooks('display_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('display_settings', $o); -mod/settings.php: Addon::callHooks('settings_form', $o); +### mod/profiles.php + + Addon::callHooks('profile_post', $_POST); + Addon::callHooks('profile_edit', $arr); -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', $foo); -mod/photos.php: Addon::callHooks('photo_post_end', intval($item_id)); -mod/photos.php: Addon::callHooks('photo_upload_form', $ret); +### mod/settings.php + + Addon::callHooks('addon_settings_post', $_POST); + Addon::callHooks('connector_settings_post', $_POST); + Addon::callHooks('display_settings_post', $_POST); + Addon::callHooks('settings_post', $_POST); + Addon::callHooks('addon_settings', $settings_addons); + Addon::callHooks('connector_settings', $settings_connectors); + Addon::callHooks('display_settings', $o); + Addon::callHooks('settings_form', $o); -mod/profile.php: Addon::callHooks('profile_advanced', $o); +### mod/photos.php + + Addon::callHooks('photo_post_init', $_POST); + Addon::callHooks('photo_post_file', $ret); + Addon::callHooks('photo_post_end', $foo); + Addon::callHooks('photo_post_end', $foo); + Addon::callHooks('photo_post_end', $foo); + Addon::callHooks('photo_post_end', $foo); + Addon::callHooks('photo_post_end', intval($item_id)); + Addon::callHooks('photo_upload_form', $ret); -mod/home.php: Addon::callHooks('home_init', $ret); -mod/home.php: Addon::callHooks("home_content", $content); +### mod/profile.php + + Addon::callHooks('profile_advanced', $o); -mod/poke.php: Addon::callHooks('post_local_end', $arr); +### mod/home.php + + Addon::callHooks('home_init', $ret); + Addon::callHooks("home_content", $content); -mod/contacts.php: Addon::callHooks('contact_edit_post', $_POST); -mod/contacts.php: Addon::callHooks('contact_edit', $arr); +### mod/poke.php + + Addon::callHooks('post_local_end', $arr); -mod/tagger.php: Addon::callHooks('post_local_end', $arr); +### mod/contacts.php + + Addon::callHooks('contact_edit_post', $_POST); + Addon::callHooks('contact_edit', $arr); -mod/lockview.php: Addon::callHooks('lockview_content', $item); +### mod/tagger.php + + Addon::callHooks('post_local_end', $arr); -mod/uexport.php: Addon::callHooks('uexport_options', $options); +### mod/lockview.php + + Addon::callHooks('lockview_content', $item); -mod/register.php: Addon::callHooks('register_post', $arr); -mod/register.php: Addon::callHooks('register_form', $arr); +### mod/uexport.php + + Addon::callHooks('uexport_options', $options); -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/register.php + + Addon::callHooks('register_post', $arr); + Addon::callHooks('register_form', $arr); -mod/editpost.php: Addon::callHooks('jot_tool', $jotplugins); +### mod/item.php + + Addon::callHooks('post_local_start', $_REQUEST); + Addon::callHooks('post_local', $datarray); + Addon::callHooks('post_local_end', $datarray); -src/Network/FKOAuth1.php: Addon::callHooks('logged_in', $a->user); +### mod/editpost.php -src/Render/FriendicaSmartyEngine.php: Addon::callHooks("template_vars", $arr); + Addon::callHooks('jot_tool', $jotplugins); -src/Model/Item.php: Addon::callHooks('post_local', $item); -src/Model/Item.php: Addon::callHooks('post_remote', $item); -src/Model/Item.php: Addon::callHooks('post_local_end', $posted_item); -src/Model/Item.php: Addon::callHooks('post_remote_end', $posted_item); -src/Model/Item.php: Addon::callHooks('tagged', $arr); -src/Model/Item.php: Addon::callHooks('post_local_end', $new_item); +### src/Network/FKOAuth1.php + + Addon::callHooks('logged_in', $a->user); -src/Model/Contact.php: Addon::callHooks('contact_photo_menu', $args); -src/Model/Contact.php: Addon::callHooks('follow', $arr); +### src/Render/FriendicaSmartyEngine.php + + Addon::callHooks("template_vars", $arr); -src/Model/Profile.php: Addon::callHooks('profile_sidebar_enter', $profile); -src/Model/Profile.php: Addon::callHooks('profile_sidebar', $arr); -src/Model/Profile.php: Addon::callHooks('profile_tabs', $arr); -src/Model/Profile.php: Addon::callHooks('zrl_init', $arr); +### src/Model/Item.php -src/Model/Event.php: Addon::callHooks('event_updated', $event['id']); -src/Model/Event.php: Addon::callHooks("event_created", $event['id']); + Addon::callHooks('post_local', $item); + Addon::callHooks('post_remote', $item); + Addon::callHooks('post_local_end', $posted_item); + Addon::callHooks('post_remote_end', $posted_item); + Addon::callHooks('tagged', $arr); + Addon::callHooks('post_local_end', $new_item); -src/Model/User.php: Addon::callHooks('register_account', $uid); -src/Model/User.php: Addon::callHooks('remove_user', $user); +### src/Model/Contact.php -src/Content/Text/BBCode.php: Addon::callHooks('bbcode', $text); -src/Content/Text/BBCode.php: Addon::callHooks('bb2diaspora', $text); + Addon::callHooks('contact_photo_menu', $args); + Addon::callHooks('follow', $arr); -src/Content/Text/HTML.php: Addon::callHooks('html2bbcode', $message); +### src/Model/Profile.php -src/Content/Smilies.php: Addon::callHooks('smilie', $params); + Addon::callHooks('profile_sidebar_enter', $profile); + Addon::callHooks('profile_sidebar', $arr); + Addon::callHooks('profile_tabs', $arr); + Addon::callHooks('zrl_init', $arr); -src/Content/Feature.php: Addon::callHooks('isEnabled', $arr); -src/Content/Feature.php: Addon::callHooks('get', $arr); +### src/Model/Event.php + + Addon::callHooks('event_updated', $event['id']); + Addon::callHooks("event_created", $event['id']); -src/Content/ContactSelector.php: Addon::callHooks('network_to_name', $nets); -src/Content/ContactSelector.php: Addon::callHooks('gender_selector', $select); -src/Content/ContactSelector.php: Addon::callHooks('sexpref_selector', $select); -src/Content/ContactSelector.php: Addon::callHooks('marital_selector', $select); +### src/Model/User.php + + Addon::callHooks('register_account', $uid); + Addon::callHooks('remove_user', $user); -src/Content/OEmbed.php: Addon::callHooks('oembed_fetch_url', $embedurl, $j); +### src/Content/Text/BBCode.php + + Addon::callHooks('bbcode', $text); + Addon::callHooks('bb2diaspora', $text); -src/Content/Nav.php: Addon::callHooks('page_header', $a->page['nav']); -src/Content/Nav.php: Addon::callHooks('nav_info', $nav); +### src/Content/Text/HTML.php + + Addon::callHooks('html2bbcode', $message); -src/Worker/Directory.php: Addon::callHooks('globaldir_update', $arr); -src/Worker/Notifier.php: Addon::callHooks('notifier_end', $target_item); -src/Worker/Queue.php: Addon::callHooks('queue_predeliver', $r); -src/Worker/Queue.php: Addon::callHooks('queue_deliver', $params); +### src/Content/Smilies.php + + Addon::callHooks('smilie', $params); -src/Module/Login.php: Addon::callHooks('authenticate', $addon_auth); -src/Module/Login.php: Addon::callHooks('login_hook', $o); -src/Module/Logout.php: Addon::callHooks("logging_out"); +### src/Content/Feature.php + + Addon::callHooks('isEnabled', $arr); + Addon::callHooks('get', $arr); -src/Object/Post.php: Addon::callHooks('render_location', $locate); -src/Object/Post.php: Addon::callHooks('display_item', $arr); +### src/Content/ContactSelector.php + + Addon::callHooks('network_to_name', $nets); + Addon::callHooks('gender_selector', $select); + Addon::callHooks('sexpref_selector', $select); + Addon::callHooks('marital_selector', $select); -src/Core/ACL.php: Addon::callHooks('contact_select_options', $x); -src/Core/ACL.php: Addon::callHooks($a->module.'_pre_'.$selname, $arr); -src/Core/ACL.php: Addon::callHooks($a->module.'_post_'.$selname, $o); -src/Core/ACL.php: Addon::callHooks($a->module.'_pre_'.$selname, $arr); -src/Core/ACL.php: Addon::callHooks($a->module.'_post_'.$selname, $o); -src/Core/ACL.php: Addon::callHooks('jot_networks', $jotnets); +### src/Content/OEmbed.php -src/Core/Worker.php: Addon::callHooks("proc_run", $arr); + Addon::callHooks('oembed_fetch_url', $embedurl, $j); -src/Util/Emailer.php: Addon::callHooks('emailer_send_prepare', $params); -src/Util/Emailer.php: Addon::callHooks("emailer_send", $hookdata); +### src/Content/Nav.php -src/Util/Map.php: Addon::callHooks('generate_map', $arr); -src/Util/Map.php: Addon::callHooks('generate_named_map', $arr); -src/Util/Map.php: Addon::callHooks('Map::getCoordinates', $arr); + Addon::callHooks('page_header', $a->page['nav']); + Addon::callHooks('nav_info', $nav); -src/Util/Network.php: Addon::callHooks('avatar_lookup', $avatar); +### src/Worker/Directory.php + + Addon::callHooks('globaldir_update', $arr); -src/Util/ParseUrl.php: Addon::callHooks("getsiteinfo", $siteinfo); +### src/Worker/Notifier.php + + Addon::callHooks('notifier_end', $target_item); -src/Protocol/DFRN.php: Addon::callHooks('atom_feed_end', $atom); -src/Protocol/DFRN.php: Addon::callHooks('atom_feed_end', $atom); +### src/Worker/Queue.php + + Addon::callHooks('queue_predeliver', $r); + Addon::callHooks('queue_deliver', $params); + +### src/Module/Login.php + + Addon::callHooks('authenticate', $addon_auth); + Addon::callHooks('login_hook', $o); + +### src/Module/Logout.php + + Addon::callHooks("logging_out"); + +### src/Object/Post.php + + Addon::callHooks('render_location', $locate); + Addon::callHooks('display_item', $arr); + +### src/Core/ACL.php + + Addon::callHooks('contact_select_options', $x); + Addon::callHooks($a->module.'_pre_'.$selname, $arr); + Addon::callHooks($a->module.'_post_'.$selname, $o); + Addon::callHooks($a->module.'_pre_'.$selname, $arr); + Addon::callHooks($a->module.'_post_'.$selname, $o); + Addon::callHooks('jot_networks', $jotnets); + +### src/Core/Worker.php + + Addon::callHooks("proc_run", $arr); + +### src/Util/Emailer.php + + Addon::callHooks('emailer_send_prepare', $params); + Addon::callHooks("emailer_send", $hookdata); + +### src/Util/Map.php + + Addon::callHooks('generate_map', $arr); + Addon::callHooks('generate_named_map', $arr); + Addon::callHooks('Map::getCoordinates', $arr); + +### src/Util/Network.php + + Addon::callHooks('avatar_lookup', $avatar); + +### src/Util/ParseUrl.php + + Addon::callHooks("getsiteinfo", $siteinfo); + +### src/Protocol/DFRN.php + + Addon::callHooks('atom_feed_end', $atom); + Addon::callHooks('atom_feed_end', $atom);