EVENTS.txt

   1 InitializePlugin: a chance to initialize a plugin in a complete environment
   2
   3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
   4
   5 StartPrimaryNav: Showing the primary nav menu
   6 - $action: the current action
   7
   8 EndPrimaryNav: At the end of the primary nav menu
   9 - $action: the current action
  10
  11 StartSecondaryNav: Showing the secondary nav menu
  12 - $action: the current action
  13
  14 EndSecondaryNav: At the end of the secondary nav menu
  15 - $action: the current action
  16
  17 StartShowStyles: Showing Style links; good place to add UA style resets
  18 - $action: the current action
  19
  20 EndShowStyles: End showing Style links; good place to add custom styles
  21 - $action: the current action
  22
  23 StartShowStatusNetStyles: Showing StatusNet Style links
  24 - $action: the current action
  25
  26 EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
  27 - $action: the current action
  28
  29 StartShowLaconicaStyles: backwards compatibility; deprecated
  30 - $action: the current action
  31
  32 EndShowLaconicaStyles: backwards compatibility; deprecated
  33 - $action: the current action
  34
  35 StartShowUAStyles: Showing custom User-Agent style links
  36 - $action: the current action
  37
  38 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  39 - $action: the current action
  40
  41 StartShowScripts: Showing JavaScript links
  42 - $action: the current action
  43
  44 EndShowScripts: End showing JavaScript links; good place to add custom
  45                 links like Google Analytics
  46 - $action: the current action
  47
  48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  49 - $action: the current action
  50
  51 EndShowJQueryScripts: End showing JQuery script links
  52 - $action: the current action
  53
  54 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  55 - $action: the current action
  56
  57 EndShowStatusNetScripts: End showing StatusNet script links
  58 - $action: the current action
  59
  60 StartShowLaconicaScripts: backwards compatibility; deprecated
  61 - $action: the current action
  62
  63 EndShowLaconicaScripts: backwards compatibility; deprecated
  64 - $action: the current action
  65
  66 StartShowSections: Start the list of sections in the sidebar
  67 - $action: the current action
  68
  69 EndShowSections: End the list of sections in the sidebar
  70 - $action: the current action
  71
  72 StartShowHeader: Showing before the header container
  73 - $action: the current action
  74
  75 EndShowHeader: Showing after the header container
  76 - $action: the current action
  77
  78 StartShowFooter: Showing before the footer container
  79 - $action: the current action
  80
  81 EndShowFooter: Showing after the footer container
  82 - $action: the current action
  83
  84 StartShowContentBlock: Showing before the content container
  85 - $action: the current action
  86
  87 EndShowContentBlock: Showing after the content container
  88 - $action: the current action
  89
  90 StartShowAside: Showing before the Aside container
  91 - $action: the current action
  92
  93 EndShowAside: Showing after the Aside container
  94 - $action: the current action
  95
  96 StartShowNoticeFormData: Showing before the notice form data
  97 - $action: the current action
  98
  99 EndShowNoticeFormData: Showing after the notice form data
 100 - $action: the current action
 101
 102 StartNoticeSave: before inserting a notice (good place for content filters)
 103 - $notice: notice being saved (no ID or URI)
 104
 105 EndNoticeSave: after inserting a notice and related code
 106 - $notice: notice that was saved (with ID and URI)
 107
 108 StartShowLocalNavBlock: Showing the local nav menu
 109 - $action: the current action
 110
 111 EndShowLocalNavBlock: At the end of the local nav menu
 112 - $action: the current action
 113
 114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
 115 - $action: the current action
 116
 117 EndShowHTML: Showing after the html element
 118 - $action: the current action
 119
 120 StartPublicGroupNav: Showing the public group nav menu
 121 - $action: the current action
 122
 123 EndPublicGroupNav: At the end of the public group nav menu
 124 - $action: the current action
 125
 126 StartSubGroupNav: Showing the subscriptions group nav menu
 127 - $action: the current action
 128
 129 EndSubGroupNav: At the end of the subscriptions group nav menu
 130 - $action: the current action
 131
 132 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
 133 - $m: the Net_URL_Mapper that has just been set up
 134
 135 RouterInitialized: After the router instance has been initialized
 136 - $m: the Net_URL_Mapper that has just been set up
 137
 138 StartLogout: Before logging out
 139 - $action: the logout action
 140
 141 EndLogout: After logging out
 142 - $action: the logout action
 143
 144 ArgsInitialize: After the argument array has been initialized
 145 - $args: associative array of arguments, can be modified
 146
 147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 148 - $action: the current action
 149
 150 EndAddressData: At the end of <address>
 151 - $action: the current action
 152
 153 StartShowSiteNotice: Before showing site notice
 154 - $action: the current action
 155
 156 EndShowSiteNotice: After showing site notice
 157 - $action: the current action
 158
 159 StartLoginGroupNav: Before showing the login and register navigation menu
 160 - $action: the current action
 161
 162 EndLoginGroupNav: After showing the login and register navigation menu
 163 - $action: the current action
 164
 165 StartAccountSettingsNav: Before showing the account settings menu
 166 - $action: the current action
 167
 168 EndAccountSettingsNav: After showing the account settings menu
 169 - $action: the current action
 170
 171 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
 172 - $widget: AccountSettingsNav instance being shown
 173
 174 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
 175 - $widget: AccountSettingsNav instance being shown
 176
 177 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
 178 - $widget: AccountSettingsNav instance being shown
 179
 180 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
 181 - $widget: AccountSettingsNav instance being shown
 182
 183 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
 184 - $widget: AccountSettingsNav instance being shown
 185
 186 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
 187 - $widget: AccountSettingsNav instance being shown
 188
 189 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
 190 - $widget: AccountSettingsNav instance being shown
 191
 192 EndAccountSettingsEmailMenuItem: After showing the Email menu item
 193 - $widget: AccountSettingsNav instance being shown
 194
 195 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
 196 - $widget: AccountSettingsNav instance being shown
 197
 198 EndAccountSettingsDesignMenuItem: After showing the Design menu item
 199 - $widget: AccountSettingsNav instance being shown
 200
 201 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
 202 - $widget: AccountSettingsNav instance being shown
 203
 204 EndAccountSettingsOtherMenuItem: After showing the Other menu item
 205 - $widget: AccountSettingsNav instance being shown
 206
 207 Autoload: When trying to autoload a class
 208 - $cls: the class being sought. A plugin might require_once the file for the class.
 209
 210 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 211 - $action: name of the action, like 'login'
 212 - $sensitive: flag for whether this is a sensitive action
 213
 214 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 215 - $action: name of the action, like 'register'
 216 - $login: flag for whether this is a login action
 217
 218 StartShowHead: called before showing the <head> element and children
 219 - $action: action object being show
 220
 221 EndShowHead: called after showing the <head> element (and </head>)
 222 - $action: action object being shown
 223
 224 StartShowBody: called before showing the <body> element and children
 225 - $action: action object being shown
 226
 227 EndShowBody: called after showing the <body> element (and </body>)
 228 - $action: action object being shown
 229
 230 StartPersonalGroupNav: beginning of personal group nav menu
 231 - $action: action object being shown
 232
 233 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 234 - $action: action object being shown
 235
 236 StartGroupGroupNav: Showing the group nav menu
 237 - $action: the current action
 238
 239 EndGroupGroupNav: At the end of the group nav menu
 240 - $action: the current action
 241
 242 StartEndHTML: just before the </html> tag
 243 - $action: action object being shown
 244
 245 EndEndHTML: just after the </html> tag
 246 - $action: action object being shown
 247
 248 StartShowDesign: just before showing a site, user, or group design
 249 - $action: action object being shown
 250
 251 EndShowDesign: just after showing a site, user, or group design
 252 - $action: action object being shown
 253
 254 StartShowExportData: just before showing the <div> with export data (feeds)
 255 - $action: action object being shown
 256
 257 EndShowExportData: just after showing the <div> with export data (feeds)
 258 - $action: action object being shown
 259
 260 StartShowNoticeItem: just before showing the notice item
 261 - $action: action object being shown
 262
 263 EndShowNoticeItem: just after showing the notice item
 264 - $action: action object being shown
 265
 266 StartShowPageNotice: just before showing the page notice (instructions or error)
 267 - $action: action object being shown
 268
 269 EndShowPageNotice: just after showing the page notice (instructions or error)
 270 - $action: action object being shown
 271
 272 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 273 - $action: action object being shown
 274
 275 StartProfileFormData: just before showing text entry fields on profile settings page
 276 - $action: action object being shown
 277
 278 EndProfileFormData: just after showing text entry fields on profile settings page
 279 - $action: action object being shown
 280
 281 StartProfileSaveForm: before starting to save a profile settings form
 282 - $action: action object being shown
 283
 284 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 285 - $action: action object being shown
 286
 287 StartRegistrationFormData: just before showing text entry fields on registration page
 288 - $action: action object being shown
 289
 290 EndRegistrationFormData: just after showing text entry fields on registration page
 291 - $action: action object being shown
 292
 293 StartRegistrationTry: before validating and saving a new user
 294 - $action: action object being shown
 295
 296 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 297 - $action: action object being shown
 298
 299 StartAvatarFormData: before displaying avatar form
 300 - $action: action object being shown
 301
 302 EndAvatarFormData: after displaying avatar form
 303 - $action: action object being shown
 304
 305 StartAvatarSaveForm: before saving the avatar
 306 - $action: action object being shown
 307
 308 EndAvatarSaveForm: after saving the avatar
 309 - $action: action object being shown
 310
 311 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 312 - $qm: empty queue manager to set
 313
 314 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 315 - $action: action object being shown
 316 - $user: current user
 317
 318 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 319 - $title: title of the document
 320 - $output: HTML output to show
 321
 322 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 323 - $title: title of the document
 324 - $output: HTML output to show
 325
 326 StartApiRss: after the rss <channel> element is started
 327 - $action: action object being shown
 328
 329 StartApiAtom: after the <feed> element is started
 330 - $action: action object being shown
 331
 332 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 333 - $notice: the notice being added
 334 - &$transports: modifiable list of transports (as strings) to queue for
 335
 336 EndEnqueueNotice: after adding a notice to the queues
 337 - $notice: the notice being added
 338 - $transports: modifiable list of transports to use
 339
 340 UnqueueHandleNotice: Handle a notice when no queue manager is available
 341 - $notice: the notice to handle
 342 - $queue: the "queue" that is being executed
 343
 344 GetValidDaemons: Just before determining which daemons to run
 345 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 346
 347 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 348 - &$notice: notice to handle
 349
 350 StartShowHeadElements: Right after the <head> tag
 351 - $action: the current action
 352
 353 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 354 - $action: the current action
 355
 356 CheckSchema: chance to check the schema
 357
 358 StartProfileRemoteSubscribe: Before showing the link to remote subscription
 359 - $userprofile: UserProfile widget
 360 - &$profile: the profile being shown
 361
 362 EndProfileRemoteSubscribe: After showing the link to remote subscription
 363 - $userprofile: UserProfile widget
 364 - &$profile: the profile being shown
 365
 366 StartGroupSubscribe: Before showing the link to remote subscription
 367 - $action: the current action
 368 - $group: the group being shown
 369
 370 EndGroupSubscribe: After showing the link to remote subscription
 371 - $action: the current action
 372 - $group: the group being shown
 373
 374 StartProfilePageProfileSection: Starting to show the section of the
 375                               profile page with the actual profile data;
 376                               hook to prevent showing the profile (e.g.)
 377 - $userprofile: UserProfile widget
 378 - &$profile: the profile being shown
 379
 380 StartProfilePageProfileElements: inside the section, before the first
 381                                element; prepend elements here
 382 - $userprofile: UserProfile widget
 383 - &$profile: the profile being shown
 384
 385 EndProfilePageProfileElements: inside the section, after the last element;
 386                              append elements here
 387 - $userprofile: UserProfile widget
 388 - &$profile: the profile being shown
 389
 390 EndProfilePageProfileSection: After showing the section of the profile
 391                             page with the profile elements
 392 - $userprofile: UserProfile widget
 393 - &$profile: the profile being shown
 394
 395 StartProfilePageActionsSection: Starting to show the section of the
 396                                     profile page with action links; hook
 397                                     to hide them (for example)
 398 - $userprofile: UserProfile widget
 399 - &$profile: the profile being shown
 400
 401 StartProfilePageActionsElements: inside the list, before the first
 402                                      element; prepend elements here
 403 - $userprofile: UserProfile widget
 404 - &$profile: the profile being shown
 405
 406 EndProfilePageActionsElements: inside the list, after the last element;
 407                                    append elements here
 408 - $userprofile: UserProfile widget
 409 - &$profile: the profile being shown
 410
 411 EndProfilePageActionsSection: After showing the section of the profile
 412                                   page with the entity actions
 413 - $userprofile: UserProfile widget
 414 - &$profile: the profile being shown
 415
 416 StartProfilePageAvatar: before showing the avatar on the profile page
 417 - $userprofile: UserProfile widget
 418 - &$profile: the profile being shown
 419
 420 EndProfilePageAvatar: after showing the avatar on the profile page
 421 - $userprofile: UserProfile widget
 422 - &$profile: the profile being shown
 423
 424 StartProfilePageNickname: before showing the nickname on the profile page
 425 - $userprofile: UserProfile widget
 426 - &$profile: the profile being shown
 427
 428 EndProfilePageNickname: after showing the nickname on the profile page
 429 - $userprofile: UserProfile widget
 430 - &$profile: the profile being shown
 431
 432 StartProfilePageFullName: before showing the fullname on the profile page
 433 - $userprofile: UserProfile widget
 434 - &$profile: the profile being shown
 435
 436 EndProfilePageFullName: after showing the fullname on the profile page
 437 - $userprofile: UserProfile widget
 438 - &$profile: the profile being shown
 439
 440 StartProfilePageLocation: before showing the location on the profile page
 441 - $userprofile: UserProfile widget
 442 - &$profile: the profile being shown
 443
 444 EndProfilePageLocation: after showing the location on the profile page
 445 - $userprofile: UserProfile widget
 446 - &$profile: the profile being shown
 447
 448 StartProfilePageHomepage: before showing the homepage link on the profile page
 449 - $userprofile: UserProfile widget
 450 - &$profile: the profile being shown
 451
 452 EndProfilePageHomepage: after showing the homepage on the profile page
 453 - $userprofile: UserProfile widget
 454 - &$profile: the profile being shown
 455
 456 StartProfilePageBio: before showing the bio on the profile page
 457 - $userprofile: UserProfile widget
 458 - &$profile: the profile being shown
 459
 460 EndProfilePageBio: after showing the bio on the profile page
 461 - $userprofile: UserProfile widget
 462 - &$profile: the profile being shown
 463
 464 StartProfilePageProfileTags: before showing the tags on the profile page
 465 - $userprofile: UserProfile widget
 466 - &$profile: the profile being shown
 467
 468 EndProfilePageProfileTags: after showing the tags on the profile page
 469 - $userprofile: UserProfile widget
 470 - &$profile: the profile being shown
 471
 472 StartProfileList: when starting a list of profiles (before <ul>)
 473 - $profilelist: ProfileList widget, with $profile, $action, and $out
 474
 475 EndProfileList: when ending a list of profiles (after </ul>)
 476 - $profilelist: ProfileList widget
 477
 478 StartProfileListItem: when starting to show a profile list item
 479 - $item: ProfileListItem widget
 480
 481 EndProfileListItem: after showing a profile list item
 482 - $item: ProfileListItem widget
 483
 484 StartProfileListItemProfile: the profile data part of the item
 485 - $item: ProfileListItem widget
 486
 487 EndProfileListItemProfile: the profile data part of the item
 488 - $item: ProfileListItem widget
 489
 490 StartProfileListItemActions: the actions (buttons) for an item
 491 - $item: ProfileListItem widget
 492
 493 EndProfileListItemActions: the actions (buttons) for an item
 494 - $item: ProfileListItem widget
 495
 496 StartProfileListItemProfileElements: inside the <div>
 497 - $item: ProfileListItem widget
 498
 499 EndProfileListItemProfileElements: inside the <div>
 500 - $item: ProfileListItem widget
 501
 502 StartProfileListItemAvatar: Showing a profile list avatar
 503 - $item: ProfileListItem widget
 504
 505 EndProfileListItemAvatar: Showing a profile list avatar
 506 - $item: ProfileListItem widget
 507
 508 StartProfileListItemFullName: Showing the profile list full name
 509 - $item: ProfileListItem widget
 510
 511 EndProfileListItemFullName: Showing the profile list full name
 512 - $item: ProfileListItem widget
 513
 514 StartProfileListItemLocation: Showing the profile list location
 515 - $item: ProfileListItem widget
 516
 517 EndProfileListItemLocation: Showing the profile list location
 518 - $item: ProfileListItem widget
 519
 520 StartProfileListItemHomepage: Showing the profile list homepage
 521 - $item: ProfileListItem widget
 522
 523 EndProfileListItemHomepage: Showing the profile list homepage
 524 - $item: ProfileListItem widget
 525
 526 StartProfileListItemBio: Showing the profile list bio
 527 - $item: ProfileListItem widget
 528
 529 EndProfileListItemBio: Showing the profile list bio
 530 - $item: ProfileListItem widget
 531
 532 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 533 - $item: ProfileListItem widget
 534
 535 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 536 - $item: ProfileListItem widget
 537
 538 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 539 - $action: the current action
 540 - &$xrdsoutputter - XRDSOutputter object to write to
 541
 542 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 543 - $action: the current action
 544 - &$xrdsoutputter - XRDSOutputter object to write to
 545
 546 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 547 - $action: the current action
 548 - &$xrdsoutputter - XRDSOutputter object to write to
 549
 550 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 551 - $action: the current action
 552 - &$xrdsoutputter - XRDSOutputter object to write to
 553
 554 StartHostMetaLinks: Start /.well-known/host-meta links
 555 - &links: array containing the links elements to be written
 556
 557 EndHostMetaLinks: End /.well-known/host-meta links
 558 - &links: array containing the links elements to be written
 559
 560 StartCheckPassword: Check a username/password
 561 - $nickname: The nickname to check
 562 - $password: The password to check
 563 - &$authenticatedUser: set to User object if credentials match a user.
 564
 565 EndCheckPassword: After checking a username/password pair
 566 - $nickname: The nickname that was checked
 567 - $password: The password that was checked
 568 - $authenticatedUser: User object if credentials match a user, else null.
 569
 570 StartChangePassword: Before changing a password
 571 - $user: user
 572 - $oldpassword: the user's old password
 573 - $newpassword: the desired new password
 574
 575 EndChangePassword: After changing a password
 576 - $user: user
 577
 578 StartSetUser: Before setting the currently logged in user
 579 - $user: user
 580
 581 EndSetUser: After setting the currently logged in user
 582 - $user: user
 583
 584 StartSetApiUser: Before setting the current API user
 585 - $user: user
 586
 587 EndSetApiUser: After setting the current API user
 588 - $user: user
 589
 590 StartHasRole: Before determing if the a profile has a given role
 591 - $profile: profile in question
 592 - $name: name of the role in question
 593 - &$has_role: does this profile have the named role?
 594
 595 EndHasRole: Before determing if the a profile has a given role
 596 - $profile: profile in question
 597 - $name: name of the role in question
 598 - $has_role: does this profile have the named role?
 599
 600 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 601 - $user: User object
 602 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
 603
 604 GetUrlShorteners: Specify URL shorteners that are available for use
 605 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
 606
 607 StartShortenUrl: About to shorten a URL
 608 - $url: url to be shortened
 609 - $shortenerName: name of the requested shortener
 610 - &$shortenedUrl: short version of the url
 611
 612 EndShortenUrl: After a URL has been shortened
 613 - $url: url to be shortened
 614 - $shortenerName: name of the requested shortener
 615 - $shortenedUrl: short version of the url
 616
 617 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
 618 - $action
 619 - &$src
 620 - &$theme
 621 - &$media
 622
 623 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
 624 - $action
 625 - $src
 626 - $theme
 627 - $media
 628
 629 StartStyleElement: Before a <style...> element is written
 630 - $action
 631 - &$code
 632 - &$type
 633 - &$media
 634
 635 EndStyleElement: After a <style...> element is written
 636 - $action
 637 - $code
 638 - $type
 639 - $media
 640
 641 StartScriptElement: Before a <script...> element is written
 642 - $action
 643 - &$src
 644 - &$type
 645
 646 EndScriptElement: After a <script...> element is written
 647 - $action
 648 - $src
 649 - $type
 650
 651 StartInlineScriptElement: Before a <script...> element is written
 652 - $action
 653 - &$code
 654 - &$type
 655
 656 EndInlineScriptElement: After a <script...> element is written
 657 - $action
 658 - $code
 659 - $type
 660
 661 StartLog: Before writing to the logs
 662 - &$priority
 663 - &$msg
 664 - &$filename
 665
 666 EndLog: After writing to the logs
 667 - $priority
 668 - $msg
 669 - $filename
 670
 671 StartBlockProfile: when we're about to block
 672 - $user: the person doing the block
 673 - $profile: the person getting blocked, can be remote
 674
 675 EndBlockProfile: when a block has succeeded
 676 - $user: the person doing the block
 677 - $profile: the person blocked, can be remote
 678
 679 StartUnblockProfile: when we're about to unblock
 680 - $user: the person doing the unblock
 681 - $profile: the person getting unblocked, can be remote
 682
 683 EndUnblockProfile: when an unblock has succeeded
 684 - $user: the person doing the unblock
 685 - $profile: the person unblocked, can be remote
 686
 687 StartSubscribe: when a subscription is starting
 688 - $user: the person subscribing
 689 - $other: the person being subscribed to
 690
 691 EndSubscribe: when a subscription is finished
 692 - $user: the person subscribing
 693 - $other: the person being subscribed to
 694
 695 StartUnsubscribe: when an unsubscribe is starting
 696 - $user: the person unsubscribing
 697 - $other: the person being unsubscribed from
 698
 699 EndUnsubscribe: when an unsubscribe is done
 700 - $user: the person unsubscribing
 701 - $other: the person being unsubscribed to
 702
 703 StartJoinGroup: when a user is joining a group
 704 - $group: the group being joined
 705 - $user: the user joining
 706
 707 EndJoinGroup: when a user finishes joining a group
 708 - $group: the group being joined
 709 - $user: the user joining
 710
 711 StartLeaveGroup: when a user is leaving a group
 712 - $group: the group being left
 713 - $user: the user leaving
 714
 715 EndLeaveGroup: when a user has left a group
 716 - $group: the group being left
 717 - $user: the user leaving
 718
 719 StartShowContentLicense: Showing the default license for content
 720 - $action: the current action
 721
 722 EndShowContentLicense: Showing the default license for content
 723 - $action: the current action
 724
 725 GetImTransports: Get IM transports that are available
 726 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
 727
 728 NormalizeImScreenname: Normalize an IM screenname
 729 - $transport: transport the screenname is on
 730 - &$screenname: screenname to be normalized
 731
 732 ValidateImScreenname: Validate an IM screenname
 733 - $transport: transport the screenname is on
 734 - $screenname: screenname to be validated
 735 - $valid: is the screenname valid?
 736
 737 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
 738 - $transport: transport the screenname exists on
 739 - $screenname: screenname being confirmed
 740 - $code: confirmation code for confirmation URL
 741 - $user: user requesting the confirmation
 742
 743 StartUserRegister: When a new user is being registered
 744 - &$profile: new profile data (no ID)
 745 - &$user: new user account (no ID or URI)
 746
 747 EndUserRegister: When a new user has been registered
 748 - &$profile: new profile data
 749 - &$user: new user account
 750
 751 StartRobotsTxt: Before outputting the robots.txt page
 752 - &$action: RobotstxtAction being shown
 753
 754 EndRobotsTxt: After the default robots.txt page (good place for customization)
 755 - &$action: RobotstxtAction being shown
 756
 757 StartGetProfileUri: When determining the canonical URI for a given profile
 758 - $profile: the current profile
 759 - &$uri: the URI
 760
 761 EndGetProfileUri: After determining the canonical URI for a given profile
 762 - $profile: the current profile
 763 - &$uri: the URI
 764
 765 StartFavorNotice: Saving a notice as a favorite
 766 - $profile: profile of the person faving (can be remote!)
 767 - $notice: notice being faved
 768 - &$fave: Favor object; null to start off with, but feel free to override.
 769
 770 EndFavorNotice: After saving a notice as a favorite
 771 - $profile: profile of the person faving (can be remote!)
 772 - $notice: notice being faved
 773
 774 StartDisfavorNotice: Saving a notice as a favorite
 775 - $profile: profile of the person faving (can be remote!)
 776 - $notice: notice being faved
 777 - &$result: result of the disfavoring (if you override)
 778
 779 EndDisfavorNotice: After saving a notice as a favorite
 780 - $profile: profile of the person faving (can be remote!)
 781 - $notice: notice being faved
 782
 783 StartFindMentions: start finding mentions in a block of text
 784 - $sender: sender profile
 785 - $text: plain text version of the notice
 786 - &$mentions: mentions found so far. Array of arrays; each array
 787   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 788   'title' (title of the link), 'position' (position of the text to
 789   replace), 'text' (text to replace)
 790
 791 EndFindMentions: end finding mentions in a block of text
 792 - $sender: sender profile
 793 - $text: plain text version of the notice
 794 - &$mentions: mentions found so far. Array of arrays; each array
 795   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 796   'title' (title of the link), 'position' (position of the text to
 797   replace), 'text' (text to replace)
 798
 799 StartShowSubscriptionsContent: before showing the subscriptions content
 800 - $action: the current action
 801
 802 EndShowSubscriptionsContent: after showing the subscriptions content
 803 - $action: the current action
 804
 805 StartShowUserGroupsContent: before showing the user groups content
 806 - $action: the current action
 807
 808 EndShowUserGroupsContent: after showing the user groups content
 809 - $action: the current action
 810
 811 StartShowAllContent: before showing the all (you and friends) content
 812 - $action: the current action
 813
 814 EndShowAllContent: after showing the all (you and friends) content
 815 - $action: the current action
 816
 817 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
 818 - $action: the current action
 819
 820 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
 821 - $action: the current action
 822
 823 StartShowGroupsMiniList: at the start of groups mini list
 824 - $action: the current action
 825
 826 EndShowGroupsMiniList: at the end of groups mini list
 827 - $action: the current action
 828
 829 StartDeleteUserForm: starting the data in the form for deleting a user
 830 - $action: action being shown
 831 - $user: user being deleted
 832
 833 EndDeleteUserForm: Ending the data in the form for deleting a user
 834 - $action: action being shown
 835 - $user: user being deleted
 836
 837 StartDeleteUser: handling the post for deleting a user
 838 - $action: action being shown
 839 - $user: user being deleted
 840
 841 EndDeleteUser: handling the post for deleting a user
 842 - $action: action being shown
 843 - $user: user being deleted
 844
 845 StartActivityStart: starting the output for a notice activity <event>
 846 - &$notice: notice being output
 847 - &$xs: XMLStringer for output
 848 - &$attrs: <entry> attributes (mostly namespace declarations, if any)
 849
 850 EndActivityStart: end the opening tag for an activity <event>
 851 - &$notice: notice being output
 852 - &$xs: XMLStringer for output
 853 - $attrs: <entry> attributes (mostly namespace declarations, if any)
 854
 855 StartActivitySource: before outputting the <source> element for a notice activity
 856 - &$notice: notice being output
 857 - &$xs: XMLStringer for output
 858
 859 EndActivitySource: after outputting the <source> element for a notice activity
 860 - &$notice: notice being output
 861 - &$xs: XMLStringer for output
 862
 863 StartActivityTitle: before outputting notice activity title
 864 - &$notice: notice being output
 865 - &$xs: XMLStringer for output
 866 - &$title: title of the notice, mutable
 867
 868 EndActivityTitle: after outputting notice activity title
 869 - $notice: notice being output
 870 - &$xs: XMLStringer for output
 871 - $title: title of the notice
 872
 873 StartActivityAuthor: before outputting atom author
 874 - &$notice: notice being output
 875 - &$xs: XMLStringer for output
 876 - &$atomAuthor: string for XML representing atom author
 877
 878 EndActivityAuthor: after outputting atom author
 879 - &$notice: notice being output
 880 - &$xs: XMLStringer for output
 881 - &$atomAuthor: string for XML representing atom author
 882
 883 StartActivityActor: before outputting activity actor element for a notice activity entry
 884 - &$notice: notice being output
 885 - &$xs: XMLStringer for output
 886 - &$actor: string for XML representing activity actor
 887
 888 EndActivityActor: after outputting activity actor element for a notice activity entry
 889 - &$notice: notice being output
 890 - &$xs: XMLStringer for output
 891 - &$actor: string for XML representing activity actor
 892
 893 StartActivityLink: before outputting activity HTML link element for a notice activity entry
 894 - &$notice: notice being output
 895 - &$xs: XMLStringer for output
 896 - &$url: URL for activity HTML link element for a notice activity entry
 897
 898 EndActivityLink: before outputting activity HTML link element for a notice activity entry
 899 - &$notice: notice being output
 900 - &$xs: XMLStringer for output
 901 - $url:  URL for activity HTML link element for a notice activity entry
 902
 903 StartActivityId: before outputting atom:id element for a notice activity entry
 904 - &$notice: notice being output
 905 - &$xs: XMLStringer for output
 906 - &$id: atom:id (notice URI by default)
 907
 908 EndActivityId: after outputting atom:id element for a notice activity entry
 909 - &$notice: notice being output
 910 - &$xs: XMLStringer for output
 911 - $id:  atom:id (notice URI by default)
 912
 913 StartActivityPublished: before outputting atom:published element for a notice activity entry
 914 - &$notice: notice being output
 915 - &$xs: XMLStringer for output
 916 - &$published: atom:published value (notice created by default)
 917
 918 EndActivityPublished: before outputting atom:published element for a notice activity entry
 919 - &$notice: notice being output
 920 - &$xs: XMLStringer for output
 921 - $published:  atom:published value (notice created by default)
 922
 923 StartActivityUpdated: before outputting atom:updated element for a notice activity entry
 924 - &$notice: notice being output
 925 - &$xs: XMLStringer for output
 926 - &$updated: atom:updated value (same as atom:published by default)
 927
 928 EndActivityUpdated: after outputting atom:updated element for a notice activity entry
 929 - &$notice: notice being output
 930 - &$xs: XMLStringer for output
 931 - $updated: atom:updated value (same as atom:published by default)
 932
 933 StartActivityContent: before outputting atom:content element for a notice activity entry
 934 - &$notice: notice being output
 935 - &$xs: XMLStringer for output
 936 - &$content: atom:content value (notice rendered HTML by default)
 937
 938 EndActivityContent: after outputting atom:content element for a notice activity entry
 939 - &$notice: notice being output
 940 - &$xs: XMLStringer for output
 941 - $content: atom:content value (notice rendered HTML by default)
 942
 943 StartActivityVerb: before outputting activity:verb element for a notice activity entry
 944 - &$notice: notice being output
 945 - &$xs: XMLStringer for output
 946 - &$verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 947
 948 EndActivityVerb: after outputting activity:verb element for a notice activity entry
 949 - &$notice: notice being output
 950 - &$xs: XMLStringer for output
 951 - $verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 952
 953 StartActivityDefaultObjectType: before outputting activity:object-type element for a notice activity entry
 954 - &$notice: notice being output
 955 - &$xs: XMLStringer for output
 956 - &$type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 957
 958 EndActivityDefaultObjectType: after outputting activity:verb element for a notice activity entry
 959 - &$notice: notice being output
 960 - &$xs: XMLStringer for output
 961 - $type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 962
 963 StartActivityObjects: before outputting activity:object elements for a notice activity entry
 964 - &$notice: notice being output
 965 - &$xs: XMLStringer for output
 966 - &$objects: array of ActivityObject objects to output (empty by default)
 967
 968 EndActivityObjects: after outputting activity:object elements for a notice activity entry
 969 - &$notice: notice being output
 970 - &$xs: XMLStringer for output
 971 - $objects: array of ActivityObject objects to output (empty by default)
 972
 973 StartActivityNoticeInfo: before outputting statusnet:notice-info element for a notice activity entry
 974 - &$notice: notice being output
 975 - &$xs: XMLStringer for output
 976 - &$noticeInfoAttr: array of attributes for notice info element
 977
 978 EndActivityNoticeInfo: after outputting statusnet:notice-info element for a notice activity entry
 979 - &$notice: notice being output
 980 - &$xs: XMLStringer for output
 981 - $noticeInfoAttr: array of attributes for notice info element
 982
 983 StartActivityInReplyTo: before outputting thr:in-reply-to element for a notice activity entry
 984 - &$notice: notice being output
 985 - &$xs: XMLStringer for output
 986 - &$replyNotice: Notice object the main notice is in-reply-to
 987
 988 EndActivityInReplyTo: after outputting thr:in-reply-to element for a notice activity entry
 989 - &$notice: notice being output
 990 - &$xs: XMLStringer for output
 991 - $replyNotice: Notice object the main notice is in-reply-to
 992
 993 StartActivityConversation: before outputting ostatus:conversation link element for a notice activity entry
 994 - &$notice: notice being output
 995 - &$xs: XMLStringer for output
 996 - &$conv: Conversation object
 997
 998 EndActivityConversation: after outputting ostatus:conversation link element for a notice activity entry
 999 - &$notice: notice being output
