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 StartActionExecute: Right before the "prepare" call of the current Action
   6 - $action:  the current Action object
   7 - &$args:   array of arguments, referenced so you can modify the array
   8
   9 EndActionExecute:   Right after the "handle" call of the current Action
  10 - $action:      the current Action object
  11
  12 StartPrimaryNav: Showing the primary nav menu
  13 - $action: the current action
  14
  15 EndPrimaryNav: At the end of the primary nav menu
  16 - $action: the current action
  17
  18 StartSecondaryNav: Showing the secondary nav menu
  19 - $action: the current action
  20
  21 EndSecondaryNav: At the end of the secondary nav menu
  22 - $action: the current action
  23
  24 StartShowStyles: Showing Style links; good place to add UA style resets
  25 - $action: the current action
  26
  27 EndShowStyles: End showing Style links; good place to add custom styles
  28 - $action: the current action
  29
  30 StartShowStylesheets: Showing stylesheet links
  31 - $action: the current action
  32
  33 EndShowStylesheets: End showing stylesheet links;  good place to add handheld or JavaScript dependant styles
  34 - $action: the current action
  35
  36 StartShowUAStyles: Showing custom User-Agent style links
  37 - $action: the current action
  38
  39 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  40 - $action: the current action
  41
  42 StartShowScripts: Showing JavaScript links
  43 - $action: the current action
  44
  45 EndShowScripts: End showing JavaScript links; good place to add custom
  46                 links like Google Analytics
  47 - $action: the current action
  48
  49 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  50 - $action: the current action
  51
  52 EndShowJQueryScripts: End showing JQuery script links
  53 - $action: the current action
  54
  55 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  56 - $action: the current action
  57
  58 EndShowStatusNetScripts: End showing StatusNet script links
  59 - $action: the current action
  60
  61 StartShowSections: Start the list of sections in the sidebar
  62 - $action: the current action
  63
  64 EndShowSections: End the list of sections in the sidebar
  65 - $action: the current action
  66
  67 StartShowHeader: Showing before the header container
  68 - $action: the current action
  69
  70 EndShowHeader: Showing after the header container
  71 - $action: the current action
  72
  73 StartShowFooter: Showing before the footer container
  74 - $action: the current action
  75
  76 EndShowFooter: Showing after the footer container
  77 - $action: the current action
  78
  79 StartShowContentBlock: Showing before the content container
  80 - $action: the current action
  81
  82 EndShowContentBlock: Showing after the content container
  83 - $action: the current action
  84
  85 StartShowAside: Showing before the Aside container
  86 - $action: the current action
  87
  88 EndShowAside: Showing after the Aside container
  89 - $action: the current action
  90
  91 StartShowNoticeFormData: Showing before the notice form data
  92 - $action: the current action
  93
  94 EndShowNoticeFormData: Showing after the notice form data
  95 - $action: the current action
  96
  97 StartNoticeSave: before inserting a notice (good place for content filters)
  98 - $notice: notice being saved (no ID or URI)
  99
 100 EndNoticeSave: after inserting a notice and related code
 101 - $notice: notice that was saved (with ID and URI)
 102
 103 StartShowLocalNavBlock: Showing the local nav menu
 104 - $action: the current action
 105
 106 EndShowLocalNavBlock: At the end of the local nav menu
 107 - $action: the current action
 108
 109 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
 110 - $action: the current action
 111
 112 EndShowHTML: Showing after the html element
 113 - $action: the current action
 114
 115 StartPublicGroupNav: Showing the public group nav menu
 116 - $menu: the menu widget; use $menu->action for output
 117
 118 EndPublicGroupNav: At the end of the public group nav menu
 119 - $menu: the menu widget; use $menu->action for output
 120
 121 StartSubGroupNav: Showing the subscriptions group nav menu
 122 - $menu: the menu widget; use $menu->action for output
 123
 124 EndSubGroupNav: At the end of the subscriptions group nav menu
 125 - $menu: the menu widget; use $menu->action for output
 126
 127 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
 128 - $m: the Net_URL_Mapper that has just been set up
 129
 130 RouterInitialized: After the router instance has been initialized
 131 - $m: the Net_URL_Mapper that has just been set up
 132
 133 StartLogout: Before logging out
 134 - $action: the logout action
 135
 136 EndLogout: After logging out
 137 - $action: the logout action
 138
 139 ArgsInitialize: After the argument array has been initialized
 140 - $args: associative array of arguments, can be modified
 141
 142 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 143 - $action: the current action
 144
 145 EndAddressData: At the end of <address>
 146 - $action: the current action
 147
 148 StartShowSiteNotice: Before showing site notice
 149 - $action: the current action
 150
 151 EndShowSiteNotice: After showing site notice
 152 - $action: the current action
 153
 154 StartLoginGroupNav: Before showing the login and register navigation menu
 155 - $action: the current action
 156
 157 EndLoginGroupNav: After showing the login and register navigation menu
 158 - $action: the current action
 159
 160 StartAccountSettingsNav: Before showing the account settings menu
 161 - $action: the current action
 162
 163 EndAccountSettingsNav: After showing the account settings menu
 164 - $action: the current action
 165
 166 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
 167 - $widget: AccountSettingsNav instance being shown
 168
 169 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
 170 - $widget: AccountSettingsNav instance being shown
 171
 172 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
 173 - $widget: AccountSettingsNav instance being shown
 174
 175 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
 176 - $widget: AccountSettingsNav instance being shown
 177
 178 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
 179 - $widget: AccountSettingsNav instance being shown
 180
 181 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
 182 - $widget: AccountSettingsNav instance being shown
 183
 184 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
 185 - $widget: AccountSettingsNav instance being shown
 186
 187 EndAccountSettingsEmailMenuItem: After showing the Email menu item
 188 - $widget: AccountSettingsNav instance being shown
 189
 190 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
 191 - $widget: AccountSettingsNav instance being shown
 192
 193 EndAccountSettingsDesignMenuItem: After showing the Design menu item
 194 - $widget: AccountSettingsNav instance being shown
 195
 196 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
 197 - $widget: AccountSettingsNav instance being shown
 198
 199 EndAccountSettingsOtherMenuItem: After showing the Other menu item
 200 - $widget: AccountSettingsNav instance being shown
 201
 202 Autoload: When trying to autoload a class
 203 - $cls: the class being sought. A plugin might require_once the file for the class.
 204
 205 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 206 - $action: name of the action, like 'login'
 207 - $sensitive: flag for whether this is a sensitive action
 208
 209 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 210 - $action: name of the action, like 'register'
 211 - $login: flag for whether this is a login action
 212
 213 StartShowHead: called before showing the <head> element and children
 214 - $action: action object being show
 215
 216 EndShowHead: called after showing the <head> element (and </head>)
 217 - $action: action object being shown
 218
 219 StartShowBody: called before showing the <body> element and children
 220 - $action: action object being shown
 221
 222 EndShowBody: called after showing the <body> element (and </body>)
 223 - $action: action object being shown
 224
 225 StartPersonalGroupNav: beginning of personal group nav menu
 226 - $menu: Menu list object being shown
 227 - $target: Profile for whom it is shown
 228 - $scoped: Profile of currently logged in user (or null)
 229
 230 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 231 - $action: action object being shown
 232
 233 StartGroupGroupNav: Showing the group nav menu
 234 - $action: the current action
 235
 236 EndGroupGroupNav: At the end of the group nav menu
 237 - $action: the current action
 238
 239 StartEndHTML: just before the </html> tag
 240 - $action: action object being shown
 241
 242 EndEndHTML: just after the </html> tag
 243 - $action: action object being shown
 244
 245 FinalAction: After prepare() (and possible handle) in Action class.
 246 - $status: result of "prepare" call on action
 247 - $action: Action that is currently running
 248
 249 StartShowDesign: just before showing a site, user, or group design
 250 - $action: action object being shown
 251
 252 EndShowDesign: just after showing a site, user, or group design
 253 - $action: action object being shown
 254
 255 StartShowExportData: just before showing the <div> with export data (feeds)
 256 - $action: action object being shown
 257
 258 EndShowExportData: just after showing the <div> with export data (feeds)
 259 - $action: action object being shown
 260
 261 StartShowNoticeItem: just before showing the notice item
 262 - $item: The NoticeListItem object being shown
 263
 264 EndShowNoticeItem: just after showing the notice item
 265 - $item: the NoticeListItem object being shown
 266
 267 StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML
 268 - $item: The NoticeListItem object being shown
 269
 270 EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML
 271 - $item: The NoticeListItem object being shown
 272
 273 StartShowNoticeContent: just before outputting the content part of a Notice
 274 - $stored: The Notice object
 275 - $out: HTMLOutputter for writing to
 276 - $scoped: optional Profile object for permission scoping
 277
 278 EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually
 279 - $stored: The Notice object
 280 - $out: HTMLOutputter for writing to
 281 - $scoped: optional Profile object for permission scoping
 282
 283 StartShowNoticeInfo: just before showing notice info
 284 - $item: The NoticeListItem object being shown
 285
 286 EndShowNoticeInfo: just after showing notice info
 287 - $item: The NoticeListItem object being shown
 288
 289 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
 290 - $item: the NoticeListItem object being shown
 291
 292 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
 293 - $item: the NoticeListItem object being shown
 294
 295 StartShowPageNotice: just before showing the page notice (instructions or error)
 296 - $action: action object being shown
 297
 298 EndShowPageNotice: just after showing the page notice (instructions or error)
 299 - $action: action object being shown
 300
 301 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 302 - $action: action object being shown
 303
 304 StartProfileFormData: just before showing text entry fields on profile settings page
 305 - $action: action object being shown
 306
 307 EndProfileFormData: just after showing text entry fields on profile settings page
 308 - $action: action object being shown
 309
 310 StartProfileSaveForm: before starting to save a profile settings form
 311 - $action: action object being shown
 312
 313 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 314 - $action: action object being shown
 315
 316 StartEmailFormData: just before showing form input fields on email settings page
 317 - $action: Action object being shown
 318 - $scoped: Profile for whom settings are being configured
 319
 320 EndEmailFormData: just after showing form input fields on email settings page
 321 - $action: action object being shown
 322 - $scoped: Profile for whom settings are being configured
 323
 324 StartEmailSaveForm: before starting to save a email settings form
 325 - $action: action object being shown
 326 - $scoped: Profile user having their email settings saved
 327
 328 EndEmailSaveForm: after saving a email settings form (after commit)
 329 - $action: action object being shown
 330 - $scoped: Profile user having their email settings saved
 331
 332 StartRegistrationFormData: just before showing text entry fields on registration page
 333 - $action: action object being shown
 334
 335 EndRegistrationFormData: just after showing text entry fields on registration page
 336 - $action: action object being shown
 337
 338 StartRegistrationTry: before validating and saving a new user
 339 - $action: action object being shown
 340
 341 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 342 - $action: action object being shown
 343
 344 StartAvatarFormData: before displaying avatar form
 345 - $action: action object being shown
 346
 347 EndAvatarFormData: after displaying avatar form
 348 - $action: action object being shown
 349
 350 StartAvatarSaveForm: before saving the avatar
 351 - $action: action object being shown
 352
 353 EndAvatarSaveForm: after saving the avatar
 354 - $action: action object being shown
 355
 356 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 357 - $qm: empty queue manager to set
 358
 359 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 360 - $action: action object being shown
 361 - $user: current user
 362
 363 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 364 - $title: title of the document
 365 - $output: HTML output to show
 366
 367 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 368 - $title: title of the document
 369 - $output: HTML output to show
 370
 371 StartApiRss: after the rss <channel> element is started
 372 - $action: action object being shown
 373
 374 StartApiAtom: after the <feed> element is started
 375 - $action: action object being shown
 376
 377 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 378 - $notice: the notice being added
 379 - &$transports: modifiable list of transports (as strings) to queue for
 380
 381 EndEnqueueNotice: after adding a notice to the queues
 382 - $notice: the notice being added
 383 - $transports: modifiable list of transports to use
 384
 385 UnqueueHandleNotice: Handle a notice when no queue manager is available
 386 - $notice: the notice to handle
 387 - $queue: the "queue" that is being executed
 388
 389 GetValidDaemons: Just before determining which daemons to run
 390 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 391
 392 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 393 - &$notice: notice to handle
 394
 395 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
 396 - $action: the current action
 397 - &$attrs: attributes for the HTML element
 398
 399 EndHtmlElement: Right after outputting the HTML element
 400 - $action: the current action
 401 - &$attrs: attributes for the HTML element
 402
 403 StartShowHeadElements: Right after the <head> tag
 404 - $action: the current action
 405
 406 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 407 - $action: the current action
 408
 409 CheckSchema: chance to check the schema
 410
 411 StartProfileRemoteSubscribe: Before showing the link to remote subscription
 412 - $userprofile: UserProfile widget
 413 - &$profile: the profile being shown
 414
 415 EndProfileRemoteSubscribe: After showing the link to remote subscription
 416 - $userprofile: UserProfile widget
 417 - &$profile: the profile being shown
 418
 419 StartGroupSubscribe: Before showing the link to remote subscription
 420 - $action: the current action
 421 - $group: the group being shown
 422
 423 EndGroupSubscribe: After showing the link to remote subscription
 424 - $action: the current action
 425 - $group: the group being shown
 426
 427 StartProfilePageProfileSection: Starting to show the section of the
 428                               profile page with the actual profile data;
 429                               hook to prevent showing the profile (e.g.)
 430 - $userprofile: UserProfile widget
 431 - &$profile: the profile being shown
 432
 433 StartProfilePageProfileElements: inside the section, before the first
 434                                element; prepend elements here
 435 - $userprofile: UserProfile widget
 436 - &$profile: the profile being shown
 437
 438 EndProfilePageProfileElements: inside the section, after the last element;
 439                              append elements here
 440 - $userprofile: UserProfile widget
 441 - &$profile: the profile being shown
 442
 443 EndProfilePageProfileSection: After showing the section of the profile
 444                             page with the profile elements
 445 - $userprofile: UserProfile widget
 446 - &$profile: the profile being shown
 447
 448 StartProfilePageActionsSection: Starting to show the section of the
 449                                     profile page with action links; hook
 450                                     to hide them (for example)
 451 - $userprofile: UserProfile widget
 452 - &$profile: the profile being shown
 453
 454 StartProfilePageActionsElements: inside the list, before the first
 455                                      element; prepend elements here
 456 - $userprofile: UserProfile widget
 457 - &$profile: the profile being shown
 458
 459 EndProfilePageActionsElements: inside the list, after the last element;
 460                                    append elements here
 461 - $userprofile: UserProfile widget
 462 - &$profile: the profile being shown
 463
 464 EndProfilePageActionsSection: After showing the section of the profile
 465                                   page with the entity actions
 466 - $userprofile: UserProfile widget
 467 - &$profile: the profile being shown
 468
 469 StartProfilePageAvatar: before showing the avatar on the profile page
 470 - $userprofile: UserProfile widget
 471 - &$profile: the profile being shown
 472
 473 EndProfilePageAvatar: after showing the avatar on the profile page
 474 - $userprofile: UserProfile widget
 475 - &$profile: the profile being shown
 476
 477 StartProfilePageNickname: before showing the nickname on the profile page
 478 - $userprofile: UserProfile widget
 479 - &$profile: the profile being shown
 480
 481 EndProfilePageNickname: after showing the nickname on the profile page
 482 - $userprofile: UserProfile widget
 483 - &$profile: the profile being shown
 484
 485 StartProfilePageFullName: before showing the fullname on the profile page
 486 - $userprofile: UserProfile widget
 487 - &$profile: the profile being shown
 488
 489 EndProfilePageFullName: after showing the fullname on the profile page
 490 - $userprofile: UserProfile widget
 491 - &$profile: the profile being shown
 492
 493 StartProfilePageLocation: before showing the location on the profile page
 494 - $userprofile: UserProfile widget
 495 - &$profile: the profile being shown
 496
 497 EndProfilePageLocation: after showing the location on the profile page
 498 - $userprofile: UserProfile widget
 499 - &$profile: the profile being shown
 500
 501 StartProfilePageHomepage: before showing the homepage link on the profile page
 502 - $userprofile: UserProfile widget
 503 - &$profile: the profile being shown
 504
 505 EndProfilePageHomepage: after showing the homepage on the profile page
 506 - $userprofile: UserProfile widget
 507 - &$profile: the profile being shown
 508
 509 StartProfilePageBio: before showing the bio on the profile page
 510 - $userprofile: UserProfile widget
 511 - &$profile: the profile being shown
 512
 513 EndProfilePageBio: after showing the bio on the profile page
 514 - $userprofile: UserProfile widget
 515 - &$profile: the profile being shown
 516
 517 StartProfilePageProfileTags: before showing the tags on the profile page
 518 - $userprofile: UserProfile widget
 519 - &$profile: the profile being shown
 520
 521 EndProfilePageProfileTags: after showing the tags on the profile page
 522 - $userprofile: UserProfile widget
 523 - &$profile: the profile being shown
 524
 525 StartProfileList: when starting a list of profiles (before <ul>)
 526 - $profilelist: ProfileList widget, with $profile, $action, and $out
 527
 528 EndProfileList: when ending a list of profiles (after </ul>)
 529 - $profilelist: ProfileList widget
 530
 531 StartProfileListItem: when starting to show a profile list item
 532 - $item: ProfileListItem widget
 533
 534 EndProfileListItem: after showing a profile list item
 535 - $item: ProfileListItem widget
 536
 537 StartProfileListItemProfile: the profile data part of the item
 538 - $item: ProfileListItem widget
 539
 540 EndProfileListItemProfile: the profile data part of the item
 541 - $item: ProfileListItem widget
 542
 543 StartProfileListItemActions: the actions (buttons) for an item
 544 - $item: ProfileListItem widget
 545
 546 EndProfileListItemActions: the actions (buttons) for an item
 547 - $item: ProfileListItem widget
 548
 549 StartProfileListItemProfileElements: inside the <div>
 550 - $item: ProfileListItem widget
 551
 552 EndProfileListItemProfileElements: inside the <div>
 553 - $item: ProfileListItem widget
 554
 555 StartProfileListItemAvatar: Showing a profile list avatar
 556 - $item: ProfileListItem widget
 557
 558 EndProfileListItemAvatar: Showing a profile list avatar
 559 - $item: ProfileListItem widget
 560
 561 StartProfileListItemFullName: Showing the profile list full name
 562 - $item: ProfileListItem widget
 563
 564 EndProfileListItemFullName: Showing the profile list full name
 565 - $item: ProfileListItem widget
 566
 567 StartProfileListItemLocation: Showing the profile list location
 568 - $item: ProfileListItem widget
 569
 570 EndProfileListItemLocation: Showing the profile list location
 571 - $item: ProfileListItem widget
 572
 573 StartProfileListItemHomepage: Showing the profile list homepage
 574 - $item: ProfileListItem widget
 575
 576 EndProfileListItemHomepage: Showing the profile list homepage
 577 - $item: ProfileListItem widget
 578
 579 StartProfileListItemBio: Showing the profile list bio
 580 - $item: ProfileListItem widget
 581
 582 EndProfileListItemBio: Showing the profile list bio
 583 - $item: ProfileListItem widget
 584
 585 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 586 - $item: ProfileListItem widget
 587
 588 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 589 - $item: ProfileListItem widget
 590
 591 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 592 - $action: the current action
 593 - &$xrdsoutputter - XRDSOutputter object to write to
 594
 595 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 596 - $action: the current action
 597 - &$xrdsoutputter - XRDSOutputter object to write to
 598
 599 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 600 - $action: the current action
 601 - &$xrdsoutputter - XRDSOutputter object to write to
 602
 603 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 604 - $action: the current action
 605 - &$xrdsoutputter - XRDSOutputter object to write to
 606
 607 StartCheckPassword: Check a username/password
 608 - $nickname: The nickname to check
 609 - $password: The password to check
 610 - &$authenticatedUser: set to User object if credentials match a user.
 611
 612 EndCheckPassword: After checking a username/password pair
 613 - $nickname: The nickname that was checked
 614 - $password: The password that was checked
 615 - $authenticatedUser: User object if credentials match a user, else null.
 616
 617 StartChangePassword: Before changing a password
 618 - Profile $target: The profile of the User that is changing password
 619 - $oldpassword: the user's old password
 620 - $newpassword: the desired new password
 621
 622 EndChangePassword: After changing a password
 623 - Profile $target: The profile of the User that just changed its password
 624
 625 StartHashPassword: Generate a hashed version of the password (like a salted crypt)
 626 - &$hashed: Hashed version of the password, later put in the database
 627 - $password: The password that should be hashed
 628 - $profile: Profile that this password and hash belongs to. Can be null.
 629
 630 StartSetUser: Before setting the currently logged in user
 631 - $user: user
 632
 633 EndSetUser: After setting the currently logged in user
 634 - $user: user
 635
 636 StartSetApiUser: Before setting the current API user
 637 - &$user: user, can be set during event handling (return false to stop processing)
 638
 639 EndSetApiUser: After setting the current API user
 640 - $user: user, only called if this is an actual user
 641
 642 StartHasRole: Before determing if the a profile has a given role
 643 - $profile: profile in question
 644 - $name: name of the role in question
 645 - &$has_role: does this profile have the named role?
 646
 647 EndHasRole: Before determing if the a profile has a given role
 648 - $profile: profile in question
 649 - $name: name of the role in question
 650 - $has_role: does this profile have the named role?
 651
 652 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 653 - $user: User object
 654 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
 655
 656 GetUrlShorteners: Specify URL shorteners that are available for use
 657 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
 658
 659 StartShortenUrl: About to shorten a URL
 660 - $url: url to be shortened
 661 - $shortenerName: name of the requested shortener
 662 - &$shortenedUrl: short version of the url
 663
 664 EndShortenUrl: After a URL has been shortened
 665 - $url: url to be shortened
 666 - $shortenerName: name of the requested shortener
 667 - $shortenedUrl: short version of the url
 668
 669 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
 670 - $action
 671 - &$src
 672 - &$theme
 673 - &$media
 674
 675 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
 676 - $action
 677 - $src
 678 - $theme
 679 - $media
 680
 681 StartStyleElement: Before a <style...> element is written
 682 - $action
 683 - &$code
 684 - &$type
 685 - &$media
 686
 687 EndStyleElement: After a <style...> element is written
 688 - $action
 689 - $code
 690 - $type
 691 - $media
 692
 693 StartScriptElement: Before a <script...> element is written
 694 - $action
 695 - &$src
 696 - &$type
 697
 698 EndScriptElement: After a <script...> element is written
 699 - $action
 700 - $src
 701 - $type
 702
 703 StartInlineScriptElement: Before a <script...> element is written
 704 - $action
 705 - &$code
 706 - &$type
 707
 708 EndInlineScriptElement: After a <script...> element is written
 709 - $action
 710 - $code
 711 - $type
 712
 713 StartLog: Before writing to the logs
 714 - &$priority
 715 - &$msg
 716 - &$filename
 717
 718 EndLog: After writing to the logs
 719 - $priority
 720 - $msg
 721 - $filename
 722
 723 StartBlockProfile: when we're about to block
 724 - $user: the person doing the block
 725 - $profile: the person getting blocked, can be remote
 726
 727 EndBlockProfile: when a block has succeeded
 728 - $user: the person doing the block
 729 - $profile: the person blocked, can be remote
 730
 731 StartUnblockProfile: when we're about to unblock
 732 - $user: the person doing the unblock
 733 - $profile: the person getting unblocked, can be remote
 734
 735 EndUnblockProfile: when an unblock has succeeded
 736 - $user: the person doing the unblock
 737 - $profile: the person unblocked, can be remote
 738
 739 StartSubscribe: when a subscription is starting
 740 - $profile: Profile that is subscribing
 741 - $other: Profile that is being subscribed to
 742
 743 EndSubscribe: when a subscription is finished
 744 - $profile: Profile that is subscribing
 745 - $other: Profile that is being subscribed to
 746
 747 StartUnsubscribe: when an unsubscribe is starting
 748 - $profile: Profile that is unsubscribing
 749 - $other: Profile that is being unsubscribed from
 750
 751 EndUnsubscribe: when an unsubscribe is done
 752 - $profile: Profile that is unsubscribing
 753 - $other: Profile that is being unsubscribed from
 754
 755 StartJoinGroup: when a user is joining a group
 756 - $group: the group being joined
 757 - $profile: the local or remote user joining
 758
 759 EndJoinGroup: when a user finishes joining a group
 760 - $group: the group being joined
 761 - $profile: the local or remote user joining
 762
 763 StartLeaveGroup: when a user is leaving a group
 764 - $group: the group being left
 765 - $profile: the local or remote user leaving
 766
 767 EndLeaveGroup: when a user has left a group
 768 - $group: the group being left
 769 - $profile: the local or remote user leaving
 770
 771 StartShowContentLicense: Showing the default license for content
 772 - $action: the current action
 773
 774 EndShowContentLicense: Showing the default license for content
 775 - $action: the current action
 776
 777 GetImTransports: Get IM transports that are available
 778 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
 779
 780 NormalizeImScreenname: Normalize an IM screenname
 781 - $transport: transport the screenname is on
 782 - &$screenname: screenname to be normalized
 783
 784 ValidateImScreenname: Validate an IM screenname
 785 - $transport: transport the screenname is on
 786 - $screenname: screenname to be validated
 787 - $valid: is the screenname valid?
 788
 789 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
 790 - $transport: transport the screenname exists on
 791 - $screenname: screenname being confirmed
 792 - $code: confirmation code for confirmation URL
 793 - $user: user requesting the confirmation
 794
 795 StartUserRegister: When a new user is being registered
 796 - $profile: Profile object with new profile data (no ID yet)
 797
 798 EndUserRegister: When a new user has been registered
 799 - $profile: Profile object with new profile data
 800
 801 StartRobotsTxt: Before outputting the robots.txt page
 802 - &$action: RobotstxtAction being shown
 803
 804 EndRobotsTxt: After the default robots.txt page (good place for customization)
 805 - &$action: RobotstxtAction being shown
 806
 807 StartGetProfileUri: When determining the canonical URI for a given profile
 808 - $profile: the current profile
 809 - &$uri: the URI
 810
 811 EndGetProfileUri: After determining the canonical URI for a given profile
 812 - $profile: the current profile
 813 - &$uri: the URI
 814
 815 StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
 816 - $profile: Profile of user we want to get acct: URI for
 817 - &$acct:   string with the resulting acct: uri
 818
 819 EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
 820 - $profile: Profile of user we want to get acct: URI for
 821 - &$acct:   string with the resulting acct: uri
 822
 823 StartFindMentions: start finding mentions in a block of text
 824 - $sender: sender profile
 825 - $text: plain text version of the notice
 826 - &$mentions: mentions found so far. Array of arrays; each array
 827   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 828   'title' (title of the link), 'position' (position of the text to
 829   replace), 'text' (text to replace)
 830
 831 EndFindMentions: end finding mentions in a block of text
 832 - $sender: sender profile
 833 - $text: plain text version of the notice
 834 - &$mentions: mentions found so far. Array of arrays; each array
 835   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 836   'title' (title of the link), 'position' (position of the text to
 837   replace), 'text' (text to replace)
 838
 839 StartShowSubscriptionsContent: before showing the subscriptions content
 840 - $action: the current action
 841
 842 EndShowSubscriptionsContent: after showing the subscriptions content
 843 - $action: the current action
 844
 845 StartShowUserGroupsContent: before showing the user groups content
 846 - $action: the current action
 847
 848 EndShowUserGroupsContent: after showing the user groups content
 849 - $action: the current action
 850
 851 StartShowAllContent: before showing the all (you and friends) content
 852 - $action: the current action
 853
 854 EndShowAllContent: after showing the all (you and friends) content
 855 - $action: the current action
 856
 857 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
 858 - $action: the current action
 859
 860 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
 861 - $action: the current action
 862
 863 StartShowGroupsMiniList: at the start of groups mini list
 864 - $action: the current action
 865
 866 EndShowGroupsMiniList: at the end of groups mini list
 867 - $action: the current action
 868
 869 StartDeleteUserForm: starting the data in the form for deleting a user
 870 - $action: action being shown
 871 - $user: user being deleted
 872
 873 EndDeleteUserForm: Ending the data in the form for deleting a user
 874 - $action: action being shown
 875 - $user: user being deleted
 876
 877 StartDeleteUser: handling the post for deleting a user
 878 - $action: action being shown
 879 - $user: user being deleted
 880
 881 EndDeleteUser: handling the post for deleting a user
 882 - $action: action being shown
 883 - $user: user being deleted
 884
 885 StartNoticeAsActivity: before converting a notice to an activity
 886 - $notice: notice being converted
 887 - &$activity: initially empty activity
 888
 889 EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
 890 - $notice: notice being converted
 891 - &$activity: activity, now more-or-less full
 892
 893 StartNoticeSaveWeb: before saving a notice through the Web interface
 894 - $action: action being executed (instance of NewNoticeAction)
 895 - &$authorId: integer ID of the author
 896 - &$text: text of the notice
 897 - &$options: additional options (location, replies, etc.)
 898
 899 EndNoticeSaveWeb: after saving a notice through the Web interface
 900 - $action: action being executed (instance of NewNoticeAction)
 901 - $notice: notice that was saved
 902
 903 StartRssEntryArray: at the start of copying a notice to an array
 904 - $notice: the notice being copied
 905 - &$entry: the entry (empty at beginning)
 906
 907 EndRssEntryArray: at the end of copying a notice to an array
 908 - $notice: the notice being copied
 909 - &$entry: the entry, with all the fields filled up
 910
 911 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
 912 - $notice: notice being deleted
 913
 914 FileDeleteRelated: at the beginning of deleting related fields to a File
 915 - $notice: File being deleted
 916
 917 StartShowHeadTitle: when beginning to show the <title> element
 918 - $action: action being shown
 919
 920 EndShowHeadTitle: when done showing the <title>
 921 - $action: action being shown
 922
 923 StartShowPageTitle: when beginning to show the page title <h1>
 924 - $action: action being shown
 925
 926 EndShowPageTitle: when done showing the page title <h1>
 927 - $action: action being shown
 928
 929 StartDeleteOwnNotice: when a user starts to delete their own notice
 930 - $user: the user doing the delete
 931 - $notice: the notice being deleted
 932
 933 EndDeleteOwnNotice: when a user has deleted their own notice
 934 - $user: the user doing the delete
 935 - $notice: the notice being deleted
 936
 937 StartShowFeedLinkList: before showing the feed list in the sidebar
 938 - $action: action being executed
 939 - $feeds: list of feeds to show
 940
 941 EndShowFeedLinkList: after showing the feed list in the sidebar
 942 - $action: action being executed
 943 - $feeds: list of feeds shown
 944
 945 StartShowFeedLink: before showing an individual feed item
 946 - $action: action being executed
 947 - $feed: feed to show
 948
 949 EndShowFeedLink: after showing an individual feed
 950 - $action: action being executed
 951 - $feed: feed to show
 952
 953 StartShowNoticeForm: before showing the notice form (before <form>)
 954 - $action: action being executed
 955
 956 EndShowNoticeForm: after showing the notice form (after <form>)
 957 - $action: action being executed
 958
 959 StartShowEntryForms: microapp entry form tab data
 960 - &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
 961
 962 StartGrantRole: when a role is being assigned
 963 - $profile: profile that will have the role
 964 - $role: string name of the role
 965
 966 EndGrantRole: when a role has been successfully assigned
 967 - $profile: profile that will have the role
 968 - $role: string name of the role
 969
 970 StartRevokeRole: when a role is being revoked
 971 - $profile: profile that will lose the role
 972 - $role: string name of the role
 973
 974 EndRevokeRole: when a role has been revoked
 975 - $profile: profile that lost the role
 976 - $role: string name of the role
 977
 978 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
 979 - &$activity: received activity
 980 - $profile: profile of the user publishing the entry
 981 - &$notice: notice created; initially null, can be set
 982
 983 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
 984 - $activity: received activity
 985 - $profile: profile of the user publishing the entry
 986 - $notice: notice that was created
 987
 988 AdminPanelCheck: When checking whether the current user can access a given admin panel
 989 - $name:  Name of the admin panel
 990 - &$isOK: Boolean whether the user is allowed to use the panel
 991
 992 StartAdminPanelNav: Before displaying the first item in the list of admin panels
 993 - $nav The AdminPanelNav widget
 994
 995 EndAdminPanelNav: After displaying the last item in the list of admin panels
 996 - $nav The AdminPanelNav widget
 997
 998 StartActivityObjectFromNotice: When converting a notice to an activity:object
 999 - $notice: The notice being converted
