EVENTS.txt 25.6 KB
Newer Older
1
InitializePlugin: a chance to initialize a plugin in a complete environment
2 3 4

CleanupPlugin: a chance to cleanup a plugin at the end of a program

5 6 7 8 9 10 11 12 13 14 15
StartPrimaryNav: Showing the primary nav menu
- $action: the current action

EndPrimaryNav: At the end of the primary nav menu
- $action: the current action

StartSecondaryNav: Showing the secondary nav menu
- $action: the current action

EndSecondaryNav: At the end of the secondary nav menu
- $action: the current action
16

17 18 19 20 21 22
StartShowStyles: Showing Style links; good place to add UA style resets
- $action: the current action

EndShowStyles: End showing Style links; good place to add custom styles
- $action: the current action

23
StartShowStatusNetStyles: Showing StatusNet Style links
24 25
- $action: the current action

26
EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
27 28
- $action: the current action

29 30 31 32
StartShowLaconicaStyles: backwards compatibility; deprecated
- $action: the current action

EndShowLaconicaStyles: backwards compatibility; deprecated
33 34
- $action: the current action

35
StartShowUAStyles: Showing custom User-Agent style links
36 37
- $action: the current action

38
EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
39 40
- $action: the current action

41 42 43 44 45 46 47 48 49 50 51 52 53
StartShowScripts: Showing JavaScript links
- $action: the current action

EndShowScripts: End showing JavaScript links; good place to add custom
		links like Google Analytics
- $action: the current action

StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
- $action: the current action

EndShowJQueryScripts: End showing JQuery script links
- $action: the current action

54
StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
55 56
- $action: the current action

57
EndShowStatusNetScripts: End showing StatusNet script links
58 59
- $action: the current action

60
StartShowLaconicaScripts: backwards compatibility; deprecated
61 62
- $action: the current action

63
EndShowLaconicaScripts: backwards compatibility; deprecated
64 65
- $action: the current action

66 67 68 69 70
StartShowSections: Start the list of sections in the sidebar
- $action: the current action

EndShowSections: End the list of sections in the sidebar
- $action: the current action
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

StartShowHeader: Showing before the header container
- $action: the current action

EndShowHeader: Showing after the header container
- $action: the current action

StartShowFooter: Showing before the footer container
- $action: the current action

EndShowFooter: Showing after the footer container
- $action: the current action

StartShowContentBlock: Showing before the content container
- $action: the current action

EndShowContentBlock: Showing after the content container
- $action: the current action

90 91 92 93 94 95
StartShowAside: Showing before the Aside container
- $action: the current action

EndShowAside: Showing after the Aside container
- $action: the current action

96 97 98 99 100 101
StartShowNoticeFormData: Showing before the notice form data
- $action: the current action

EndShowNoticeFormData: Showing after the notice form data
- $action: the current action

102 103 104 105 106 107
StartNoticeSave: before inserting a notice (good place for content filters)
- $notice: notice being saved (no ID or URI)

EndNoticeSave: after inserting a notice and related code
- $notice: notice that was saved (with ID and URI)

Sarven Capadisli's avatar
Sarven Capadisli committed
108 109 110 111 112 113
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action

EndShowLocalNavBlock: At the end of the local nav menu
- $action: the current action

114
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
115 116 117 118 119
- $action: the current action

EndShowHTML: Showing after the html element
- $action: the current action

120 121 122 123 124
StartPublicGroupNav: Showing the public group nav menu
- $action: the current action

EndPublicGroupNav: At the end of the public group nav menu
- $action: the current action
125

126 127 128 129 130 131
StartSubGroupNav: Showing the subscriptions group nav menu
- $action: the current action

EndSubGroupNav: At the end of the subscriptions group nav menu
- $action: the current action

132 133 134
StartInitializeRouter: Before the router instance has been initialized; good place to add routes
- $m: the Net_URL_Mapper that has just been set up

135 136 137
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up

138 139 140 141 142 143
StartLogout: Before logging out
- $action: the logout action

EndLogout: After logging out
- $action: the logout action

