EVENTS.txt

   1 InitializePlugin: a chance to initialize a plugin in a complete environment
   2
   3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
   4
   5 StartPrimaryNav: Showing the primary nav menu
   6 - $action: the current action
   7
   8 EndPrimaryNav: At the end of the primary nav menu
   9 - $action: the current action
  10
  11 StartSecondaryNav: Showing the secondary nav menu
  12 - $action: the current action
  13
  14 EndSecondaryNav: At the end of the secondary nav menu
  15 - $action: the current action
  16
  17 StartShowStyles: Showing Style links; good place to add UA style resets
  18 - $action: the current action
  19
  20 EndShowStyles: End showing Style links; good place to add custom styles
  21 - $action: the current action
  22
  23 StartShowLaconicaStyles: Showing Laconica Style links
  24 - $action: the current action
  25
  26 EndShowLaconicaStyles: End showing Laconica tyle links;  good place to add handheld or JavaScript dependent styles
  27 - $action: the current action
  28
  29 StartShowUAStyles: Showing custom User-Agent style links
  30 - $action: the current action
  31
  32 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  33 - $action: the current action
  34
  35 StartShowScripts: Showing JavaScript links
  36 - $action: the current action
  37
  38 EndShowScripts: End showing JavaScript links; good place to add custom
  39                 links like Google Analytics
  40 - $action: the current action
  41
  42 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  43 - $action: the current action
  44
  45 EndShowJQueryScripts: End showing JQuery script links
  46 - $action: the current action
  47
  48 StartShowLaconicaScripts: Showing Laconica script links (use this to link to a CDN or something)
  49 - $action: the current action
  50
  51 EndShowLaconicaScripts: End showing Laconica script links
  52 - $action: the current action
  53
  54 StartShowSections: Start the list of sections in the sidebar
  55 - $action: the current action
  56
  57 EndShowSections: End the list of sections in the sidebar
  58 - $action: the current action
  59
  60 StartShowHeader: Showing before the header container
  61 - $action: the current action
  62
  63 EndShowHeader: Showing after the header container
  64 - $action: the current action
  65
  66 StartShowFooter: Showing before the footer container
  67 - $action: the current action
  68
  69 EndShowFooter: Showing after the footer container
  70 - $action: the current action
  71
  72 StartShowContentBlock: Showing before the content container
  73 - $action: the current action
  74
  75 EndShowContentBlock: Showing after the content container
  76 - $action: the current action
  77
  78 StartNoticeSave: before inserting a notice (good place for content filters)
  79 - $notice: notice being saved (no ID or URI)
  80
  81 EndNoticeSave: after inserting a notice and related code
  82 - $notice: notice that was saved (with ID and URI)
  83
  84 StartShowLocalNavBlock: Showing the local nav menu
  85 - $action: the current action
  86
  87 EndShowLocalNavBlock: At the end of the local nav menu
  88 - $action: the current action
  89
  90 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
  91 - $action: the current action
  92
  93 EndShowHTML: Showing after the html element
  94 - $action: the current action
  95
  96 StartPublicGroupNav: Showing the public group nav menu
  97 - $action: the current action
  98
  99 EndPublicGroupNav: At the end of the public group nav menu
 100 - $action: the current action
 101
 102 StartSubGroupNav: Showing the subscriptions group nav menu
 103 - $action: the current action
 104
 105 EndSubGroupNav: At the end of the subscriptions group nav menu
 106 - $action: the current action
 107
 108 RouterInitialized: After the router instance has been initialized
 109 - $m: the Net_URL_Mapper that has just been set up
 110
 111 StartLogout: Before logging out
 112 - $action: the logout action
 113
 114 EndLogout: After logging out
 115 - $action: the logout action
 116
 117 ArgsInitialized: After the argument array has been initialized
 118 - $args: associative array of arguments, can be modified
 119
 120 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 121 - $action: the current action
 122
 123 EndAddressData: At the end of <address>
 124 - $action: the current action
 125
 126 StartLoginGroupNav: Before showing the login and register navigation menu
 127 - $action: the current action
 128
 129 EndLoginGroupNav: After showing the login and register navigation menu
 130 - $action: the current action
 131
 132 StartAccountSettingsNav: Before showing the account settings menu
 133 - $action: the current action
 134
 135 EndAccountSettingsNav: After showing the account settings menu
 136 - $action: the current action
 137
 138 Autoload: When trying to autoload a class
 139 - $cls: the class being sought. A plugin might require_once the file for the class.
 140
 141 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 142 - $action: name of the action, like 'login'
 143 - $sensitive: flag for whether this is a sensitive action
 144
 145 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 146 - $action: name of the action, like 'register'
 147 - $login: flag for whether this is a login action
 148
 149 StartShowHead: called before showing the <head> element and children
 150 - $action: action object being show
 151
 152 EndShowHead: called after showing the <head> element (and </head>)
 153 - $action: action object being shown
 154
 155 StartShowBody: called before showing the <body> element and children
 156 - $action: action object being shown
 157
 158 EndShowBody: called after showing the <body> element (and </body>)
 159 - $action: action object being shown
 160
 161 StartHeadChildren: called before showing the children of <head> element (after <head> tag)
 162 - $action: action object being shown
 163
 164 EndHeadChildren: called after showing the children of <head> element (before </head>)
 165 - $action: action object being shown
 166
 167 StartPersonalGroupNav: beginning of personal group nav menu
 168 - $action: action object being shown
 169
 170 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 171 - $action: action object being shown
 172
 173 StartEndHTML: just before the </html> tag
 174 - $action: action object being shown
 175
 176 EndEndHTML: just after the </html> tag
 177 - $action: action object being shown
 178
 179 StartShowDesign: just before showing a site, user, or group design
 180 - $action: action object being shown
 181
 182 EndShowDesign: just after showing a site, user, or group design
 183 - $action: action object being shown
 184
 185 StartShowExportData: just before showing the <div> with export data (feeds)
 186 - $action: action object being shown
 187
 188 EndShowExportData: just after showing the <div> with export data (feeds)
 189 - $action: action object being shown
 190
 191 StartShowPageNotice: just before showing the page notice (instructions or error)
 192 - $action: action object being shown
 193
 194 EndShowPageNotice: just after showing the page notice (instructions or error)
 195 - $action: action object being shown
 196
 197 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 198 - $action: action object being shown
 199
 200 StartProfileFormData: just before showing text entry fields on profile settings page
 201 - $action: action object being shown
 202
 203 EndProfileFormData: just after showing text entry fields on profile settings page
 204 - $action: action object being shown
 205
 206 StartProfileSaveForm: before starting to save a profile settings form
 207 - $action: action object being shown
 208
 209 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 210 - $action: action object being shown
 211
 212 StartRegistrationFormData: just before showing text entry fields on registration page
 213 - $action: action object being shown
 214
 215 EndRegistrationFormData: just after showing text entry fields on registration page
 216 - $action: action object being shown
 217
 218 StartRegistrationTry: before validating and saving a new user
 219 - $action: action object being shown
 220
 221 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 222 - $action: action object being shown
 223
 224 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 225 - $qm: empty queue manager to set
 226
 227 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 228 - $action: action object being shown
 229 - $user: current user
 230
 231 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 232 - $title: title of the document
 233 - $output: HTML output to show
 234
 235 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 236 - $title: title of the document
 237 - $output: HTML output to show