1000 - &$object: The resulting object. Fill this and return false to override defaults.
1001
1002 EndActivityObjectFromNotice: After converting a notice to an activity:object
1003 - $notice: The notice being converted
1004 - &$object: The resulting object. Can be edited
1005
1006 StartActivityObjectFromProfile: When converting a profile to an activity:object
1007 - $profile: The profile being converted
1008 - &$object: The (empty) object. Fill it up and return false to override defaults.
1009
1010 EndActivityObjectFromProfile: After converting a profile to an activity:object
1011 - $profile: The profile being converted
1012 - &$object: The finished object. Can be tweaked
1013
1014 StartActivityObjectFromGroup: When converting a group to an activity:object
1015 - $group: The group being converted
1016 - &$object: The (empty) object. Fill and return false to override.
1017
1018 EndActivityObjectFromGroup:  After converting a group to an activity:object
1019 - $group:  The group being converted
1020 - &$object: The finished object. Tweak as needed.
1021
1022 StartImportActivity: when we start to import an activity
1023 - $user: User to make the author import
1024 - $author: Author of the feed; good for comparisons
1025 - $activity: The current activity
1026 - $trusted: How "trusted" the process is
1027 - &$done: Return value; whether to continue
1028
1029 EndImportActivity: when we finish importing an activity
1030 - $user: User to make the author import
1031 - $author: Author of the feed; good for comparisons
1032 - $activity: The current activity
1033 - $trusted: How "trusted" the process is
1034
1035 StartProfileSettingsActions: when we're showing account-management action list
1036 - $action: Action being shown (use for output)
1037
1038 EndProfileSettingsActions: when we're showing account-management action list
1039 - $action: Action being shown (use for output)
1040
1041 StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
1042 - $nli: The notice list item being shown
1043
1044 EndOpenNoticeListItemElement: After the opening <li> of a notice list element
1045 - $nli: The notice list item being shown
1046
1047 StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
1048 - $nli: The notice list item being shown
1049
1050 EndCloseNoticeListItemElement: After the closing </li> of a notice list element
1051 - $nli: The notice list item being shown
1052
1053 StartGroupEditFormData: Beginning the group edit form entries
1054 - $form: The form widget being shown
1055
1056 EndGroupEditFormData: Ending the group edit form entries
1057 - $form: The form widget being shown
1058
1059 StartGroupSave: After initializing but before saving a group
1060 - &$group: group about to be saved
1061
1062 EndGroupSave: After saving a group, aliases, and first member
1063 - $group: group that was saved
1064
1065 StartInterpretCommand: Before running a command
1066 - $cmd: First word in the string, 'foo' in 'foo argument'
1067 - $arg: Argument, if any, like 'argument' in 'foo argument'
1068 - $user: User who issued the command
1069 - &$result: Resulting command; you can set this!
1070
1071 EndInterpretCommand: Before running a command
1072 - $cmd: First word in the string, 'foo' in 'foo argument'
1073 - $arg: Argument, if any, like 'argument' in 'foo argument'
1074 - $user: User who issued the command
1075 - $result: Resulting command
1076
1077 StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
1078 - $action: action being executed (for output and params)
1079 - $group: group for the page
1080
1081 EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
1082 - $action: action being executed (for output and params)
1083 - $group: group for the page
1084
1085 StartGroupProfileElements: Start showing stuff about the group on its profile page
1086 - $action: action being executed (for output and params)
1087 - $group: group for the page
1088
1089 EndGroupProfileElements: Start showing stuff about the group on its profile page
1090 - $action: action being executed (for output and params)
1091 - $group: group for the page
1092
1093 StartShowProfileTagContent: When showing a people tag page
1094 - $action: action being executed (for output and params)
1095
1096 EndShowProfileTagContent: After showing the contents of a people tag page
1097 - $action: action being executed (for output and params)
1098
1099 StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
1100 - $action: action being executed (for output and params)
1101
1102 EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
1103 - $action: action being executed (for output and params)
1104
1105 StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
1106 - $action: action being executed (for output and params)
1107
1108 EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
1109 - $action: action being executed (for output and params)
1110
1111 StartTagProfileAction: When starting to show profile tagging page
1112 - $action: action being executed (for output and params)
1113 - $profile: profile being tagged
1114
1115 EndTagProfileAction: After showing profile tagging page
1116 - $action: action being executed (for output and params)
1117 - $profile: profile being tagged
1118
1119 StartProfileCompletionSearch: When starting a profile search for autocompletion
1120 - $action: action being executed (for output and params)
1121 - &$profile: result Profile objects
1122 - $search_engine: the search engine
1123
1124 EndProfileCompletionSearch: After search results for profile autocompletion have been found
1125 - $action: profilec completion action
1126 - &$profile: current result Profile objects
1127 - $search_engine: The search engine object
1128
1129 StartShowTagProfileForm: When showing people tagging form
1130 - $action: action being executed (for output and params)
1131 - $profile: profile being tagged
1132
1133 EndShowTagProfileForm: After showing people tagging form
1134 - $action: action being executed (for output and params)
1135 - $profile: profile being tagged
1136
1137 StartSavePeopletags: When starting to save people tags
1138 - $action: action being executed (for output and params)
1139 - $tagstring: string input, a list of tags
1140
1141 EndSavePeopletags: After saving people tags
1142 - $action: action being executed (for output and params)
1143 - $tagstring: string input, a list of tags
1144
1145 StartProfiletagGetUri: when generating the Uri for a people tag
1146 - $profile_list: the people tag, a Profile_list object
1147 - &$uri: the URI
1148
1149 EndProfiletagGetUri: after generating the uri for a people tag
1150 - $profile_list: the people tag, a Profile_list object
1151 - &$uri: the URI
1152
1153 StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
1154 - $profile_list: the people tag, a Profile_list object
1155 - &$url: the URL
1156
1157 EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
1158 - $profile_list: the people tag, a Profile_list object
1159 - &$url: the URL
1160
1161 StartProfiletagPermalink: when generating the permalink url for a people tag
1162 - $profile_list: the people tag, a Profile_list object
1163 - &$url: the URL
1164
1165 EndProfiletagPermalink: after generating the permalink url for a people tag
1166 - $profile_list: the people tag, a Profile_list object
1167 - &$url: the URL
1168
1169 StartTagProfile: when tagging a profile
1170 - $tagger: profile tagging
1171 - $tagged: profile being tagged
1172 - $tag: the tag
1173
1174 EndTagProfile: after tagging a profile
1175 - $newtag: the newly created Profile_tag object
1176
1177 StartUntagProfile: when deleting a people tag
1178 - $ptag: the Profile_tag object being deleted
1179
1180 EndUntagProfile: after deleting a people tag
1181 - $orig: a copy of the deleted Profile_tag object
1182
1183 StartSubscribePeopletag: when subscribing to a people tag
1184 - $peopletag: Profile_list object being subscribed to
1185 - $profile: subscriber's profile
1186
1187 EndSubscribePeopletag: after subscribing to a people tag
1188 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1189 - $profile: subscriber's profile
1190
1191 StartUnsubscribePeopletag: when unsubscribing to a people tag
1192 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1193 - $profile: subscriber's profile
1194
1195 EndUnsubscribePeopletag: after unsubscribing to a people tag
1196 - $peopletag: Profile_list object being subscribed to
1197 - $profile: subscriber's profile
1198
1199 StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
1200 - $profile_list: the people tag, a Profile_list object
1201 - &$object: activity object
1202
1203 EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
1204 - $profile_list: the people tag, a Profile_list object
1205 - &$object: activity object
1206
1207 StartPeopletagGroupNav: Showing the people tag nav menu
1208 - $menu: the menu widget; use $menu->action for output
1209
1210 EndPeopletagGroupNav: after showing the people tag nav menu
1211 - $menu: the menu widget; use $menu->action for output
1212
1213 StartShowPeopletagItem: when showing a people tag
1214 - $widget: PeopletagListItem widget
1215
1216 EndShowPeopletagItem: after showing a people tag
1217 - $widget: PeopletagListItem widget
1218
1219 StartSubscribePeopletagForm: when showing people tag subscription form
1220 - $action: action being executed (for output and params)
1221 - $peopletag: people tag being subscribed to
1222
1223 EndSubscribePeopletagForm: after showing the people tag subscription form
1224 - $action: action being executed (for output and params)
1225 - $peopletag: people tag being subscribed to
1226
1227 StartShowPeopletags: when showing a textual list of people tags
1228 - $widget: PeopletagsWidget; use $widget->out for output
1229 - $tagger: profile of the tagger
1230 - $tagged: profile tagged
1231
1232 EndShowPeopletags: after showing a textual list of people tags
1233 - $widget: PeopletagsWidget; use $widget->out for output
1234 - $tagger: profile of the tagger
1235 - $tagged: profile tagged
1236
1237 StartProfileListItemTags: when showing people tags in a profile list item widget
1238 - $widget: ProfileListItem widget
1239
1240 EndProfileListItemTags: after showing people tags in a profile list item widget
1241 - $widget: ProfileListItem widget
1242
1243 StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
1244 - $obj: ActivityObject
1245 - $out: XMLOutputter to append custom output
1246
1247 EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
1248 - $obj: ActivityObject
1249 - $out: XMLOutputter to append custom output
1250
1251 StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
1252 - $obj ActivityObject
1253 - &$out: array to be serialized; you're free to modify it
1254
1255 EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
1256 - $obj ActivityObject
1257 - &$out: array to be serialized; you're free to modify it
1258
1259 StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
1260 - $notice Notice
1261 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1262
1263 EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here.  Be aware that output can be cached or used several times, so should remain idempotent.
1264 - $notice Notice
1265 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1266
1267 StartDefaultLocalNav: When showing the default local nav
1268 - $menu: the menu
1269 - $user: current user
1270
1271 EndDefaultLocalNav: When showing the default local nav
1272 - $menu: the menu
1273 - $user: current user
1274
1275 StartShowAccountProfileBlock: When showing the profile block for an account
1276 - $out: XMLOutputter to append custom output
1277 - $profile: the profile being shown
1278
1279 EndShowAccountProfileBlock: After showing the profile block for an account
1280 - $out: XMLOutputter to append custom output
1281 - $profile: the profile being shown
1282
1283 StartShowGroupProfileBlock: When showing the profile block for a group
1284 - $out: XMLOutputter to append custom output
1285 - $profile: the profile being shown
1286
1287 EndShowGroupProfileBlock: After showing the profile block for a group
1288 - $out: XMLOutputter to append custom output
1289 - $group: the group being shown
1290
1291 StartShowConversation: start the listing of a conversation
1292 - $action: Action object (used mainly as HTMLOutputter)
1293 - $conv: Conversation object, has functions to retrieve relevant notices
1294 - $scoped: Profile for scoping (null if not logged in)
1295
1296 EndShowConversation: after the listing of a conversation
1297 - $action: Action object (used mainly as HTMLOutputter)
1298 - $conv: Conversation object, has functions to retrieve relevant notices
1299 - $scoped: Profile for scoping (null if not logged in)
1300
1301 StartShowThreadedNoticeTail: when showing the replies etc. to a notice
1302 - $nli: parent noticelistitem
1303 - $notice: parent notice
1304 - &$children: list of children
1305
1306 EndShowThreadedNoticeTail: when showing the replies etc. to a notice
1307 - $nli: parent noticelistitem
1308 - $notice: parent notice
1309 - $children: list of children
1310
1311 StartShowThreadedNoticeSub: when showing a reply to a notice
1312 - $nli: parent noticelistitem
1313 - $parent: parent notice
1314 - $child: child notice
1315
1316 EndShowThreadedNoticeSub: when showing a reply to a notice
1317 - $nli: parent noticelistitem
1318 - $parent: parent notice
1319 - $child: child notice
1320
1321 StartAddEmailAddress: when adding an email address through the Web UI
1322 - $user: user getting the new address
1323 - $email: email being added
1324
1325 EndAddEmailAddress: done adding an email address through the Web UI
1326 - $user: user getting the new address
1327 - $email: email being added
1328
1329 StartValidateEmailInvite: when validating an email address for invitations
1330 - $user: user doing the invite
1331 - $email: email address
1332 - &$valid: flag for if it's valid; can be modified
1333
1334 EndValidateEmailInvite: after validating an email address for invitations
1335 - $user: user doing the invite
1336 - $email: email address
1337 - &$valid: flag for if it's valid; can be modified
1338
1339 StartLocalURL: before resolving a local url for an action
1340 - &$action: action to find a path for
1341 - &$paramsi: parameters to pass to the action
1342 - &$fragment: any url fragement
1343 - &$addSession: whether to add session variable
1344 - &$url: resulting URL to local resource
1345
1346 EndLocalURL: before resolving a local url for an action
1347 - &$action: action to find a path for
1348 - &$paramsi: parameters to pass to the action
1349 - &$fragment: any url fragement
1350 - &$addSession: whether to add session variable
1351 - &$url: resulting URL to local resource
1352
1353 StartProfileGetAvatar: When getting an avatar for a profile
1354 - $profile: profile
1355 - $size: size of the avatar
1356 - &$avatar: avatar
1357
1358 EndProfileGetAvatar: After getting an avatar for a profile
1359 - $profile: profile
1360 - $size: size of the avatar
1361 - &$avatar: avatar
1362
1363 StartRegisterSuccess: Before showing the registration success message
1364 - $action: the registration action
1365
1366 StartRegisterSuccess: After showing the registration success message
1367 - $action: the registration action
1368
1369 StartDocFileForTitle: Before searching for a doc or mail template
1370 - $title: Title we're looking for
1371 - &$paths: Paths we're searching
1372 - &$filename: Filename so far (set this if you want)
1373
1374 EndDocFileForTitle: After searching for a doc or mail template
1375 - $title: Title we looked for
1376 - $paths: Paths we searched
1377 - &$filename: Filename so far (set this if you want)
1378
1379 StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
1380 - &$tables: list of table names
1381 - &$rwdb: read-write database URI
1382
1383 EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
1384 - $tables: list of table names
1385 - $rwdb: read-write database URI
1386
1387 StartShowInviteForm: Right before displaying the invitations form
1388 - $action: invitation action
1389
1390 EndShowInviteForm: After displaying the invitations form
1391 - $action: invitation action
1392
1393 StartSendInvitations: Right before sending invitations
1394 - $action: invitation action
1395
1396 EndSendInvitations: Right after sending invitations
1397 - $action: invitation action
1398
1399 StartShowInvitationSuccess: Right before showing invitations success msg
1400 - $action: invitation action
1401
1402 EndShowInvitationSuccess: After showing invitations success msg
1403 - $action: invitation action
1404
1405 StartUpgrade: when starting a site upgrade
1406
1407 EndUpgrade: when ending a site upgrade; good place to do your own upgrades
1408
1409 HaveIMPlugin: is there an IM plugin loaded?
1410 - &$haveIMPlugin: set me to true if you're loaded!
1411
1412 StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
1413 - $nli: NoticeListItem being shown
1414
1415 EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
1416 - $nli: NoticeListItem being shown
1417
1418 StartNoticeInScope: Before checking if a notice should be visible to a user
1419 - $notice: The notice to check
1420 - $profile: The profile to check for scope
1421 - &$bResult: The boolean result; fill this in if you want to skip
1422
1423 EndNoticeInScope: After checking if a notice should be visible to a user
1424 - $notice: The notice to check
1425 - $profile: The profile to check for scope
1426 - &$bResult: The boolean result; overwrite this if you so desire
1427
1428 StartNoticeListPrefill: Before pre-filling a list of notices with extra data
1429 - &$notices: Notices to be pre-filled
1430 - $avatarSize: The avatar size for the list
1431
1432 EndNoticeListPrefill: After pre-filling a list of notices with extra data
1433 - &$notices: Notices that were pre-filled
1434 - &$profiles: Profiles that were pre-filled
1435 - $avatarSize: The avatar size for the list
1436
1437 OtherAccountProfiles: Hook to add account profiles to a user account profile block
1438 - $profile: the Profile being shown
1439 - &$others: Modifiable array of profile info arrays. Each one has the following fields:
1440             href: link to the profile
1441             text: text for the profile
1442             image: mini image for the profile
1443
1444 CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
1445 - $file:    'File' object to source the image from
1446 - &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
1447 - $media:   MIME media type ('image', 'video', 'audio' etc.)
1448
1449 StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
1450 - $imagefile: ImageFile object we're resizing.
1451 - $outpath:   string with output filepath
1452 - $box:       array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
1453
1454 FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file
1455 - $imagefile    ImageFile object which we're getting metadata for (such as animated status, width/height etc.)
1456
1457 StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1458 - $out:     HTMLOutputter class to use for outputting HTML.
1459 - $file:    'File' object which we're going to show representation for.
1460
1461 EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
1462 - $out:     HTMLOutputter class to use for outputting HTML.
1463 - $file:    'File' object which we're going to show representation for.
1464
1465 ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1466 - $out:     HTMLOutputter class to use for outputting HTML.
1467 - $file:    'File' object which we're going to show representation for.
1468
1469 StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
1470 - $stored:         Notice object that is being distributed.
1471 - &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
1472
1473 EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
1474 - $stored:         Notice object that is being distributed.
1475 - $mentioned_ids:  Array of profile IDs (not just for local users) who got mentioned by the notice.
1476
1477 StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
1478 - $out:     HTMLOutputter used to output (usually an Action, but not always!)
1479 - &$items:  Referenced array of items in the nav (add if desired)
1480
1481 EndHomeStubNavItems:
1482 - $out:     HTMLOutputter used to output (usually an Action, but not always!)
1483 - $items:   array of menu items
1484
1485 StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
1486 - $out:     HTMLOutputter used to output (usually an Action, but not always!)
1487 - $menu:    The Menu object outputted as a submenu.
1488 - $label:   Localized text which represents the menu item.
1489
1490 EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
1491 - $out:     HTMLOutputter used to output (usually an Action, but not always!)
1492 - $menu:    The Menu object outputted as a submenu.
1493 - $label:   Localized text which represents the menu item.
1494
1495 StartDocNav: Before outputting the docs Nav
1496 - $nav: The DoclNav widget
1497
1498 EndDocNav: After outputting the docs Nav
1499 - $nav: The DoclNav widget