144 145
ArgsInitialized: After the argument array has been initialized
- $args: associative array of arguments, can be modified
146 147 148 149 150 151

StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
- $action: the current action

EndAddressData: At the end of <address>
- $action: the current action
152

153 154 155 156 157 158
StartShowSiteNotice: Before showing site notice
- $action: the current action

EndShowSiteNotice: After showing site notice
- $action: the current action

159 160 161 162 163
StartLoginGroupNav: Before showing the login and register navigation menu
- $action: the current action

EndLoginGroupNav: After showing the login and register navigation menu
- $action: the current action
164 165 166 167 168 169

StartAccountSettingsNav: Before showing the account settings menu
- $action: the current action

EndAccountSettingsNav: After showing the account settings menu
- $action: the current action
170

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsProfileMenuItem: After showing the Profile menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsPasswordMenuItem: After showing the Password menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsEmailMenuItem: Before showing the Email menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsEmailMenuItem: After showing the Email menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsDesignMenuItem: Before showing the Design menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsDesignMenuItem: After showing the Design menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsOtherMenuItem: Before showing the Other menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsOtherMenuItem: After showing the Other menu item
- $widget: AccountSettingsNav instance being shown

207 208
Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
209 210 211 212 213

SensitiveAction: determines if an action is 'sensitive' and should use SSL
- $action: name of the action, like 'login'
- $sensitive: flag for whether this is a sensitive action

214 215 216
LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
- $action: name of the action, like 'register'
- $login: flag for whether this is a login action
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

StartShowHead: called before showing the <head> element and children
- $action: action object being show

EndShowHead: called after showing the <head> element (and </head>)
- $action: action object being shown

StartShowBody: called before showing the <body> element and children
- $action: action object being shown

EndShowBody: called after showing the <body> element (and </body>)
- $action: action object being shown

StartPersonalGroupNav: beginning of personal group nav menu
- $action: action object being shown

EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
- $action: action object being shown

236 237 238 239 240 241
StartGroupGroupNav: Showing the group nav menu
- $action: the current action

EndGroupGroupNav: At the end of the group nav menu
- $action: the current action

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
StartEndHTML: just before the </html> tag
- $action: action object being shown

EndEndHTML: just after the </html> tag
- $action: action object being shown

StartShowDesign: just before showing a site, user, or group design
- $action: action object being shown

EndShowDesign: just after showing a site, user, or group design
- $action: action object being shown

StartShowExportData: just before showing the <div> with export data (feeds)
- $action: action object being shown

EndShowExportData: just after showing the <div> with export data (feeds)
- $action: action object being shown

260 261 262 263 264 265
StartShowNoticeItem: just before showing the notice item
- $action: action object being shown

EndShowNoticeItem: just after showing the notice item
- $action: action object being shown

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
StartShowPageNotice: just before showing the page notice (instructions or error)
- $action: action object being shown

EndShowPageNotice: just after showing the page notice (instructions or error)
- $action: action object being shown

StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
- $action: action object being shown

StartProfileFormData: just before showing text entry fields on profile settings page
- $action: action object being shown

EndProfileFormData: just after showing text entry fields on profile settings page
- $action: action object being shown

StartProfileSaveForm: before starting to save a profile settings form
- $action: action object being shown

EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
- $action: action object being shown

StartRegistrationFormData: just before showing text entry fields on registration page
- $action: action object being shown

EndRegistrationFormData: just after showing text entry fields on registration page
- $action: action object being shown

StartRegistrationTry: before validating and saving a new user
- $action: action object being shown

EndRegistrationTry: after saving a new user (note: no profile or user object!)
- $action: action object being shown

Eric Helgeson's avatar
Eric Helgeson committed
299 300 301 302 303 304 305 306 307 308 309 310
StartAvatarFormData: before displaying avatar form
- $action: action object being shown

EndAvatarFormData: after displaying avatar form
- $action: action object being shown

StartAvatarSaveForm: before saving the avatar
- $action: action object being shown

EndAvatarSaveForm: after saving the avatar
- $action: action object being shown

311 312
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
- $qm: empty queue manager to set
313 314 315 316

RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
- $action: action object being shown
- $user: current user
317 318 319 320 321 322 323 324

StartLoadDoc: before loading a help doc (hook this to show your own documentation)
- $title: title of the document
- $output: HTML output to show

EndLoadDoc: after loading a help doc (hook this to modify other documentation)
- $title: title of the document
- $output: HTML output to show
325 326 327 328 329 330 331

StartApiRss: after the rss <channel> element is started
- $action: action object being shown

StartApiAtom: after the <feed> element is started
- $action: action object being shown

332 333 334 335 336 337 338
StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
- $notice: the notice being added
- &$transports: modifiable list of transports (as strings) to queue for

EndEnqueueNotice: after adding a notice to the queues
- $notice: the notice being added
- $transports: modifiable list of transports to use
339 340 341

UnqueueHandleNotice: Handle a notice when no queue manager is available
- $notice: the notice to handle
342 343 344 345
- $queue: the "queue" that is being executed

GetValidDaemons: Just before determining which daemons to run
- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
346 347 348

HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
- &$notice: notice to handle
349

350 351 352 353 354
StartShowHeadElements: Right after the <head> tag
- $action: the current action

EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
- $action: the current action
Evan Prodromou's avatar
Evan Prodromou committed
355 356

CheckSchema: chance to check the schema
357

358 359 360 361 362 363 364 365
StartProfileRemoteSubscribe: Before showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown

EndProfileRemoteSubscribe: After showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown

366
StartProfilePageProfileSection: Starting to show the section of the
367 368
                              profile page with the actual profile data;
                              hook to prevent showing the profile (e.g.)
369
- $userprofile: UserProfile widget
370 371
- &$profile: the profile being shown

372
StartProfilePageProfileElements: inside the section, before the first
373
                               element; prepend elements here
374
- $userprofile: UserProfile widget
375 376
- &$profile: the profile being shown

377
EndProfilePageProfileElements: inside the section, after the last element;
378
                             append elements here
379
- $userprofile: UserProfile widget
380 381
- &$profile: the profile being shown

382
EndProfilePageProfileSection: After showing the section of the profile
383
                            page with the profile elements
384
- $userprofile: UserProfile widget
385 386
- &$profile: the profile being shown

387
StartProfilePageActionsSection: Starting to show the section of the
388 389
                                    profile page with action links; hook
                                    to hide them (for example)
390
- $userprofile: UserProfile widget
391 392
- &$profile: the profile being shown

393
StartProfilePageActionsElements: inside the list, before the first
394
                                     element; prepend elements here
395
- $userprofile: UserProfile widget
396 397
- &$profile: the profile being shown

398
EndProfilePageActionsElements: inside the list, after the last element;
399
                                   append elements here
400
- $userprofile: UserProfile widget
401 402
- &$profile: the profile being shown

403
EndProfilePageActionsSection: After showing the section of the profile
404
                                  page with the entity actions
405
- $userprofile: UserProfile widget
406
- &$profile: the profile being shown
407 408

StartProfilePageAvatar: before showing the avatar on the profile page
409
- $userprofile: UserProfile widget
410 411 412
- &$profile: the profile being shown

EndProfilePageAvatar: after showing the avatar on the profile page
413
- $userprofile: UserProfile widget
414 415 416
- &$profile: the profile being shown

StartProfilePageNickname: before showing the nickname on the profile page
417
- $userprofile: UserProfile widget
418 419 420
- &$profile: the profile being shown

EndProfilePageNickname: after showing the nickname on the profile page
421
- $userprofile: UserProfile widget
422 423 424
- &$profile: the profile being shown

StartProfilePageFullName: before showing the fullname on the profile page
425
- $userprofile: UserProfile widget
426 427 428
- &$profile: the profile being shown

EndProfilePageFullName: after showing the fullname on the profile page
429
- $userprofile: UserProfile widget
430 431 432
- &$profile: the profile being shown

StartProfilePageLocation: before showing the location on the profile page
433
- $userprofile: UserProfile widget
434 435 436
- &$profile: the profile being shown

EndProfilePageLocation: after showing the location on the profile page
437
- $userprofile: UserProfile widget
438 439 440
- &$profile: the profile being shown

