From ca4c93c6b938b92919bdb9aee938b864d1d64d5d Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Mon, 8 Feb 2021 20:20:24 +0300
Subject: [PATCH] pluginhost: note hook function prototypes
---
classes/pluginhost.php | 92 +++++++++++++++++++++---------------------
1 file changed, 47 insertions(+), 45 deletions(-)
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index af3cfcc9b..108d95a88 100755
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -22,54 +22,56 @@ class PluginHost {
// Hooks marked with *1 are run in global context and available
// to plugins loaded in config.php only
- const HOOK_ARTICLE_BUTTON = "hook_article_button";
- const HOOK_ARTICLE_FILTER = "hook_article_filter";
- const HOOK_PREFS_TAB = "hook_prefs_tab";
- const HOOK_PREFS_TAB_SECTION = "hook_prefs_tab_section";
- const HOOK_PREFS_TABS = "hook_prefs_tabs";
- const HOOK_FEED_PARSED = "hook_feed_parsed";
- const HOOK_UPDATE_TASK = "hook_update_task"; //*1
- const HOOK_AUTH_USER = "hook_auth_user";
- const HOOK_HOTKEY_MAP = "hook_hotkey_map";
- const HOOK_RENDER_ARTICLE = "hook_render_article";
- const HOOK_RENDER_ARTICLE_CDM = "hook_render_article_cdm";
- const HOOK_FEED_FETCHED = "hook_feed_fetched";
- const HOOK_SANITIZE = "hook_sanitize";
- const HOOK_RENDER_ARTICLE_API = "hook_render_article_api";
- const HOOK_TOOLBAR_BUTTON = "hook_toolbar_button";
- const HOOK_ACTION_ITEM = "hook_action_item";
- const HOOK_HEADLINE_TOOLBAR_BUTTON = "hook_headline_toolbar_button";
- const HOOK_HOTKEY_INFO = "hook_hotkey_info";
- const HOOK_ARTICLE_LEFT_BUTTON = "hook_article_left_button";
- const HOOK_PREFS_EDIT_FEED = "hook_prefs_edit_feed";
- const HOOK_PREFS_SAVE_FEED = "hook_prefs_save_feed";
- const HOOK_FETCH_FEED = "hook_fetch_feed";
- const HOOK_QUERY_HEADLINES = "hook_query_headlines";
- const HOOK_HOUSE_KEEPING = "hook_house_keeping"; //*1
- const HOOK_SEARCH = "hook_search";
- const HOOK_FORMAT_ENCLOSURES = "hook_format_enclosures";
- const HOOK_SUBSCRIBE_FEED = "hook_subscribe_feed";
- const HOOK_HEADLINES_BEFORE = "hook_headlines_before";
- const HOOK_RENDER_ENCLOSURE = "hook_render_enclosure";
- const HOOK_ARTICLE_FILTER_ACTION = "hook_article_filter_action";
- const HOOK_ARTICLE_EXPORT_FEED = "hook_article_export_feed";
- const HOOK_MAIN_TOOLBAR_BUTTON = "hook_main_toolbar_button";
- const HOOK_ENCLOSURE_ENTRY = "hook_enclosure_entry";
- const HOOK_FORMAT_ARTICLE = "hook_format_article";
+ const HOOK_ARTICLE_BUTTON = "hook_article_button"; // hook_article_button($line)
+ const HOOK_ARTICLE_FILTER = "hook_article_filter"; // hook_article_filter($article)
+ const HOOK_PREFS_TAB = "hook_prefs_tab"; // hook_prefs_tab($tab)
+ const HOOK_PREFS_TAB_SECTION = "hook_prefs_tab_section"; // hook_prefs_tab_section($section)
+ const HOOK_PREFS_TABS = "hook_prefs_tabs"; // hook_prefs_tabs()
+ const HOOK_FEED_PARSED = "hook_feed_parsed"; // hook_feed_parsed($parser, $feed_id)
+ const HOOK_UPDATE_TASK = "hook_update_task"; //*1 // GLOBAL: hook_update_task($cli_options)
+ const HOOK_AUTH_USER = "hook_auth_user"; // hook_auth_user($login, $password, $service) (byref)
+ const HOOK_HOTKEY_MAP = "hook_hotkey_map"; // hook_hotkey_map($hotkeys) (byref)
+ const HOOK_RENDER_ARTICLE = "hook_render_article"; // hook_render_article($article)
+ const HOOK_RENDER_ARTICLE_CDM = "hook_render_article_cdm"; // hook_render_article_cdm($article)
+ const HOOK_FEED_FETCHED = "hook_feed_fetched"; // hook_feed_fetched($feed_data, $fetch_url, $owner_uid, $feed) (byref)
+ const HOOK_SANITIZE = "hook_sanitize"; // hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) (byref)
+ const HOOK_RENDER_ARTICLE_API = "hook_render_article_api"; // hook_render_article_api($params)
+ const HOOK_TOOLBAR_BUTTON = "hook_toolbar_button"; // hook_toolbar_button()
+ const HOOK_ACTION_ITEM = "hook_action_item"; // hook_action_item()
+ const HOOK_HEADLINE_TOOLBAR_BUTTON = "hook_headline_toolbar_button"; // hook_headline_toolbar_button($feed_id, $is_cat)
+ const HOOK_HOTKEY_INFO = "hook_hotkey_info"; // hook_hotkey_info($hotkeys) (byref)
+ const HOOK_ARTICLE_LEFT_BUTTON = "hook_article_left_button"; // hook_article_left_button($row)
+ const HOOK_PREFS_EDIT_FEED = "hook_prefs_edit_feed"; // hook_prefs_edit_feed($feed_id)
+ const HOOK_PREFS_SAVE_FEED = "hook_prefs_save_feed"; // hook_prefs_save_feed($feed_id)
+ const HOOK_FETCH_FEED = "hook_fetch_feed"; // hook_fetch_feed($feed_data, $fetch_url, $owner_uid, $feed, $last_article_timestamp, $auth_login, $auth_pass) (byref)
+ const HOOK_QUERY_HEADLINES = "hook_query_headlines"; // hook_query_headlines($row) (byref)
+ const HOOK_HOUSE_KEEPING = "hook_house_keeping"; //*1 // GLOBAL: hook_house_keeping()
+ const HOOK_SEARCH = "hook_search"; // hook_search($query)
+ const HOOK_FORMAT_ENCLOSURES = "hook_format_enclosures"; // hook_format_enclosures($rv, $result, $id, $always_display_enclosures, $article_content, $hide_images) (byref)
+ const HOOK_SUBSCRIBE_FEED = "hook_subscribe_feed"; // hook_subscribe_feed($contents, $url, $auth_login, $auth_pass) (byref)
+ const HOOK_HEADLINES_BEFORE = "hook_headlines_before"; // hook_headlines_before($feed, $is_cat, $qfh_ret)
+ const HOOK_RENDER_ENCLOSURE = "hook_render_enclosure"; // hook_render_enclosure($entry, $hide_images)
+ const HOOK_ARTICLE_FILTER_ACTION = "hook_article_filter_action"; // hook_article_filter_action($article, $action)
+ const HOOK_ARTICLE_EXPORT_FEED = "hook_article_export_feed"; // hook_article_export_feed($line, $feed, $is_cat, $owner_uid) (byref)
+ const HOOK_MAIN_TOOLBAR_BUTTON = "hook_main_toolbar_button"; // hook_main_toolbar_button()
+ const HOOK_ENCLOSURE_ENTRY = "hook_enclosure_entry"; // hook_enclosure_entry($row, $id) (byref)
+ const HOOK_FORMAT_ARTICLE = "hook_format_article"; // hook_format_article($html, $row)
const HOOK_FORMAT_ARTICLE_CDM = "hook_format_article_cdm"; /* RIP */
- const HOOK_FEED_BASIC_INFO = "hook_feed_basic_info";
- const HOOK_SEND_LOCAL_FILE = "hook_send_local_file";
- const HOOK_UNSUBSCRIBE_FEED = "hook_unsubscribe_feed";
- const HOOK_SEND_MAIL = "hook_send_mail";
- const HOOK_FILTER_TRIGGERED = "hook_filter_triggered";
- const HOOK_GET_FULL_TEXT = "hook_get_full_text";
- const HOOK_ARTICLE_IMAGE = "hook_article_image";
- const HOOK_FEED_TREE = "hook_feed_tree";
- const HOOK_IFRAME_WHITELISTED = "hook_iframe_whitelisted";
- const HOOK_ENCLOSURE_IMPORTED = "hook_enclosure_imported";
- const HOOK_HEADLINES_CUSTOM_SORT_MAP = "hook_headlines_custom_sort_map";
+ const HOOK_FEED_BASIC_INFO = "hook_feed_basic_info"; // hook_feed_basic_info($basic_info, $fetch_url, $owner_uid, $feed_id, $auth_login, $auth_pass) (byref)
+ const HOOK_SEND_LOCAL_FILE = "hook_send_local_file"; // hook_send_local_file($filename)
+ const HOOK_UNSUBSCRIBE_FEED = "hook_unsubscribe_feed"; // hook_unsubscribe_feed($feed_id, $owner_uid)
+ const HOOK_SEND_MAIL = "hook_send_mail"; // hook_send_mail($mailer, $params)
+ const HOOK_FILTER_TRIGGERED = "hook_filter_triggered"; // hook_filter_triggered($feed_id, $owner_uid, $article, $matched_filters, $matched_rules, $article_filters)
+ const HOOK_GET_FULL_TEXT = "hook_get_full_text"; // hook_get_full_text($url)
+ const HOOK_ARTICLE_IMAGE = "hook_article_image"; // hook_article_image($enclosures, $content, $site_url)
+ const HOOK_FEED_TREE = "hook_feed_tree"; // hook_feed_tree()
+ const HOOK_IFRAME_WHITELISTED = "hook_iframe_whitelisted"; // hook_iframe_whitelisted($url)
+ const HOOK_ENCLOSURE_IMPORTED = "hook_enclosure_imported"; // hook_enclosure_imported($enclosure, $feed)
+ const HOOK_HEADLINES_CUSTOM_SORT_MAP = "hook_headlines_custom_sort_map"; // hook_headlines_custom_sort_map()
const HOOK_HEADLINES_CUSTOM_SORT_OVERRIDE = "hook_headlines_custom_sort_override";
+ // hook_headlines_custom_sort_override($order)
const HOOK_HEADLINE_TOOLBAR_SELECT_MENU_ITEM = "hook_headline_toolbar_select_menu_item";
+ // hook_headline_toolbar_select_menu_item($feed_id, $is_cat)
const KIND_ALL = 1;
const KIND_SYSTEM = 2;
--
GitLab