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 - $item: The NoticeListItem object being shown
 262
 263 EndShowNoticeItem: just after showing the notice item
 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 StartShowFaveForm: just before showing the fave form
 273 - $item: the NoticeListItem object being shown
 274
 275 EndShowFaveForm: just after showing the fave form
 276 - $item: the NoticeListItem object being shown
 277
 278 StartShowPageNotice: just before showing the page notice (instructions or error)
 279 - $action: action object being shown
 280
 281 EndShowPageNotice: just after showing the page notice (instructions or error)
 282 - $action: action object being shown
 283
 284 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 285 - $action: action object being shown
 286
 287 StartProfileFormData: just before showing text entry fields on profile settings page
 288 - $action: action object being shown
 289
 290 EndProfileFormData: just after showing text entry fields on profile settings page
 291 - $action: action object being shown
 292
 293 StartProfileSaveForm: before starting to save a profile settings form
 294 - $action: action object being shown
 295
 296 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 297 - $action: action object being shown
 298
 299 StartRegistrationFormData: just before showing text entry fields on registration page
 300 - $action: action object being shown
 301
 302 EndRegistrationFormData: just after showing text entry fields on registration page
 303 - $action: action object being shown
 304
 305 StartRegistrationTry: before validating and saving a new user
 306 - $action: action object being shown
 307
 308 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 309 - $action: action object being shown
 310
 311 StartAvatarFormData: before displaying avatar form
 312 - $action: action object being shown
 313
 314 EndAvatarFormData: after displaying avatar form
 315 - $action: action object being shown
 316
 317 StartAvatarSaveForm: before saving the avatar
 318 - $action: action object being shown
 319
 320 EndAvatarSaveForm: after saving the avatar
 321 - $action: action object being shown
 322
 323 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 324 - $qm: empty queue manager to set
 325
 326 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 327 - $action: action object being shown
 328 - $user: current user
 329
 330 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 331 - $title: title of the document
 332 - $output: HTML output to show
 333
 334 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 335 - $title: title of the document
 336 - $output: HTML output to show
 337
 338 StartApiRss: after the rss <channel> element is started
 339 - $action: action object being shown
 340
 341 StartApiAtom: after the <feed> element is started
 342 - $action: action object being shown
 343
 344 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 345 - $notice: the notice being added
 346 - &$transports: modifiable list of transports (as strings) to queue for
 347
 348 EndEnqueueNotice: after adding a notice to the queues
 349 - $notice: the notice being added
 350 - $transports: modifiable list of transports to use
 351
 352 UnqueueHandleNotice: Handle a notice when no queue manager is available
 353 - $notice: the notice to handle
 354 - $queue: the "queue" that is being executed
 355
 356 GetValidDaemons: Just before determining which daemons to run
 357 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 358
 359 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 360 - &$notice: notice to handle
 361
 362 StartShowHeadElements: Right after the <head> tag
 363 - $action: the current action
 364
 365 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 366 - $action: the current action
 367
 368 CheckSchema: chance to check the schema
 369
 370 StartProfileRemoteSubscribe: Before showing the link to remote subscription
 371 - $userprofile: UserProfile widget
 372 - &$profile: the profile being shown
 373
 374 EndProfileRemoteSubscribe: After showing the link to remote subscription
 375 - $userprofile: UserProfile widget
 376 - &$profile: the profile being shown
 377
 378 StartGroupSubscribe: Before showing the link to remote subscription
 379 - $action: the current action
 380 - $group: the group being shown
 381
 382 EndGroupSubscribe: After showing the link to remote subscription
 383 - $action: the current action
 384 - $group: the group being shown
 385
 386 StartProfilePageProfileSection: Starting to show the section of the
 387                               profile page with the actual profile data;
 388                               hook to prevent showing the profile (e.g.)
 389 - $userprofile: UserProfile widget
 390 - &$profile: the profile being shown
 391
 392 StartProfilePageProfileElements: inside the section, before the first
 393                                element; prepend elements here
 394 - $userprofile: UserProfile widget
 395 - &$profile: the profile being shown
 396
 397 EndProfilePageProfileElements: inside the section, after the last element;
 398                              append elements here
 399 - $userprofile: UserProfile widget
 400 - &$profile: the profile being shown
 401
 402 EndProfilePageProfileSection: After showing the section of the profile
 403                             page with the profile elements
 404 - $userprofile: UserProfile widget
 405 - &$profile: the profile being shown
 406
 407 StartProfilePageActionsSection: Starting to show the section of the
 408                                     profile page with action links; hook
 409                                     to hide them (for example)
 410 - $userprofile: UserProfile widget
 411 - &$profile: the profile being shown
 412
 413 StartProfilePageActionsElements: inside the list, before the first
 414                                      element; prepend elements here
 415 - $userprofile: UserProfile widget
 416 - &$profile: the profile being shown
 417
 418 EndProfilePageActionsElements: inside the list, after the last element;
 419                                    append elements here
 420 - $userprofile: UserProfile widget
 421 - &$profile: the profile being shown
 422
 423 EndProfilePageActionsSection: After showing the section of the profile
 424                                   page with the entity actions
 425 - $userprofile: UserProfile widget
 426 - &$profile: the profile being shown
 427
 428 StartProfilePageAvatar: before showing the avatar on the profile page
 429 - $userprofile: UserProfile widget
 430 - &$profile: the profile being shown
 431
 432 EndProfilePageAvatar: after showing the avatar on the profile page
 433 - $userprofile: UserProfile widget
 434 - &$profile: the profile being shown
 435
 436 StartProfilePageNickname: before showing the nickname on the profile page
 437 - $userprofile: UserProfile widget
 438 - &$profile: the profile being shown
 439
 440 EndProfilePageNickname: after showing the nickname on the profile page
 441 - $userprofile: UserProfile widget
 442 - &$profile: the profile being shown
 443
 444 StartProfilePageFullName: before showing the fullname on the profile page
 445 - $userprofile: UserProfile widget
 446 - &$profile: the profile being shown
 447
 448 EndProfilePageFullName: after showing the fullname on the profile page
 449 - $userprofile: UserProfile widget
 450 - &$profile: the profile being shown
 451
 452 StartProfilePageLocation: before showing the location on the profile page
 453 - $userprofile: UserProfile widget
 454 - &$profile: the profile being shown
 455
 456 EndProfilePageLocation: after showing the location on the profile page
 457 - $userprofile: UserProfile widget
 458 - &$profile: the profile being shown
 459
 460 StartProfilePageHomepage: before showing the homepage link on the profile page
 461 - $userprofile: UserProfile widget
 462 - &$profile: the profile being shown
 463
 464 EndProfilePageHomepage: after showing the homepage on the profile page
 465 - $userprofile: UserProfile widget
 466 - &$profile: the profile being shown
 467
 468 StartProfilePageBio: before showing the bio on the profile page
 469 - $userprofile: UserProfile widget
 470 - &$profile: the profile being shown
 471
 472 EndProfilePageBio: after showing the bio on the profile page
 473 - $userprofile: UserProfile widget
 474 - &$profile: the profile being shown
 475
 476 StartProfilePageProfileTags: before showing the tags on the profile page
 477 - $userprofile: UserProfile widget
 478 - &$profile: the profile being shown
 479
 480 EndProfilePageProfileTags: after showing the tags on the profile page
 481 - $userprofile: UserProfile widget
 482 - &$profile: the profile being shown
 483
 484 StartProfileList: when starting a list of profiles (before <ul>)
 485 - $profilelist: ProfileList widget, with $profile, $action, and $out
 486
 487 EndProfileList: when ending a list of profiles (after </ul>)
 488 - $profilelist: ProfileList widget
 489
 490 StartProfileListItem: when starting to show a profile list item
 491 - $item: ProfileListItem widget
 492
 493 EndProfileListItem: after showing a profile list item
 494 - $item: ProfileListItem widget
 495
 496 StartProfileListItemProfile: the profile data part of the item
 497 - $item: ProfileListItem widget
 498
 499 EndProfileListItemProfile: the profile data part of the item
 500 - $item: ProfileListItem widget
 501
 502 StartProfileListItemActions: the actions (buttons) for an item
 503 - $item: ProfileListItem widget
 504
 505 EndProfileListItemActions: the actions (buttons) for an item
 506 - $item: ProfileListItem widget
 507
 508 StartProfileListItemProfileElements: inside the <div>
 509 - $item: ProfileListItem widget
 510
 511 EndProfileListItemProfileElements: inside the <div>
 512 - $item: ProfileListItem widget
 513
 514 StartProfileListItemAvatar: Showing a profile list avatar
 515 - $item: ProfileListItem widget
 516
 517 EndProfileListItemAvatar: Showing a profile list avatar
 518 - $item: ProfileListItem widget
 519
 520 StartProfileListItemFullName: Showing the profile list full name
 521 - $item: ProfileListItem widget
 522
 523 EndProfileListItemFullName: Showing the profile list full name
 524 - $item: ProfileListItem widget
 525
 526 StartProfileListItemLocation: Showing the profile list location
 527 - $item: ProfileListItem widget
 528
 529 EndProfileListItemLocation: Showing the profile list location
 530 - $item: ProfileListItem widget
 531
 532 StartProfileListItemHomepage: Showing the profile list homepage
 533 - $item: ProfileListItem widget
 534
 535 EndProfileListItemHomepage: Showing the profile list homepage
 536 - $item: ProfileListItem widget
 537
 538 StartProfileListItemBio: Showing the profile list bio
 539 - $item: ProfileListItem widget
 540
 541 EndProfileListItemBio: Showing the profile list bio
 542 - $item: ProfileListItem widget
 543
 544 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 545 - $item: ProfileListItem widget
 546
 547 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 548 - $item: ProfileListItem widget
 549
 550 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 551 - $action: the current action
 552 - &$xrdsoutputter - XRDSOutputter object to write to
 553
 554 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 555 - $action: the current action
 556 - &$xrdsoutputter - XRDSOutputter object to write to
 557
 558 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 559 - $action: the current action
 560 - &$xrdsoutputter - XRDSOutputter object to write to
 561
 562 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 563 - $action: the current action
 564 - &$xrdsoutputter - XRDSOutputter object to write to
 565
 566 StartCheckPassword: Check a username/password
 567 - $nickname: The nickname to check
 568 - $password: The password to check
 569 - &$authenticatedUser: set to User object if credentials match a user.
 570
 571 EndCheckPassword: After checking a username/password pair
 572 - $nickname: The nickname that was checked
 573 - $password: The password that was checked
 574 - $authenticatedUser: User object if credentials match a user, else null.
 575
 576 StartChangePassword: Before changing a password
 577 - $user: user
 578 - $oldpassword: the user's old password
 579 - $newpassword: the desired new password
 580
 581 EndChangePassword: After changing a password
 582 - $user: user
 583
 584 StartSetUser: Before setting the currently logged in user
 585 - $user: user
 586
 587 EndSetUser: After setting the currently logged in user
 588 - $user: user
 589
 590 StartSetApiUser: Before setting the current API user
 591 - $user: user
 592
 593 EndSetApiUser: After setting the current API user
 594 - $user: user
 595
 596 StartHasRole: Before determing if the a profile has a given role
 597 - $profile: profile in question
 598 - $name: name of the role in question
 599 - &$has_role: does this profile have the named role?
 600
 601 EndHasRole: Before determing if the a profile has a given role
 602 - $profile: profile in question
 603 - $name: name of the role in question
 604 - $has_role: does this profile have the named role?
 605
 606 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 607 - $user: User object
 608 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
 609
 610 GetUrlShorteners: Specify URL shorteners that are available for use
 611 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
 612
 613 StartShortenUrl: About to shorten a URL
 614 - $url: url to be shortened
 615 - $shortenerName: name of the requested shortener
 616 - &$shortenedUrl: short version of the url
 617
 618 EndShortenUrl: After a URL has been shortened
 619 - $url: url to be shortened
 620 - $shortenerName: name of the requested shortener
 621 - $shortenedUrl: short version of the url
 622
 623 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
 624 - $action
 625 - &$src
 626 - &$theme
 627 - &$media
 628
 629 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
 630 - $action
 631 - $src
 632 - $theme
 633 - $media
 634
 635 StartStyleElement: Before a <style...> element is written
 636 - $action
 637 - &$code
 638 - &$type
 639 - &$media
 640
 641 EndStyleElement: After a <style...> element is written
 642 - $action
 643 - $code
 644 - $type
 645 - $media
 646
 647 StartScriptElement: Before a <script...> element is written
 648 - $action
 649 - &$src
 650 - &$type
 651
 652 EndScriptElement: After a <script...> element is written
 653 - $action
 654 - $src
 655 - $type
 656
 657 StartInlineScriptElement: Before a <script...> element is written
 658 - $action
 659 - &$code
 660 - &$type
 661
 662 EndInlineScriptElement: After a <script...> element is written
 663 - $action
 664 - $code
 665 - $type
 666
 667 StartLog: Before writing to the logs
 668 - &$priority
 669 - &$msg
 670 - &$filename
 671
 672 EndLog: After writing to the logs
 673 - $priority
 674 - $msg
 675 - $filename
 676
 677 StartBlockProfile: when we're about to block
 678 - $user: the person doing the block
 679 - $profile: the person getting blocked, can be remote
 680
 681 EndBlockProfile: when a block has succeeded
 682 - $user: the person doing the block
 683 - $profile: the person blocked, can be remote
 684
 685 StartUnblockProfile: when we're about to unblock
 686 - $user: the person doing the unblock
 687 - $profile: the person getting unblocked, can be remote
 688
 689 EndUnblockProfile: when an unblock has succeeded
 690 - $user: the person doing the unblock
 691 - $profile: the person unblocked, can be remote
 692
 693 StartSubscribe: when a subscription is starting
 694 - $user: the person subscribing
 695 - $other: the person being subscribed to
 696
 697 EndSubscribe: when a subscription is finished
 698 - $user: the person subscribing
 699 - $other: the person being subscribed to
 700
 701 StartUnsubscribe: when an unsubscribe is starting
 702 - $user: the person unsubscribing
 703 - $other: the person being unsubscribed from
 704
 705 EndUnsubscribe: when an unsubscribe is done
 706 - $user: the person unsubscribing
 707 - $other: the person being unsubscribed to
 708
 709 StartJoinGroup: when a user is joining a group
 710 - $group: the group being joined
 711 - $user: the user joining
 712
 713 EndJoinGroup: when a user finishes joining a group
 714 - $group: the group being joined
 715 - $user: the user joining
 716
 717 StartLeaveGroup: when a user is leaving a group
 718 - $group: the group being left
 719 - $user: the user leaving
 720
 721 EndLeaveGroup: when a user has left a group
 722 - $group: the group being left
 723 - $user: the user leaving
 724
 725 StartShowContentLicense: Showing the default license for content
 726 - $action: the current action
 727
 728 EndShowContentLicense: Showing the default license for content
 729 - $action: the current action
 730
 731 StartUserRegister: When a new user is being registered
 732 - &$profile: new profile data (no ID)
 733 - &$user: new user account (no ID or URI)
 734
 735 EndUserRegister: When a new user has been registered
 736 - &$profile: new profile data
 737 - &$user: new user account
 738
 739 StartRobotsTxt: Before outputting the robots.txt page
 740 - &$action: RobotstxtAction being shown
 741
 742 EndRobotsTxt: After the default robots.txt page (good place for customization)
 743 - &$action: RobotstxtAction being shown
 744
 745 StartGetProfileUri: When determining the canonical URI for a given profile
 746 - $profile: the current profile
 747 - &$uri: the URI
 748
 749 EndGetProfileUri: After determining the canonical URI for a given profile
 750 - $profile: the current profile
 751 - &$uri: the URI
 752
 753 StartFavorNotice: Saving a notice as a favorite
 754 - $profile: profile of the person faving (can be remote!)
 755 - $notice: notice being faved
 756 - &$fave: Favor object; null to start off with, but feel free to override.
 757
 758 EndFavorNotice: After saving a notice as a favorite
 759 - $profile: profile of the person faving (can be remote!)
 760 - $notice: notice being faved
 761
 762 StartDisfavorNotice: Saving a notice as a favorite
 763 - $profile: profile of the person faving (can be remote!)
 764 - $notice: notice being faved
 765 - &$result: result of the disfavoring (if you override)
 766
 767 EndDisfavorNotice: After saving a notice as a favorite
 768 - $profile: profile of the person faving (can be remote!)
 769 - $notice: notice being faved
 770
 771 StartFindMentions: start finding mentions in a block of text
 772 - $sender: sender profile
 773 - $text: plain text version of the notice
 774 - &$mentions: mentions found so far. Array of arrays; each array
 775   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 776   'title' (title of the link), 'position' (position of the text to
 777   replace), 'text' (text to replace)
 778
 779 EndFindMentions: end finding mentions in a block of text
 780 - $sender: sender profile
 781 - $text: plain text version of the notice
 782 - &$mentions: mentions found so far. Array of arrays; each array
 783   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 784   'title' (title of the link), 'position' (position of the text to
 785   replace), 'text' (text to replace)
 786
 787 StartShowSubscriptionsContent: before showing the subscriptions content
 788 - $action: the current action
 789
 790 EndShowSubscriptionsContent: after showing the subscriptions content
 791 - $action: the current action
 792
 793 StartShowUserGroupsContent: before showing the user groups content
 794 - $action: the current action
 795
 796 EndShowUserGroupsContent: after showing the user groups content
 797 - $action: the current action
 798
 799 StartShowAllContent: before showing the all (you and friends) content
 800 - $action: the current action
 801
 802 EndShowAllContent: after showing the all (you and friends) content
 803 - $action: the current action
 804
 805 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
 806 - $action: the current action
 807
 808 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
 809 - $action: the current action
 810
 811 StartShowGroupsMiniList: at the start of groups mini list
 812 - $action: the current action
 813
 814 EndShowGroupsMiniList: at the end of groups mini list
 815 - $action: the current action
 816
 817 StartDeleteUserForm: starting the data in the form for deleting a user
 818 - $action: action being shown
 819 - $user: user being deleted
 820
 821 EndDeleteUserForm: Ending the data in the form for deleting a user
 822 - $action: action being shown
 823 - $user: user being deleted
 824
 825 StartDeleteUser: handling the post for deleting a user
 826 - $action: action being shown
 827 - $user: user being deleted
 828
 829 EndDeleteUser: handling the post for deleting a user
 830 - $action: action being shown
 831 - $user: user being deleted
 832
 833 StartActivityStart: starting the output for a notice activity <event>
 834 - &$notice: notice being output
 835 - &$xs: XMLStringer for output
 836 - &$attrs: <entry> attributes (mostly namespace declarations, if any)
 837
 838 EndActivityStart: end the opening tag for an activity <event>
 839 - &$notice: notice being output
 840 - &$xs: XMLStringer for output
 841 - $attrs: <entry> attributes (mostly namespace declarations, if any)
 842
 843 StartActivitySource: before outputting the <source> element for a notice activity
 844 - &$notice: notice being output
 845 - &$xs: XMLStringer for output
 846
 847 EndActivitySource: after outputting the <source> element for a notice activity
 848 - &$notice: notice being output
 849 - &$xs: XMLStringer for output
 850
 851 StartActivityTitle: before outputting notice activity title
 852 - &$notice: notice being output
 853 - &$xs: XMLStringer for output
 854 - &$title: title of the notice, mutable
 855
 856 EndActivityTitle: after outputting notice activity title
 857 - $notice: notice being output
 858 - &$xs: XMLStringer for output
 859 - $title: title of the notice
 860
 861 StartActivityAuthor: before outputting atom author
 862 - &$notice: notice being output
 863 - &$xs: XMLStringer for output
 864 - &$atomAuthor: string for XML representing atom author
 865
 866 EndActivityAuthor: after outputting atom author
 867 - &$notice: notice being output
 868 - &$xs: XMLStringer for output
 869 - &$atomAuthor: string for XML representing atom author
 870
 871 StartActivityActor: before outputting activity actor element for a notice activity entry
 872 - &$notice: notice being output
 873 - &$xs: XMLStringer for output
 874 - &$actor: string for XML representing activity actor
 875
 876 EndActivityActor: after outputting activity actor element for a notice activity entry
 877 - &$notice: notice being output
 878 - &$xs: XMLStringer for output
 879 - &$actor: string for XML representing activity actor
 880
 881 StartActivityLink: before outputting activity HTML link element for a notice activity entry
 882 - &$notice: notice being output
 883 - &$xs: XMLStringer for output
 884 - &$url: URL for activity HTML link element for a notice activity entry
 885
 886 EndActivityLink: before outputting activity HTML link element for a notice activity entry
 887 - &$notice: notice being output
 888 - &$xs: XMLStringer for output
 889 - $url:  URL for activity HTML link element for a notice activity entry
 890
 891 StartActivityId: before outputting atom:id element for a notice activity entry
 892 - &$notice: notice being output
 893 - &$xs: XMLStringer for output
 894 - &$id: atom:id (notice URI by default)
 895
 896 EndActivityId: after outputting atom:id element for a notice activity entry
 897 - &$notice: notice being output
 898 - &$xs: XMLStringer for output
 899 - $id:  atom:id (notice URI by default)
 900
 901 StartActivityPublished: before outputting atom:published element for a notice activity entry
 902 - &$notice: notice being output
 903 - &$xs: XMLStringer for output
 904 - &$published: atom:published value (notice created by default)
 905
 906 EndActivityPublished: before outputting atom:published element for a notice activity entry
 907 - &$notice: notice being output
 908 - &$xs: XMLStringer for output
 909 - $published:  atom:published value (notice created by default)
 910
 911 StartActivityUpdated: before outputting atom:updated element for a notice activity entry
 912 - &$notice: notice being output
 913 - &$xs: XMLStringer for output
 914 - &$updated: atom:updated value (same as atom:published by default)
 915
 916 EndActivityUpdated: after outputting atom:updated element for a notice activity entry
 917 - &$notice: notice being output
 918 - &$xs: XMLStringer for output
 919 - $updated: atom:updated value (same as atom:published by default)
 920
 921 StartActivityContent: before outputting atom:content element for a notice activity entry
 922 - &$notice: notice being output
 923 - &$xs: XMLStringer for output
 924 - &$content: atom:content value (notice rendered HTML by default)
 925
 926 EndActivityContent: after outputting atom:content element for a notice activity entry
 927 - &$notice: notice being output
 928 - &$xs: XMLStringer for output
 929 - $content: atom:content value (notice rendered HTML by default)
 930
 931 StartActivityVerb: before outputting activity:verb element for a notice activity entry
 932 - &$notice: notice being output
 933 - &$xs: XMLStringer for output
 934 - &$verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 935
 936 EndActivityVerb: after outputting activity:verb element for a notice activity entry
 937 - &$notice: notice being output
 938 - &$xs: XMLStringer for output
 939 - $verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 940
 941 StartActivityDefaultObjectType: before outputting activity:object-type element for a notice activity entry
 942 - &$notice: notice being output
 943 - &$xs: XMLStringer for output
 944 - &$type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 945
 946 EndActivityDefaultObjectType: after outputting activity:verb element for a notice activity entry
 947 - &$notice: notice being output
 948 - &$xs: XMLStringer for output
 949 - $type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 950
 951 StartActivityObjects: before outputting activity:object elements for a notice activity entry
 952 - &$notice: notice being output
 953 - &$xs: XMLStringer for output
 954 - &$objects: array of ActivityObject objects to output (empty by default)
 955
 956 EndActivityObjects: after outputting activity:object elements for a notice activity entry
 957 - &$notice: notice being output
 958 - &$xs: XMLStringer for output
 959 - $objects: array of ActivityObject objects to output (empty by default)
 960
 961 StartActivityNoticeInfo: before outputting statusnet:notice-info element for a notice activity entry
 962 - &$notice: notice being output
 963 - &$xs: XMLStringer for output
 964 - &$noticeInfoAttr: array of attributes for notice info element
 965
 966 EndActivityNoticeInfo: after outputting statusnet:notice-info element for a notice activity entry
 967 - &$notice: notice being output
 968 - &$xs: XMLStringer for output
 969 - $noticeInfoAttr: array of attributes for notice info element
 970
 971 StartActivityInReplyTo: before outputting thr:in-reply-to element for a notice activity entry
 972 - &$notice: notice being output
 973 - &$xs: XMLStringer for output
 974 - &$replyNotice: Notice object the main notice is in-reply-to
 975
 976 EndActivityInReplyTo: after outputting thr:in-reply-to element for a notice activity entry
 977 - &$notice: notice being output
 978 - &$xs: XMLStringer for output
 979 - $replyNotice: Notice object the main notice is in-reply-to
 980
 981 StartActivityConversation: before outputting ostatus:conversation link element for a notice activity entry
 982 - &$notice: notice being output
 983 - &$xs: XMLStringer for output
 984 - &$conv: Conversation object
 985
 986 EndActivityConversation: after outputting ostatus:conversation link element for a notice activity entry
 987 - &$notice: notice being output
 988 - &$xs: XMLStringer for output
 989 - $conv: Conversation object
 990
 991 StartActivityAttentionProfiles: before outputting ostatus:attention link element for people in a notice activity entry
 992 - &$notice: notice being output
 993 - &$xs: XMLStringer for output
 994 - &$replyProfiles: array of profiles of people being replied to
 995
 996 EndActivityAttentionProfiles: after outputting ostatus:attention link element for people in a notice activity entry
 997 - &$notice: notice being output
 998 - &$xs: XMLStringer for output
 999 - $replyProfiles: array of Profile object of people being replied to
