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 StartShowStatusNetStyles: Showing StatusNet Style links
  24 - $action: the current action
  25
  26 EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
  27 - $action: the current action
  28
  29 StartShowLaconicaStyles: backwards compatibility; deprecated
  30 - $action: the current action
  31
  32 EndShowLaconicaStyles: backwards compatibility; deprecated
  33 - $action: the current action
  34
  35 StartShowUAStyles: Showing custom User-Agent style links
  36 - $action: the current action
  37
  38 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  39 - $action: the current action
  40
  41 StartShowScripts: Showing JavaScript links
  42 - $action: the current action
  43
  44 EndShowScripts: End showing JavaScript links; good place to add custom
  45                 links like Google Analytics
  46 - $action: the current action
  47
  48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  49 - $action: the current action
  50
  51 EndShowJQueryScripts: End showing JQuery script links
  52 - $action: the current action
  53
  54 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  55 - $action: the current action
  56
  57 EndShowStatusNetScripts: End showing StatusNet script links
  58 - $action: the current action
  59
  60 StartShowLaconicaScripts: backwards compatibility; deprecated
  61 - $action: the current action
  62
  63 EndShowLaconicaScripts: backwards compatibility; deprecated
  64 - $action: the current action
  65
  66 StartShowSections: Start the list of sections in the sidebar
  67 - $action: the current action
  68
  69 EndShowSections: End the list of sections in the sidebar
  70 - $action: the current action
  71
  72 StartShowHeader: Showing before the header container
  73 - $action: the current action
  74
  75 EndShowHeader: Showing after the header container
  76 - $action: the current action
  77
  78 StartShowFooter: Showing before the footer container
  79 - $action: the current action
  80
  81 EndShowFooter: Showing after the footer container
  82 - $action: the current action
  83
  84 StartShowContentBlock: Showing before the content container
  85 - $action: the current action
  86
  87 EndShowContentBlock: Showing after the content container
  88 - $action: the current action
  89
  90 StartShowAside: Showing before the Aside container
  91 - $action: the current action
  92
  93 EndShowAside: Showing after the Aside container
  94 - $action: the current action
  95
  96 StartShowNoticeFormData: Showing before the notice form data
  97 - $action: the current action
  98
  99 EndShowNoticeFormData: Showing after the notice form data
 100 - $action: the current action
 101
 102 StartNoticeSave: before inserting a notice (good place for content filters)
 103 - $notice: notice being saved (no ID or URI)
 104
 105 EndNoticeSave: after inserting a notice and related code
 106 - $notice: notice that was saved (with ID and URI)
 107
 108 StartShowLocalNavBlock: Showing the local nav menu
 109 - $action: the current action
 110
 111 EndShowLocalNavBlock: At the end of the local nav menu
 112 - $action: the current action
 113
 114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
 115 - $action: the current action
 116
 117 EndShowHTML: Showing after the html element
 118 - $action: the current action
 119
 120 StartPublicGroupNav: Showing the public group nav menu
 121 - $action: the current action
 122
 123 EndPublicGroupNav: At the end of the public group nav menu
 124 - $action: the current action
 125
 126 StartSubGroupNav: Showing the subscriptions group nav menu
 127 - $action: the current action
 128
 129 EndSubGroupNav: At the end of the subscriptions group nav menu
 130 - $action: the current action
 131
 132 RouterInitialized: After the router instance has been initialized
 133 - $m: the Net_URL_Mapper that has just been set up
 134
 135 StartLogout: Before logging out
 136 - $action: the logout action
 137
 138 EndLogout: After logging out
 139 - $action: the logout action
 140
 141 ArgsInitialized: After the argument array has been initialized
 142 - $args: associative array of arguments, can be modified
 143
 144 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 145 - $action: the current action
 146
 147 EndAddressData: At the end of <address>
 148 - $action: the current action
 149
 150 StartLoginGroupNav: Before showing the login and register navigation menu
 151 - $action: the current action
 152
 153 EndLoginGroupNav: After showing the login and register navigation menu
 154 - $action: the current action
 155
 156 StartAccountSettingsNav: Before showing the account settings menu
 157 - $action: the current action
 158
 159 EndAccountSettingsNav: After showing the account settings menu
 160 - $action: the current action
 161
 162 Autoload: When trying to autoload a class
 163 - $cls: the class being sought. A plugin might require_once the file for the class.
 164
 165 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 166 - $action: name of the action, like 'login'
 167 - $sensitive: flag for whether this is a sensitive action
 168
 169 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 170 - $action: name of the action, like 'register'
 171 - $login: flag for whether this is a login action
 172
 173 StartShowHead: called before showing the <head> element and children
 174 - $action: action object being show
 175
 176 EndShowHead: called after showing the <head> element (and </head>)
 177 - $action: action object being shown
 178
 179 StartShowBody: called before showing the <body> element and children
 180 - $action: action object being shown
 181
 182 EndShowBody: called after showing the <body> element (and </body>)
 183 - $action: action object being shown
 184
 185 StartPersonalGroupNav: beginning of personal group nav menu
 186 - $action: action object being shown
 187
 188 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 189 - $action: action object being shown
 190
 191 StartEndHTML: just before the </html> tag
 192 - $action: action object being shown
 193
 194 EndEndHTML: just after the </html> tag
 195 - $action: action object being shown
 196
 197 StartShowDesign: just before showing a site, user, or group design
 198 - $action: action object being shown
 199
 200 EndShowDesign: just after showing a site, user, or group design
 201 - $action: action object being shown
 202
 203 StartShowExportData: just before showing the <div> with export data (feeds)
 204 - $action: action object being shown
 205
 206 EndShowExportData: just after showing the <div> with export data (feeds)
 207 - $action: action object being shown
 208
 209 StartShowNoticeItem: just before showing the notice item
 210 - $action: action object being shown
 211
 212 EndShowNoticeItem: just after showing the notice item
 213 - $action: action object being shown
 214
 215 StartShowPageNotice: just before showing the page notice (instructions or error)
 216 - $action: action object being shown
 217
 218 EndShowPageNotice: just after showing the page notice (instructions or error)
 219 - $action: action object being shown
 220
 221 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 222 - $action: action object being shown
 223
 224 StartProfileFormData: just before showing text entry fields on profile settings page
 225 - $action: action object being shown
 226
 227 EndProfileFormData: just after showing text entry fields on profile settings page
 228 - $action: action object being shown
 229
 230 StartProfileSaveForm: before starting to save a profile settings form
 231 - $action: action object being shown
 232
 233 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 234 - $action: action object being shown
 235
 236 StartRegistrationFormData: just before showing text entry fields on registration page
 237 - $action: action object being shown
 238
 239 EndRegistrationFormData: just after showing text entry fields on registration page
 240 - $action: action object being shown
 241
 242 StartRegistrationTry: before validating and saving a new user
 243 - $action: action object being shown
 244
 245 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 246 - $action: action object being shown
 247
 248 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 249 - $qm: empty queue manager to set
 250
 251 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 252 - $action: action object being shown
 253 - $user: current user
 254
 255 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 256 - $title: title of the document
 257 - $output: HTML output to show
 258
 259 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 260 - $title: title of the document
 261 - $output: HTML output to show
 262
 263 StartApiRss: after the rss <channel> element is started
 264 - $action: action object being shown
 265
 266 StartApiAtom: after the <feed> element is started
 267 - $action: action object being shown
 268
 269 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 270 - $notice: the notice being added
 271 - &$transports: modifiable list of transports (as strings) to queue for
 272
 273 EndEnqueueNotice: after adding a notice to the queues
 274 - $notice: the notice being added
 275 - $transports: modifiable list of transports to use
 276
 277 UnqueueHandleNotice: Handle a notice when no queue manager is available
 278 - $notice: the notice to handle
 279 - $queue: the "queue" that is being executed
 280
 281 GetValidDaemons: Just before determining which daemons to run
 282 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 283
 284 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 285 - &$notice: notice to handle
 286
 287 StartShowHeadElements: Right after the <head> tag
 288 - $action: the current action
 289
 290 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 291 - $action: the current action
 292
 293 CheckSchema: chance to check the schema
 294
 295 StartProfilePageProfileSection: Starting to show the section of the
 296                               profile page with the actual profile data;
 297                               hook to prevent showing the profile (e.g.)
 298 - $action: the current action
 299 - &$profile: the profile being shown
 300
 301 StartProfilePageProfileElements: inside the section, before the first
 302                                element; prepend elements here
 303 - $action: the current action
 304 - &$profile: the profile being shown
 305
 306 EndProfilePageProfileElements: inside the section, after the last element;
 307                              append elements here
 308 - $action: the current action
 309 - &$profile: the profile being shown
 310
 311 EndProfilePageProfileSection: After showing the section of the profile
 312                             page with the profile elements
 313 - $action: the current action
 314 - &$profile: the profile being shown
 315
 316 StartProfilePageActionsSection: Starting to show the section of the
 317                                     profile page with action links; hook
 318                                     to hide them (for example)
 319 - $action: the current action
 320 - &$profile: the profile being shown
 321
 322 StartProfilePageActionsElements: inside the list, before the first
 323                                      element; prepend elements here
 324 - $action: the current action
 325 - &$profile: the profile being shown
 326
 327 EndProfilePageActionsElements: inside the list, after the last element;
 328                                    append elements here
 329 - $action: the current action
 330 - &$profile: the profile being shown
 331
 332 EndProfilePageActionsSection: After showing the section of the profile
 333                                   page with the entity actions
 334 - $action: the current action
 335 - &$profile: the profile being shown
 336
 337 StartProfilePageAvatar: before showing the avatar on the profile page
 338 - $action: the current action
 339 - &$profile: the profile being shown
 340
 341 EndProfilePageAvatar: after showing the avatar on the profile page
 342 - $action: the current action
 343 - &$profile: the profile being shown
 344
 345 StartProfilePageNickname: before showing the nickname on the profile page
 346 - $action: the current action
 347 - &$profile: the profile being shown
 348
 349 EndProfilePageNickname: after showing the nickname on the profile page
 350 - $action: the current action
 351 - &$profile: the profile being shown
 352
 353 StartProfilePageFullName: before showing the fullname on the profile page
 354 - $action: the current action
 355 - &$profile: the profile being shown
 356
 357 EndProfilePageFullName: after showing the fullname on the profile page
 358 - $action: the current action
 359 - &$profile: the profile being shown
 360
 361 StartProfilePageLocation: before showing the location on the profile page
 362 - $action: the current action
 363 - &$profile: the profile being shown
 364
 365 EndProfilePageLocation: after showing the location on the profile page
 366 - $action: the current action
 367 - &$profile: the profile being shown
 368
 369 StartProfilePageHomepage: before showing the homepage link on the profile page
 370 - $action: the current action
 371 - &$profile: the profile being shown
 372
 373 EndProfilePageHomepage: after showing the homepage on the profile page
 374 - $action: the current action
 375 - &$profile: the profile being shown
 376
 377 StartProfilePageBio: before showing the bio on the profile page
 378 - $action: the current action
 379 - &$profile: the profile being shown
 380
 381 EndProfilePageBio: after showing the bio on the profile page
 382 - $action: the current action
 383 - &$profile: the profile being shown
 384
 385 StartProfilePageProfileTags: before showing the tags on the profile page
 386 - $action: the current action
 387 - &$profile: the profile being shown
 388
 389 EndProfilePageProfileTags: after showing the tags on the profile page
 390 - $action: the current action
 391 - &$profile: the profile being shown
 392
 393 StartProfileList: when starting a list of profiles (before <ul>)
 394 - $profilelist: ProfileList widget, with $profile, $action, and $out
 395
 396 EndProfileList: when ending a list of profiles (after </ul>)
 397 - $profilelist: ProfileList widget
 398
 399 StartProfileListItem: when starting to show a profile list item
 400 - $item: ProfileListItem widget
 401
 402 EndProfileListItem: after showing a profile list item
 403 - $item: ProfileListItem widget
 404
 405 StartProfileListItemProfile: the profile data part of the item
 406 - $item: ProfileListItem widget
 407
 408 EndProfileListItemProfile: the profile data part of the item
 409 - $item: ProfileListItem widget
 410
 411 StartProfileListItemActions: the actions (buttons) for an item
 412 - $item: ProfileListItem widget
 413
 414 EndProfileListItemActions: the actions (buttons) for an item
 415 - $item: ProfileListItem widget
 416
 417 StartProfileListItemProfileElements: inside the <div>
 418 - $item: ProfileListItem widget
 419
 420 EndProfileListItemProfileElements: inside the <div>
 421 - $item: ProfileListItem widget
 422
 423 StartProfileListItemAvatar: Showing a profile list avatar
 424 - $item: ProfileListItem widget
 425
 426 EndProfileListItemAvatar: Showing a profile list avatar
 427 - $item: ProfileListItem widget
 428
 429 StartProfileListItemFullName: Showing the profile list full name
 430 - $item: ProfileListItem widget
 431
 432 EndProfileListItemFullName: Showing the profile list full name
 433 - $item: ProfileListItem widget
 434
 435 StartProfileListItemLocation: Showing the profile list location
 436 - $item: ProfileListItem widget
 437
 438 EndProfileListItemLocation: Showing the profile list location
 439 - $item: ProfileListItem widget
 440
 441 StartProfileListItemHomepage: Showing the profile list homepage
 442 - $item: ProfileListItem widget
 443
 444 EndProfileListItemHomepage: Showing the profile list homepage
 445 - $item: ProfileListItem widget
 446
 447 StartProfileListItemBio: Showing the profile list bio
 448 - $item: ProfileListItem widget
 449
 450 EndProfileListItemBio: Showing the profile list bio
 451 - $item: ProfileListItem widget
 452
 453 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 454 - $item: ProfileListItem widget
 455
 456 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 457 - $item: ProfileListItem widget