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