1000 - &$xs: XMLStringer for output
1001 - $conv: Conversation object
1002
1003 StartActivityAttentionProfiles: before outputting ostatus:attention link element for people in a notice activity entry
1004 - &$notice: notice being output
1005 - &$xs: XMLStringer for output
1006 - &$replyProfiles: array of profiles of people being replied to
1007
1008 EndActivityAttentionProfiles: after outputting ostatus:attention link element for people in a notice activity entry
1009 - &$notice: notice being output
1010 - &$xs: XMLStringer for output
1011 - $replyProfiles: array of Profile object of people being replied to
1012
1013 StartActivityAttentionGroups: before outputting ostatus:attention link element for groups in a notice activity entry
1014 - &$notice: notice being output
1015 - &$xs: XMLStringer for output
1016 - &$groups: array of Group objects of groups being addressed
1017
1018 EndActivityAttentionGroups: after outputting ostatus:attention link element for groups in a notice activity entry
1019 - &$notice: notice being output
1020 - &$xs: XMLStringer for output
1021 - $groups: array of Group objects of groups being addressed
1022
1023 StartActivityForward: before outputting ostatus:forward link element in a notice activity entry
1024 - &$notice: notice being output
1025 - &$xs: XMLStringer for output
1026 - &$repeat: Notice that was repeated
1027
1028 EndActivityForward: after outputting ostatus:forward link element in a notice activity entry
1029 - &$notice: notice being output
1030 - &$xs: XMLStringer for output
1031 - $repeat: Notice that was repeated
1032
1033 StartActivityCategories: before outputting atom:category elements in a notice activity entry
1034 - &$notice: notice being output
1035 - &$xs: XMLStringer for output
1036 - &$tags: array of strings for tags on the notice (used for categories)
1037
1038 EndActivityCategories: after outputting atom:category elements in a notice activity entry
1039 - &$notice: notice being output
1040 - &$xs: XMLStringer for output
1041 - $tags: array of strings for tags on the notice (used for categories)
1042
1043 StartActivityEnclosures: before outputting enclosure link elements in a notice activity entry
1044 - &$notice: notice being output
1045 - &$xs: XMLStringer for output
1046 - &$enclosures: array of enclosure objects (see File::getEnclosure() for details)
1047
1048 EndActivityEnclosures: after outputting enclosure link elements in a notice activity entry
1049 - &$notice: notice being output
1050 - &$xs: XMLStringer for output
1051 - $enclosures: array of enclosure objects (see File::getEnclosure() for details)
1052
1053 StartActivityGeo: before outputting geo:rss element in a notice activity entry
1054 - &$notice: notice being output
1055 - &$xs: XMLStringer for output
1056 - &$lat: latitude
1057 - &$lon: longitude
1058
1059 EndActivityGeo: after outputting geo:rss element in a notice activity entry
1060 - &$notice: notice being output
1061 - &$xs: XMLStringer for output
1062 - $lat: latitude
1063 - $lon: longitude
1064
1065 StartActivityEnd: before the closing </entry> in a notice activity entry (last chance for data!)
1066 - &$notice: notice being output
1067 - &$xs: XMLStringer for output
1068
1069 EndActivityEnd: after the closing </entry> in a notice activity entry
1070 - &$notice: notice being output
1071 - &$xs: XMLStringer for output
1072
1073 StartNoticeSaveWeb: before saving a notice through the Web interface
1074 - $action: action being executed (instance of NewNoticeAction)
1075 - &$authorId: integer ID of the author
1076 - &$text: text of the notice
1077 - &$options: additional options (location, replies, etc.)
1078
1079 EndNoticeSaveWeb: after saving a notice through the Web interface
1080 - $action: action being executed (instance of NewNoticeAction)
1081 - $notice: notice that was saved
1082
1083 StartRssEntryArray: at the start of copying a notice to an array
1084 - $notice: the notice being copied
1085 - &$entry: the entry (empty at beginning)
1086
1087 EndRssEntryArray: at the end of copying a notice to an array
1088 - $notice: the notice being copied
1089 - &$entry: the entry, with all the fields filled up
1090
1091 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
1092 - $notice: notice being deleted
1093
1094 StartShowHeadTitle: when beginning to show the <title> element
1095 - $action: action being shown
1096
1097 EndShowHeadTitle: when done showing the <title>
1098 - $action: action being shown
1099
1100 StartShowPageTitle: when beginning to show the page title <h1>
1101 - $action: action being shown
1102
1103 EndShowPageTitle: when done showing the page title <h1>
1104 - $action: action being shown
1105
1106 StartDeleteOwnNotice: when a user starts to delete their own notice
1107 - $user: the user doing the delete
1108 - $notice: the notice being deleted
1109
1110 EndDeleteOwnNotice: when a user has deleted their own notice
1111 - $user: the user doing the delete
1112 - $notice: the notice being deleted