Start and EndActionExecute added/fixed/documented

[quix0rs-gnu-social.git] / EVENTS.txt

diff --git a/EVENTS.txt b/EVENTS.txt
index b98c6ff52fda2a06e6b26ce9ae2a270a0a816c5b..caa99f9638a82866d051e589f3255a03b83a10c7 100644 (file)
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -2,6 +2,13 @@ InitializePlugin: a chance to initialize a plugin in a complete environment
 
 CleanupPlugin: a chance to cleanup a plugin at the end of a program
 
+StartActionExecute: Right before the "prepare" call of the current Action
+- $action:  the current Action object
+- &$args:   array of arguments, referenced so you can modify the array
+
+EndActionExecute:   Right after the "handle" call of the current Action
+- $action:      the current Action object
+
 StartPrimaryNav: Showing the primary nav menu
 - $action: the current action
 
@@ -1465,10 +1472,25 @@ EndNotifyMentioned: During notice distribution, we send notifications (email, im
 - $mentioned_ids:  Array of profile IDs (not just for local users) who got mentioned by the notice.
 
 StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
-- $action: action being executed (for output and params)
-- $items: array of items in the nav
+- $out:     HTMLOutputter used to output (usually an Action, but not always!)
+- &$items:  Referenced array of items in the nav (add if desired)
 
 EndHomeStubNavItems:
-- $action: action being executed (for output and params)
-- $items: array of items in the nav
+- $out:     HTMLOutputter used to output (usually an Action, but not always!)
+- $items:   array of menu items
+
+StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
+- $out:     HTMLOutputter used to output (usually an Action, but not always!)
+- $menu:    The Menu object outputted as a submenu.
+- $label:   Localized text which represents the menu item.
+
+EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
+- $out:     HTMLOutputter used to output (usually an Action, but not always!)
+- $menu:    The Menu object outputted as a submenu.
+- $label:   Localized text which represents the menu item.
+
+StartDocNav: Before outputting the docs Nav
+- $nav: The DoclNav widget
 
+EndDocNav: After outputting the docs Nav
+- $nav: The DoclNav widget