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