StartProfilePageHomepage: before showing the homepage link on the profile page
441
- $userprofile: UserProfile widget
442 443 444
- &$profile: the profile being shown

EndProfilePageHomepage: after showing the homepage on the profile page
445
- $userprofile: UserProfile widget
446 447 448
- &$profile: the profile being shown

StartProfilePageBio: before showing the bio on the profile page
449
- $userprofile: UserProfile widget
450 451 452
- &$profile: the profile being shown

EndProfilePageBio: after showing the bio on the profile page
453
- $userprofile: UserProfile widget
454 455 456
- &$profile: the profile being shown

StartProfilePageProfileTags: before showing the tags on the profile page
457
- $userprofile: UserProfile widget
458 459 460
- &$profile: the profile being shown

EndProfilePageProfileTags: after showing the tags on the profile page
461
- $userprofile: UserProfile widget
462 463
- &$profile: the profile being shown

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
StartProfileList: when starting a list of profiles (before <ul>)
- $profilelist: ProfileList widget, with $profile, $action, and $out

EndProfileList: when ending a list of profiles (after </ul>)
- $profilelist: ProfileList widget

StartProfileListItem: when starting to show a profile list item
- $item: ProfileListItem widget

EndProfileListItem: after showing a profile list item
- $item: ProfileListItem widget

StartProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

EndProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

StartProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

EndProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

StartProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

EndProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

StartProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

EndProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

StartProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

EndProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

StartProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

EndProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

StartProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

EndProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

StartProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

EndProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
- $item: ProfileListItem widget

EndProfileListItemActionElements: Showing profile list actions (append a button here)
- $item: ProfileListItem widget
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndUserXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
Craig Andrews's avatar
Craig Andrews committed
545

546
StartCheckPassword: Check a username/password
Craig Andrews's avatar
Craig Andrews committed
547 548
- $nickname: The nickname to check
- $password: The password to check
549
- &$authenticatedUser: set to User object if credentials match a user.
Craig Andrews's avatar
Craig Andrews committed
550

551 552 553 554
EndCheckPassword: After checking a username/password pair
- $nickname: The nickname that was checked
- $password: The password that was checked
- $authenticatedUser: User object if credentials match a user, else null.
Craig Andrews's avatar
Craig Andrews committed
555

556
StartChangePassword: Before changing a password
557
- $user: user
Craig Andrews's avatar
Craig Andrews committed
558 559
- $oldpassword: the user's old password
- $newpassword: the desired new password
560 561

EndChangePassword: After changing a password
562
- $user: user
Craig Andrews's avatar
Craig Andrews committed
563

Craig Andrews's avatar
Craig Andrews committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
StartSetUser: Before setting the currently logged in user
- $user: user

EndSetUser: After setting the currently logged in user
- $user: user

StartSetApiUser: Before setting the current API user
- $user: user

EndSetApiUser: After setting the current API user
- $user: user

StartHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- &$has_role: does this profile have the named role?

EndHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- $has_role: does this profile have the named role?

586 587 588
UserDeleteRelated: Specify additional tables to delete entries from when deleting users
- $user: User object
- &$related: array of DB_DataObject class names to delete entries on matching user_id.
589 590 591 592 593 594 595 596 597 598 599 600 601 602

GetUrlShorteners: Specify URL shorteners that are available for use
- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)

StartShortenUrl: About to shorten a URL
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- &$shortenedUrl: short version of the url

EndShortenUrl: After a URL has been shortened
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- $shortenedUrl: short version of the url

603 604 605 606 607 608 609 610 611 612 613 614
StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
- $action
- &$src
- &$theme
- &$media

EndCssLinkElement: After a <link rel="stylesheet"..> element is written
- $action
- $src
- $theme
- $media

615 616 617 618 619 620 621 622 623 624 625 626
StartStyleElement: Before a <style...> element is written
- $action
- &$code
- &$type
- &$media

EndStyleElement: After a <style...> element is written
- $action
- $code
- $type
- $media