1000
1001 StartActivityAttentionGroups: before outputting ostatus:attention link element for groups in a notice activity entry
1002 - &$notice: notice being output
1003 - &$xs: XMLStringer for output
1004 - &$groups: array of Group objects of groups being addressed
1005
1006 EndActivityAttentionGroups: after outputting ostatus:attention link element for groups in a notice activity entry
1007 - &$notice: notice being output
1008 - &$xs: XMLStringer for output
1009 - $groups: array of Group objects of groups being addressed
1010
1011 StartActivityForward: before outputting ostatus:forward link element in a notice activity entry
1012 - &$notice: notice being output
1013 - &$xs: XMLStringer for output
1014 - &$repeat: Notice that was repeated
1015
1016 EndActivityForward: after outputting ostatus:forward link element in a notice activity entry
1017 - &$notice: notice being output
1018 - &$xs: XMLStringer for output
1019 - $repeat: Notice that was repeated
1020
1021 StartActivityCategories: before outputting atom:category elements in a notice activity entry
1022 - &$notice: notice being output
1023 - &$xs: XMLStringer for output
1024 - &$tags: array of strings for tags on the notice (used for categories)
1025
1026 EndActivityCategories: after outputting atom:category elements in a notice activity entry
1027 - &$notice: notice being output
1028 - &$xs: XMLStringer for output
1029 - $tags: array of strings for tags on the notice (used for categories)
1030
1031 StartActivityEnclosures: before outputting enclosure link elements in a notice activity entry
1032 - &$notice: notice being output
1033 - &$xs: XMLStringer for output
1034 - &$enclosures: array of enclosure objects (see File::getEnclosure() for details)
1035
1036 EndActivityEnclosures: after outputting enclosure link elements in a notice activity entry
1037 - &$notice: notice being output
1038 - &$xs: XMLStringer for output
1039 - $enclosures: array of enclosure objects (see File::getEnclosure() for details)
1040
1041 StartActivityGeo: before outputting geo:rss element in a notice activity entry
1042 - &$notice: notice being output
1043 - &$xs: XMLStringer for output
1044 - &$lat: latitude
1045 - &$lon: longitude
1046
1047 EndActivityGeo: after outputting geo:rss element in a notice activity entry
1048 - &$notice: notice being output
1049 - &$xs: XMLStringer for output
1050 - $lat: latitude
1051 - $lon: longitude
1052
1053 StartActivityEnd: before the closing </entry> in a notice activity entry (last chance for data!)
1054 - &$notice: notice being output
1055 - &$xs: XMLStringer for output
1056
1057 EndActivityEnd: after the closing </entry> in a notice activity entry
1058 - &$notice: notice being output
1059 - &$xs: XMLStringer for output
1060
1061 StartNoticeSaveWeb: before saving a notice through the Web interface
1062 - $action: action being executed (instance of NewNoticeAction)
1063 - &$authorId: integer ID of the author
1064 - &$text: text of the notice
1065 - &$options: additional options (location, replies, etc.)
1066
1067 EndNoticeSaveWeb: after saving a notice through the Web interface
1068 - $action: action being executed (instance of NewNoticeAction)
1069 - $notice: notice that was saved
1070
1071 StartRssEntryArray: at the start of copying a notice to an array
1072 - $notice: the notice being copied
1073 - &$entry: the entry (empty at beginning)
1074
1075 EndRssEntryArray: at the end of copying a notice to an array
1076 - $notice: the notice being copied
1077 - &$entry: the entry, with all the fields filled up
1078
1079 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
1080 - $notice: notice being deleted
1081
1082 StartShowHeadTitle: when beginning to show the <title> element
1083 - $action: action being shown
1084
1085 EndShowHeadTitle: when done showing the <title>
1086 - $action: action being shown
1087
1088 StartShowPageTitle: when beginning to show the page title <h1>
1089 - $action: action being shown
1090
1091 EndShowPageTitle: when done showing the page title <h1>
1092 - $action: action being shown
1093
1094 StartDeleteOwnNotice: when a user starts to delete their own notice
1095 - $user: the user doing the delete
1096 - $notice: the notice being deleted
1097
1098 EndDeleteOwnNotice: when a user has deleted their own notice
1099 - $user: the user doing the delete
1100 - $notice: the notice being deleted
1101
1102 StartShowFeedLinkList: before showing the feed list in the sidebar
1103 - $action: action being executed
1104 - $feeds: list of feeds to show
1105
1106 EndShowFeedLinkList: after showing the feed list in the sidebar
1107 - $action: action being executed
1108 - $feeds: list of feeds shown
1109
1110 StartShowFeedLink: before showing an individual feed item
1111 - $action: action being executed
1112 - $feed: feed to show
1113
1114 EndShowFeedLink: after showing an individual feed
1115 - $action: action being executed
1116 - $feed: feed to show