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 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
 133 - $m: the Net_URL_Mapper that has just been set up
 134
 135 RouterInitialized: After the router instance has been initialized
 136 - $m: the Net_URL_Mapper that has just been set up
 137
 138 StartLogout: Before logging out
 139 - $action: the logout action
 140
 141 EndLogout: After logging out
 142 - $action: the logout action
 143
 144 ArgsInitialized: After the argument array has been initialized
 145 - $args: associative array of arguments, can be modified
 146
 147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 148 - $action: the current action
 149
 150 EndAddressData: At the end of <address>
 151 - $action: the current action
 152
 153 StartLoginGroupNav: Before showing the login and register navigation menu
 154 - $action: the current action
 155
 156 EndLoginGroupNav: After showing the login and register navigation menu
 157 - $action: the current action
 158
 159 StartAccountSettingsNav: Before showing the account settings menu
 160 - $action: the current action
 161
 162 EndAccountSettingsNav: After showing the account settings menu
 163 - $action: the current action
 164
 165 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
 166 - $widget: AccountSettingsNav instance being shown
 167
 168 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
 169 - $widget: AccountSettingsNav instance being shown
 170
 171 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
 172 - $widget: AccountSettingsNav instance being shown
 173
 174 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
 175 - $widget: AccountSettingsNav instance being shown
 176
 177 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
 178 - $widget: AccountSettingsNav instance being shown
 179
 180 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
 181 - $widget: AccountSettingsNav instance being shown
 182
 183 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
 184 - $widget: AccountSettingsNav instance being shown
 185
 186 EndAccountSettingsEmailMenuItem: After showing the Email menu item
 187 - $widget: AccountSettingsNav instance being shown
 188
 189 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
 190 - $widget: AccountSettingsNav instance being shown
 191
 192 EndAccountSettingsDesignMenuItem: After showing the Design menu item
 193 - $widget: AccountSettingsNav instance being shown
 194
 195 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
 196 - $widget: AccountSettingsNav instance being shown
 197
 198 EndAccountSettingsOtherMenuItem: After showing the Other menu item
 199 - $widget: AccountSettingsNav instance being shown
 200
 201 Autoload: When trying to autoload a class
 202 - $cls: the class being sought. A plugin might require_once the file for the class.
 203
 204 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 205 - $action: name of the action, like 'login'
 206 - $sensitive: flag for whether this is a sensitive action
 207
 208 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 209 - $action: name of the action, like 'register'
 210 - $login: flag for whether this is a login action
 211
 212 StartShowHead: called before showing the <head> element and children
 213 - $action: action object being show
 214
 215 EndShowHead: called after showing the <head> element (and </head>)
 216 - $action: action object being shown
 217
 218 StartShowBody: called before showing the <body> element and children
 219 - $action: action object being shown
 220
 221 EndShowBody: called after showing the <body> element (and </body>)
 222 - $action: action object being shown
 223
 224 StartPersonalGroupNav: beginning of personal group nav menu
 225 - $action: action object being shown
 226
 227 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 228 - $action: action object being shown
 229
 230 StartGroupGroupNav: Showing the group nav menu
 231 - $action: the current action
 232
 233 EndGroupGroupNav: At the end of the group nav menu
 234 - $action: the current action
 235
 236 StartEndHTML: just before the </html> tag
 237 - $action: action object being shown
 238
 239 EndEndHTML: just after the </html> tag
 240 - $action: action object being shown
 241
 242 StartShowDesign: just before showing a site, user, or group design
 243 - $action: action object being shown
 244
 245 EndShowDesign: just after showing a site, user, or group design
 246 - $action: action object being shown
 247
 248 StartShowExportData: just before showing the <div> with export data (feeds)
 249 - $action: action object being shown
 250
 251 EndShowExportData: just after showing the <div> with export data (feeds)
 252 - $action: action object being shown
 253
 254 StartShowNoticeItem: just before showing the notice item
 255 - $action: action object being shown
 256
 257 EndShowNoticeItem: just after showing the notice item
 258 - $action: action object being shown
 259
 260 StartShowPageNotice: just before showing the page notice (instructions or error)
 261 - $action: action object being shown
 262
 263 EndShowPageNotice: just after showing the page notice (instructions or error)
 264 - $action: action object being shown
 265
 266 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 267 - $action: action object being shown
 268
 269 StartProfileFormData: just before showing text entry fields on profile settings page
 270 - $action: action object being shown
 271
 272 EndProfileFormData: just after showing text entry fields on profile settings page
 273 - $action: action object being shown
 274
 275 StartProfileSaveForm: before starting to save a profile settings form
 276 - $action: action object being shown
 277
 278 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 279 - $action: action object being shown
 280
 281 StartRegistrationFormData: just before showing text entry fields on registration page
 282 - $action: action object being shown
 283
 284 EndRegistrationFormData: just after showing text entry fields on registration page
 285 - $action: action object being shown
 286
 287 StartRegistrationTry: before validating and saving a new user
 288 - $action: action object being shown
 289
 290 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 291 - $action: action object being shown
 292
 293 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 294 - $qm: empty queue manager to set
 295
 296 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 297 - $action: action object being shown
 298 - $user: current user
 299
 300 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 301 - $title: title of the document
 302 - $output: HTML output to show
 303
 304 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 305 - $title: title of the document
 306 - $output: HTML output to show
 307
 308 StartApiRss: after the rss <channel> element is started
 309 - $action: action object being shown
 310
 311 StartApiAtom: after the <feed> element is started
 312 - $action: action object being shown
 313
 314 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 315 - $notice: the notice being added
 316 - &$transports: modifiable list of transports (as strings) to queue for
 317
 318 EndEnqueueNotice: after adding a notice to the queues
 319 - $notice: the notice being added
 320 - $transports: modifiable list of transports to use
 321
 322 UnqueueHandleNotice: Handle a notice when no queue manager is available
 323 - $notice: the notice to handle
 324 - $queue: the "queue" that is being executed
 325
 326 GetValidDaemons: Just before determining which daemons to run
 327 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 328
 329 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 330 - &$notice: notice to handle
 331
 332 StartShowHeadElements: Right after the <head> tag
 333 - $action: the current action
 334
 335 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 336 - $action: the current action
 337
 338 CheckSchema: chance to check the schema
 339
 340 StartProfilePageProfileSection: Starting to show the section of the
 341                               profile page with the actual profile data;
 342                               hook to prevent showing the profile (e.g.)
 343 - $userprofile: UserProfile widget
 344 - &$profile: the profile being shown
 345
 346 StartProfilePageProfileElements: inside the section, before the first
 347                                element; prepend elements here
 348 - $userprofile: UserProfile widget
 349 - &$profile: the profile being shown
 350
 351 EndProfilePageProfileElements: inside the section, after the last element;
 352                              append elements here
 353 - $userprofile: UserProfile widget
 354 - &$profile: the profile being shown
 355
 356 EndProfilePageProfileSection: After showing the section of the profile
 357                             page with the profile elements
 358 - $userprofile: UserProfile widget
 359 - &$profile: the profile being shown
 360
 361 StartProfilePageActionsSection: Starting to show the section of the
 362                                     profile page with action links; hook
 363                                     to hide them (for example)
 364 - $userprofile: UserProfile widget
 365 - &$profile: the profile being shown
 366
 367 StartProfilePageActionsElements: inside the list, before the first
 368                                      element; prepend elements here
 369 - $userprofile: UserProfile widget
 370 - &$profile: the profile being shown
 371
 372 EndProfilePageActionsElements: inside the list, after the last element;
 373                                    append elements here
 374 - $userprofile: UserProfile widget
 375 - &$profile: the profile being shown
 376
 377 EndProfilePageActionsSection: After showing the section of the profile
 378                                   page with the entity actions
 379 - $userprofile: UserProfile widget
 380 - &$profile: the profile being shown
 381
 382 StartProfilePageAvatar: before showing the avatar on the profile page
 383 - $userprofile: UserProfile widget
 384 - &$profile: the profile being shown
 385
 386 EndProfilePageAvatar: after showing the avatar on the profile page
 387 - $userprofile: UserProfile widget
 388 - &$profile: the profile being shown
 389
 390 StartProfilePageNickname: before showing the nickname on the profile page
 391 - $userprofile: UserProfile widget
 392 - &$profile: the profile being shown
 393
 394 EndProfilePageNickname: after showing the nickname on the profile page
 395 - $userprofile: UserProfile widget
 396 - &$profile: the profile being shown
 397
 398 StartProfilePageFullName: before showing the fullname on the profile page
 399 - $userprofile: UserProfile widget
 400 - &$profile: the profile being shown
 401
 402 EndProfilePageFullName: after showing the fullname on the profile page
 403 - $userprofile: UserProfile widget
 404 - &$profile: the profile being shown
 405
 406 StartProfilePageLocation: before showing the location on the profile page
 407 - $userprofile: UserProfile widget
 408 - &$profile: the profile being shown
 409
 410 EndProfilePageLocation: after showing the location on the profile page
 411 - $userprofile: UserProfile widget
 412 - &$profile: the profile being shown
 413
 414 StartProfilePageHomepage: before showing the homepage link on the profile page
 415 - $userprofile: UserProfile widget
 416 - &$profile: the profile being shown
 417
 418 EndProfilePageHomepage: after showing the homepage on the profile page
 419 - $userprofile: UserProfile widget
 420 - &$profile: the profile being shown
 421
 422 StartProfilePageBio: before showing the bio on the profile page
 423 - $userprofile: UserProfile widget
 424 - &$profile: the profile being shown
 425
 426 EndProfilePageBio: after showing the bio on the profile page
 427 - $userprofile: UserProfile widget
 428 - &$profile: the profile being shown
 429
 430 StartProfilePageProfileTags: before showing the tags on the profile page
 431 - $userprofile: UserProfile widget
 432 - &$profile: the profile being shown
 433
 434 EndProfilePageProfileTags: after showing the tags on the profile page
 435 - $userprofile: UserProfile widget
 436 - &$profile: the profile being shown
 437
 438 StartProfileList: when starting a list of profiles (before <ul>)
 439 - $profilelist: ProfileList widget, with $profile, $action, and $out
 440
 441 EndProfileList: when ending a list of profiles (after </ul>)
 442 - $profilelist: ProfileList widget
 443
 444 StartProfileListItem: when starting to show a profile list item
 445 - $item: ProfileListItem widget
 446
 447 EndProfileListItem: after showing a profile list item
 448 - $item: ProfileListItem widget
 449
 450 StartProfileListItemProfile: the profile data part of the item
 451 - $item: ProfileListItem widget
 452
 453 EndProfileListItemProfile: the profile data part of the item
 454 - $item: ProfileListItem widget
 455
 456 StartProfileListItemActions: the actions (buttons) for an item
 457 - $item: ProfileListItem widget
 458
 459 EndProfileListItemActions: the actions (buttons) for an item
 460 - $item: ProfileListItem widget
 461
 462 StartProfileListItemProfileElements: inside the <div>
 463 - $item: ProfileListItem widget
 464
 465 EndProfileListItemProfileElements: inside the <div>
 466 - $item: ProfileListItem widget
 467
 468 StartProfileListItemAvatar: Showing a profile list avatar
 469 - $item: ProfileListItem widget
 470
 471 EndProfileListItemAvatar: Showing a profile list avatar
 472 - $item: ProfileListItem widget
 473
 474 StartProfileListItemFullName: Showing the profile list full name
 475 - $item: ProfileListItem widget
 476
 477 EndProfileListItemFullName: Showing the profile list full name
 478 - $item: ProfileListItem widget
 479
 480 StartProfileListItemLocation: Showing the profile list location
 481 - $item: ProfileListItem widget
 482
 483 EndProfileListItemLocation: Showing the profile list location
 484 - $item: ProfileListItem widget
 485
 486 StartProfileListItemHomepage: Showing the profile list homepage
 487 - $item: ProfileListItem widget
 488
 489 EndProfileListItemHomepage: Showing the profile list homepage
 490 - $item: ProfileListItem widget
 491
 492 StartProfileListItemBio: Showing the profile list bio
 493 - $item: ProfileListItem widget
 494
 495 EndProfileListItemBio: Showing the profile list bio
 496 - $item: ProfileListItem widget
 497
 498 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 499 - $item: ProfileListItem widget
 500
 501 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 502 - $item: ProfileListItem widget
 503
 504 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 505 - $action: the current action
 506 - &$xrdsoutputter - XRDSOutputter object to write to
 507
 508 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 509 - $action: the current action
 510 - &$xrdsoutputter - XRDSOutputter object to write to
 511
 512 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 513 - $action: the current action
 514 - &$xrdsoutputter - XRDSOutputter object to write to
 515
 516 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 517 - $action: the current action
 518 - &$xrdsoutputter - XRDSOutputter object to write to
 519
 520 StartCheckPassword: Check a username/password
 521 - $nickname: The nickname to check
 522 - $password: The password to check
 523 - &$authenticatedUser: set to User object if credentials match a user.
 524
 525 EndCheckPassword: After checking a username/password pair
 526 - $nickname: The nickname that was checked
 527 - $password: The password that was checked
 528 - $authenticatedUser: User object if credentials match a user, else null.
 529
 530 StartChangePassword: Before changing a password
 531 - $nickname: user's nickname
 532 - $oldpassword: the user's old password
 533 - $newpassword: the desired new password
 534
 535 EndChangePassword: After changing a password
 536 - $nickname: user's nickname
 537
 538 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 539 - $user: User object
 540 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
 541
 542 GetUrlShorteners: Specify URL shorteners that are available for use
 543 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
 544
 545 StartShortenUrl: About to shorten a URL
 546 - $url: url to be shortened
 547 - $shortenerName: name of the requested shortener
 548 - &$shortenedUrl: short version of the url
 549
 550 EndShortenUrl: After a URL has been shortened
 551 - $url: url to be shortened
 552 - $shortenerName: name of the requested shortener
 553 - $shortenedUrl: short version of the url
 554