627 628 629 630 631 632 633 634 635
StartScriptElement: Before a <script...> element is written
- $action
- &$src
- &$type

EndScriptElement: After a <script...> element is written
- $action
- $src
- $type
636 637 638 639 640 641 642 643 644 645

StartInlineScriptElement: Before a <script...> element is written
- $action
- &$code
- &$type

EndInlineScriptElement: After a <script...> element is written
- $action
- $code
- $type
646 647 648 649 650 651 652 653 654 655 656

StartLog: Before writing to the logs
- &$priority
- &$msg
- &$filename

EndLog: After writing to the logs
- $priority
- $msg
- $filename

Evan Prodromou's avatar
Evan Prodromou committed
657 658 659 660 661 662 663
StartBlockProfile: when we're about to block
- $user: the person doing the block
- $profile: the person getting blocked, can be remote

EndBlockProfile: when a block has succeeded
- $user: the person doing the block
- $profile: the person blocked, can be remote
664 665 666 667 668 669 670 671

StartUnblockProfile: when we're about to unblock
- $user: the person doing the unblock
- $profile: the person getting unblocked, can be remote

EndUnblockProfile: when an unblock has succeeded
- $user: the person doing the unblock
- $profile: the person unblocked, can be remote
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703

StartSubscribe: when a subscription is starting
- $user: the person subscribing
- $other: the person being subscribed to

EndSubscribe: when a subscription is finished
- $user: the person subscribing
- $other: the person being subscribed to

StartUnsubscribe: when an unsubscribe is starting
- $user: the person unsubscribing
- $other: the person being unsubscribed from

EndUnsubscribe: when an unsubscribe is done
- $user: the person unsubscribing
- $other: the person being unsubscribed to

StartJoinGroup: when a user is joining a group
- $group: the group being joined
- $user: the user joining

EndJoinGroup: when a user finishes joining a group
- $group: the group being joined
- $user: the user joining

StartLeaveGroup: when a user is leaving a group
- $group: the group being left
- $user: the user leaving

EndLeaveGroup: when a user has left a group
- $group: the group being left
- $user: the user leaving
704 705 706 707 708 709

StartShowContentLicense: Showing the default license for content
- $action: the current action

EndShowContentLicense: Showing the default license for content
- $action: the current action
710 711 712 713 714 715 716 717 718

StartUserRegister: When a new user is being registered
- &$profile: new profile data (no ID)
- &$user: new user account (no ID or URI)

EndUserRegister: When a new user has been registered
- &$profile: new profile data
- &$user: new user account

719 720 721 722 723 724
StartRobotsTxt: Before outputting the robots.txt page
- &$action: RobotstxtAction being shown

EndRobotsTxt: After the default robots.txt page (good place for customization)
- &$action: RobotstxtAction being shown

Zach Copley's avatar
Zach Copley committed
725 726 727
StartGetProfileUri: When determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
728

Zach Copley's avatar
Zach Copley committed
729 730 731
EndGetProfileUri: After determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750

StartFavorNotice: Saving a notice as a favorite
- $profile: profile of the person faving (can be remote!)
- $notice: notice being faved
- &$fave: Favor object; null to start off with, but feel free to override.

EndFavorNotice: After saving a notice as a favorite
- $profile: profile of the person faving (can be remote!)
- $notice: notice being faved

StartDisfavorNotice: Saving a notice as a favorite
- $profile: profile of the person faving (can be remote!)
- $notice: notice being faved
- &$result: result of the disfavoring (if you override)

EndDisfavorNotice: After saving a notice as a favorite
- $profile: profile of the person faving (can be remote!)
- $notice: notice being faved

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
StartFindMentions: start finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
  has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  'title' (title of the link), 'position' (position of the text to
  replace), 'text' (text to replace)

EndFindMentions: end finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
  has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  'title' (title of the link), 'position' (position of the text to
  replace), 'text' (text to replace)
766 767 768 769 770 771

StartShowSubscriptionsContent: before showing the subscriptions content
- $action: the current action

EndShowSubscriptionsContent: after showing the subscriptions content
- $action: the current action