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