EVENTS.txt 54.8 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
StartActionExecute: Right before the "prepare" call of the current Action
- $action:  the current Action object
- &$args:   array of arguments, referenced so you can modify the array

EndActionExecute:   Right after the "handle" call of the current Action
- $action:      the current Action object

12 13 14 15 16 17 18 19 20 21 22
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
23

24 25 26 27 28 29
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

30
StartShowStylesheets: Showing stylesheet links
31 32
- $action: the current action

33
EndShowStylesheets: End showing stylesheet links;  good place to add handheld or JavaScript dependant styles
34 35
- $action: the current action

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

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

42 43 44
StartShowScripts: Showing JavaScript links
- $action: the current action

Bob Mottram's avatar
Bob Mottram committed
45
EndShowScripts: End showing JavaScript links; good place to add custom links
46 47
- $action: the current action

Bob Mottram's avatar
Bob Mottram committed
48
StartShowJQueryScripts: Showing JQuery script links
49 50 51 52 53
- $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 61 62 63 64
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
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

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

84 85 86 87 88 89
StartShowAside: Showing before the Aside container
- $action: the current action

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

90 91 92 93 94 95
StartShowNoticeFormData: Showing before the notice form data
- $action: the current action

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

96 97 98 99 100 101
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)

102 103 104 105 106 107
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action

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

108
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
109 110 111 112 113
- $action: the current action

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

114
StartPublicGroupNav: Showing the public group nav menu
115
- $menu: the menu widget; use $menu->action for output
116 117

EndPublicGroupNav: At the end of the public group nav menu
118
- $menu: the menu widget; use $menu->action for output
119

120
StartSubGroupNav: Showing the subscriptions group nav menu
121
- $menu: the menu widget; use $menu->action for output
122 123

EndSubGroupNav: At the end of the subscriptions group nav menu
124
- $menu: the menu widget; use $menu->action for output
125

126 127 128
StartInitializeRouter: Before the router instance has been initialized; good place to add routes
- $m: the Net_URL_Mapper that has just been set up

129 130 131
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up

132 133 134 135 136 137
StartLogout: Before logging out
- $action: the logout action

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

138
ArgsInitialize: After the argument array has been initialized
139
- $args: associative array of arguments, can be modified
140 141 142 143 144 145

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
146

147 148 149 150 151 152
StartShowSiteNotice: Before showing site notice
- $action: the current action

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

153 154 155 156 157
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
158 159 160 161 162 163

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

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

165 166 167 168 169 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
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

201 202
Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
203 204 205 206 207

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

208 209 210
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
211 212 213 214 215 216 217 218 219 220 221 222 223 224

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
225 226 227
- $menu: Menu list object being shown
- $target: Profile for whom it is shown
- $scoped: Profile of currently logged in user (or null)
228 229 230 231

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

232 233 234 235 236 237
StartGroupGroupNav: Showing the group nav menu
- $action: the current action

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

238 239 240 241 242 243
StartEndHTML: just before the </html> tag
- $action: action object being shown

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

244 245 246 247
FinalAction: After prepare() (and possible handle) in Action class.
- $status: result of "prepare" call on action
- $action: Action that is currently running

248 249 250 251 252 253 254 255 256 257 258 259
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
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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML
- $item: The NoticeListItem object being shown

EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML
- $item: The NoticeListItem object being shown

StartShowNoticeContent: just before outputting the content part of a Notice
- $stored: The Notice object
- $out: HTMLOutputter for writing to
- $scoped: optional Profile object for permission scoping

EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually
- $stored: The Notice object
- $out: HTMLOutputter for writing to
- $scoped: optional Profile object for permission scoping

282 283 284 285 286
StartShowNoticeInfo: just before showing notice info
- $item: The NoticeListItem object being shown

EndShowNoticeInfo: just after showing notice info
- $item: The NoticeListItem object being shown
287 288 289 290 291 292 293

StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
- $item: the NoticeListItem object being shown

EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
- $item: the NoticeListItem object being shown

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
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

315 316 317
StartEmailFormData: just before showing form input fields on email settings page
- $action: Action object being shown
- $scoped: Profile for whom settings are being configured
318

319
EndEmailFormData: just after showing form input fields on email settings page
320
- $action: action object being shown
321
- $scoped: Profile for whom settings are being configured
322 323 324

StartEmailSaveForm: before starting to save a email settings form
- $action: action object being shown
325
- $scoped: Profile user having their email settings saved
326 327 328

EndEmailSaveForm: after saving a email settings form (after commit)
- $action: action object being shown
329
- $scoped: Profile user having their email settings saved
330

331 332 333 334 335 336 337 338 339 340 341 342
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

343 344 345 346 347 348 349 350 351 352 353 354
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

355 356
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
- $qm: empty queue manager to set
357 358 359 360

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
361 362 363 364 365 366 367 368

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
369 370 371 372 373 374 375

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

376 377 378 379 380 381 382
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
383 384 385

UnqueueHandleNotice: Handle a notice when no queue manager is available
- $notice: the notice to handle
386 387 388 389
- $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/
390 391 392

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

394 395 396 397 398 399 400 401
StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
- $action: the current action
- &$attrs: attributes for the HTML element

EndHtmlElement: Right after outputting the HTML element
- $action: the current action
- &$attrs: attributes for the HTML element

402 403 404 405 406
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
407 408

CheckSchema: chance to check the schema
409

410 411 412 413 414 415 416 417
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

418 419 420 421 422 423 424 425
StartGroupSubscribe: Before showing the link to remote subscription
- $action: the current action
- $group: the group being shown

EndGroupSubscribe: After showing the link to remote subscription
- $action: the current action
- $group: the group being shown

426
StartProfilePageProfileSection: Starting to show the section of the
427 428
                              profile page with the actual profile data;
                              hook to prevent showing the profile (e.g.)
429
- $userprofile: UserProfile widget
430 431
- &$profile: the profile being shown

432
StartProfilePageProfileElements: inside the section, before the first
433
                               element; prepend elements here
434
- $userprofile: UserProfile widget
435 436
- &$profile: the profile being shown

437
EndProfilePageProfileElements: inside the section, after the last element;
438
                             append elements here
439
- $userprofile: UserProfile widget
440 441
- &$profile: the profile being shown

442
EndProfilePageProfileSection: After showing the section of the profile
443
                            page with the profile elements
444
- $userprofile: UserProfile widget
445 446
- &$profile: the profile being shown

447
StartProfilePageActionsSection: Starting to show the section of the
448 449
                                    profile page with action links; hook
                                    to hide them (for example)
450
- $userprofile: UserProfile widget
451 452
- &$profile: the profile being shown

453
StartProfilePageActionsElements: inside the list, before the first
454
                                     element; prepend elements here
455
- $userprofile: UserProfile widget
456 457
- &$profile: the profile being shown

458
EndProfilePageActionsElements: inside the list, after the last element;
459
                                   append elements here
460
- $userprofile: UserProfile widget
461 462
- &$profile: the profile being shown

463
EndProfilePageActionsSection: After showing the section of the profile
464
                                  page with the entity actions
465
- $userprofile: UserProfile widget
466
- &$profile: the profile being shown
467 468

StartProfilePageAvatar: before showing the avatar on the profile page
469
- $userprofile: UserProfile widget
470 471 472
- &$profile: the profile being shown

EndProfilePageAvatar: after showing the avatar on the profile page
473
- $userprofile: UserProfile widget
474 475 476
- &$profile: the profile being shown

StartProfilePageNickname: before showing the nickname on the profile page
477
- $userprofile: UserProfile widget
478 479 480
- &$profile: the profile being shown

EndProfilePageNickname: after showing the nickname on the profile page
481
- $userprofile: UserProfile widget
482 483 484
- &$profile: the profile being shown

StartProfilePageFullName: before showing the fullname on the profile page
485
- $userprofile: UserProfile widget
486 487 488
- &$profile: the profile being shown

EndProfilePageFullName: after showing the fullname on the profile page
489
- $userprofile: UserProfile widget
490 491 492
- &$profile: the profile being shown

StartProfilePageLocation: before showing the location on the profile page
493
- $userprofile: UserProfile widget
494 495 496
- &$profile: the profile being shown

EndProfilePageLocation: after showing the location on the profile page
497
- $userprofile: UserProfile widget
498 499 500
- &$profile: the profile being shown

StartProfilePageHomepage: before showing the homepage link on the profile page
501
- $userprofile: UserProfile widget
502 503 504
- &$profile: the profile being shown

EndProfilePageHomepage: after showing the homepage on the profile page
505
- $userprofile: UserProfile widget
506 507 508
- &$profile: the profile being shown

StartProfilePageBio: before showing the bio on the profile page
509
- $userprofile: UserProfile widget
510 511 512
- &$profile: the profile being shown

EndProfilePageBio: after showing the bio on the profile page
513
- $userprofile: UserProfile widget
514 515 516
- &$profile: the profile being shown

StartProfilePageProfileTags: before showing the tags on the profile page
517
- $userprofile: UserProfile widget
518 519 520
- &$profile: the profile being shown

EndProfilePageProfileTags: after showing the tags on the profile page
521
- $userprofile: UserProfile widget
522 523
- &$profile: the profile being shown

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
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
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604

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
605

606
StartCheckPassword: Check a username/password
607 608
- $nickname: The nickname to check
- $password: The password to check
609
- &$authenticatedUser: set to User object if credentials match a user.
610

611 612 613 614
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.
615

616
StartChangePassword: Before changing a password
617
- Profile $target: The profile of the User that is changing password
Craig Andrews's avatar
Craig Andrews committed
618 619
- $oldpassword: the user's old password
- $newpassword: the desired new password
620 621

EndChangePassword: After changing a password
622
- Profile $target: The profile of the User that just changed its password
Craig Andrews's avatar
Craig Andrews committed
623

624 625 626 627 628
StartHashPassword: Generate a hashed version of the password (like a salted crypt)
- &$hashed: Hashed version of the password, later put in the database
- $password: The password that should be hashed
- $profile: Profile that this password and hash belongs to. Can be null.

629 630 631 632 633 634 635
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
636
- &$user: user, can be set during event handling (return false to stop processing)
637 638

EndSetApiUser: After setting the current API user
639
- $user: user, only called if this is an actual user
640 641 642 643 644 645 646 647 648 649 650

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?

651 652 653
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.
654 655 656 657 658 659 660 661 662 663 664 665 666 667

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

668 669 670 671 672 673 674 675 676 677 678 679
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

680 681 682 683 684 685 686 687 688 689 690 691
StartStyleElement: Before a <style...> element is written
- $action
- &$code
- &$type
- &$media

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

692 693 694 695 696 697 698 699 700
StartScriptElement: Before a <script...> element is written
- $action
- &$src
- &$type

EndScriptElement: After a <script...> element is written
- $action
- $src
- $type
701 702 703 704 705 706 707 708 709 710

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

EndInlineScriptElement: After a <script...> element is written
- $action
- $code
- $type
711 712 713 714 715 716 717 718 719 720 721

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

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

722 723 724 725 726 727 728
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
729 730 731 732 733 734 735 736

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
737 738

StartSubscribe: when a subscription is starting
739 740
- $profile: Profile that is subscribing
- $other: Profile that is being subscribed to
741 742

EndSubscribe: when a subscription is finished
743 744
- $profile: Profile that is subscribing
- $other: Profile that is being subscribed to
745 746

StartUnsubscribe: when an unsubscribe is starting
747 748
- $profile: Profile that is unsubscribing
- $other: Profile that is being unsubscribed from
749 750

EndUnsubscribe: when an unsubscribe is done
751 752
- $profile: Profile that is unsubscribing
- $other: Profile that is being unsubscribed from
753 754 755

StartJoinGroup: when a user is joining a group
- $group: the group being joined
756
- $profile: the local or remote user joining
757 758 759

EndJoinGroup: when a user finishes joining a group
- $group: the group being joined
760
- $profile: the local or remote user joining
761 762 763

StartLeaveGroup: when a user is leaving a group
- $group: the group being left
764
- $profile: the local or remote user leaving
765 766 767

EndLeaveGroup: when a user has left a group
- $group: the group being left
768
- $profile: the local or remote user leaving
769 770 771 772 773 774

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

EndShowContentLicense: Showing the default license for content
- $action: the current action
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792

GetImTransports: Get IM transports that are available
- &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)

NormalizeImScreenname: Normalize an IM screenname
- $transport: transport the screenname is on
- &$screenname: screenname to be normalized

ValidateImScreenname: Validate an IM screenname
- $transport: transport the screenname is on
- $screenname: screenname to be validated
- $valid: is the screenname valid?

SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
- $transport: transport the screenname exists on
- $screenname: screenname being confirmed
- $code: confirmation code for confirmation URL
- $user: user requesting the confirmation
793

794
StartUserRegister: When a new user is being registered
795
- $profile: Profile object with new profile data (no ID yet)
796 797

EndUserRegister: When a new user has been registered
798
- $profile: Profile object with new profile data
799

800 801 802 803 804 805
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

806 807 808
StartGetProfileUri: When determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
809

810 811 812
EndGetProfileUri: After determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
813

814 815 816 817 818 819 820 821
StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
- $profile: Profile of user we want to get acct: URI for
- &$acct:   string with the resulting acct: uri

EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
- $profile: Profile of user we want to get acct: URI for
- &$acct:   string with the resulting acct: uri

822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
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)
837 838 839 840 841 842

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

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

844 845 846 847 848 849
StartShowUserGroupsContent: before showing the user groups content
- $action: the current action

EndShowUserGroupsContent: after showing the user groups content
- $action: the current action

850 851 852 853 854 855
StartShowAllContent: before showing the all (you and friends) content
- $action: the current action

EndShowAllContent: after showing the all (you and friends) content
- $action: the current action

856 857 858 859 860 861
StartShowSubscriptionsMiniList: at the start of subscriptions mini list
- $action: the current action

EndShowSubscriptionsMiniList: at the end of subscriptions mini list
- $action: the current action

862 863 864 865 866 867
StartShowGroupsMiniList: at the start of groups mini list
- $action: the current action

EndShowGroupsMiniList: at the end of groups mini list
- $action: the current action

868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
StartDeleteUserForm: starting the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted

EndDeleteUserForm: Ending the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted

StartDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted

EndDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted

884 885 886 887 888 889 890
StartNoticeAsActivity: before converting a notice to an activity
- $notice: notice being converted
- &$activity: initially empty activity

EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
- $notice: notice being converted
- &$activity: activity, now more-or-less full
891 892 893 894 895 896 897 898 899 900 901

StartNoticeSaveWeb: before saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- &$authorId: integer ID of the author
- &$text: text of the notice
- &$options: additional options (location, replies, etc.)

EndNoticeSaveWeb: after saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- $notice: notice that was saved

902 903 904 905 906 907 908 909
StartRssEntryArray: at the start of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry (empty at beginning)

EndRssEntryArray: at the end of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry, with all the fields filled up

Evan Prodromou's avatar
Evan Prodromou committed
910 911
NoticeDeleteRelated: at the beginning of deleting related fields to a notice
- $notice: notice being deleted
912

913 914 915
FileDeleteRelated: at the beginning of deleting related fields to a File
- $notice: File being deleted

916 917 918 919 920 921 922 923 924 925
StartShowHeadTitle: when beginning to show the <title> element
- $action: action being shown

EndShowHeadTitle: when done showing the <title>
- $action: action being shown

StartShowPageTitle: when beginning to show the page title <h1>
- $action: action being shown

EndShowPageTitle: when done showing the page title <h1>
926
- $action: action being shown
927 928 929 930 931 932 933 934

StartDeleteOwnNotice: when a user starts to delete their own notice
- $user: the user doing the delete
- $notice: the notice being deleted

EndDeleteOwnNotice: when a user has deleted their own notice
- $user: the user doing the delete
- $notice: the notice being deleted
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950

StartShowFeedLinkList: before showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds to show

EndShowFeedLinkList: after showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds shown

StartShowFeedLink: before showing an individual feed item
- $action: action being executed
- $feed: feed to show

EndShowFeedLink: after showing an individual feed
- $action: action being executed
- $feed: feed to show
951 952 953 954 955 956

StartShowNoticeForm: before showing the notice form (before <form>)
- $action: action being executed

EndShowNoticeForm: after showing the notice form (after <form>)
- $action: action being executed
957

958 959 960
StartShowEntryForms: microapp entry form tab data
- &$tabs: tab assoc array with 'tag' => (title, href to create new entry)

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
StartGrantRole: when a role is being assigned
- $profile: profile that will have the role
- $role: string name of the role

EndGrantRole: when a role has been successfully assigned
- $profile: profile that will have the role
- $role: string name of the role

StartRevokeRole: when a role is being revoked
- $profile: profile that will lose the role
- $role: string name of the role

EndRevokeRole: when a role has been revoked
- $profile: profile that lost the role
- $role: string name of the role
976 977 978

StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
- &$activity: received activity
979
- $profile: profile of the user publishing the entry
980
- &$notice: notice created; initially null, can be set
981 982 983

EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
- $activity: received activity
984
- $profile: profile of the user publishing the entry
985 986
- $notice: notice that was created

987 988 989 990 991 992 993 994 995
AdminPanelCheck: When checking whether the current user can access a given admin panel
- $name:  Name of the admin panel
- &$isOK: Boolean whether the user is allowed to use the panel

StartAdminPanelNav: Before displaying the first item in the list of admin panels
- $nav The AdminPanelNav widget

EndAdminPanelNav: After displaying the last item in the list of admin panels
- $nav The AdminPanelNav widget
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

StartActivityObjectFromNotice: When converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Fill this and return false to override defaults.

EndActivityObjectFromNotice: After converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Can be edited

StartActivityObjectFromProfile: When converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The (empty) object. Fill it up and return false to override defaults.

EndActivityObjectFromProfile: After converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The finished object. Can be tweaked

StartActivityObjectFromGroup: When converting a group to an activity:object
- $group: The group being converted
- &$object: The (empty) object. Fill and return false to override.

EndActivityObjectFromGroup:  After converting a group to an activity:object
- $group:  The group being converted
- &$object: The finished object. Tweak as needed.
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033

StartImportActivity: when we start to import an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is
- &$done: Return value; whether to continue

EndImportActivity: when we finish importing an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is

1034 1035 1036 1037 1038
StartProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)

EndProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050

StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
- $nli: The notice list item being shown

EndOpenNoticeListItemElement: After the opening <li> of a notice list element
- $nli: The notice list item being shown

StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
- $nli: The notice list item being shown

EndCloseNoticeListItemElement: After the closing </li> of a notice list element
- $nli: The notice list item being shown
1051 1052 1053 1054 1055 1056

StartGroupEditFormData: Beginning the group edit form entries
- $form: The form widget being shown

EndGroupEditFormData: Ending the group edit form entries
- $form: The form widget being shown
1057 1058 1059 1060 1061 1062

StartGroupSave: After initializing but before saving a group
- &$group: group about to be saved

EndGroupSave: After saving a group, aliases, and first member
- $group: group that was saved
Evan Prodromou's avatar
Evan Prodromou committed
1063 1064

StartInterpretCommand: Before running a command
1065
- $cmd: First word in the string, 'foo' in 'foo argument'
Evan Prodromou's avatar
Evan Prodromou committed
1066 1067 1068 1069 1070
- $arg: Argument, if any, like 'argument' in 'foo argument'
- $user: User who issued the command
- &$result: Resulting command; you can set this!

EndInterpretCommand: Before running a command
1071
- $cmd: First word in the string, 'foo' in 'foo argument'
Evan Prodromou's avatar
Evan Prodromou committed
1072 1073 1074 1075
- $arg: Argument, if any, like 'argument' in 'foo argument'
- $user: User who issued the command
- $result: Resulting command

1076 1077 1078 1079 1080 1081 1082 1083
StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
- $action: action being executed (for output and params)
- $group: group for the page

EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
- $action: action being executed (for output and params)
- $group: group for the page

1084 1085 1086
StartGroupProfileElements: Start showing stuff about the group on its profile page
- $action: action being executed (for output and params)
- $group: group for the page
1087

1088 1089 1090
EndGroupProfileElements: Start showing stuff about the group on its profile page
- $action: action being executed (for output and params)
- $group: group for the page
1091

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
StartShowProfileTagContent: When showing a people tag page
- $action: action being executed (for output and params)

EndShowProfileTagContent: After showing the contents of a people tag page
- $action: action being executed (for output and params)

StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
- $action: action being executed (for output and params)

EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
- $action: action being executed (for output and params)

StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
- $action: action being executed (for output and params)

EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
- $action: action being executed (for output and params)

StartTagProfileAction: When starting to show profile tagging page
- $action: action being executed (for output and params)
- $profile: profile being tagged

EndTagProfileAction: After showing profile tagging page
- $action: action being executed (for output and params)
- $profile: profile being tagged

StartProfileCompletionSearch: When starting a profile search for autocompletion
- $action: action being executed (for output and params)
- &$profile: result Profile objects
- $search_engine: the search engine

EndProfileCompletionSearch: After search results for profile autocompletion have been found
- $action: profilec completion action
- &$profile: current result Profile objects
- $search_engine: The search engine object

StartShowTagProfileForm: When showing people tagging form
- $action: action being executed (for output and params)
- $profile: profile being tagged

EndShowTagProfileForm: After showing people tagging form
- $action: action being executed (for output and params)
- $profile: profile being tagged

StartSavePeopletags: When starting to save people tags
- $action: action being executed (for output and params)
- $tagstring: string input, a list of tags

EndSavePeopletags: After saving people tags
- $action: action being executed (for output and params)
- $tagstring: string input, a list of tags

StartProfiletagGetUri: when generating the Uri for a people tag
- $profile_list: the people tag, a Profile_list object
- &$uri: the URI

EndProfiletagGetUri: after generating the uri for a people tag
- $profile_list: the people tag, a Profile_list object
- &$uri: the URI

StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL

EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL

StartProfiletagPermalink: when generating the permalink url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL

EndProfiletagPermalink: after generating the permalink url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL

StartTagProfile: when tagging a profile
- $tagger: profile tagging
- $tagged: profile being tagged
- $tag: the tag

EndTagProfile: after tagging a profile
- $newtag: the newly created Profile_tag object

StartUntagProfile: when deleting a people tag
- $ptag: the Profile_tag object being deleted

EndUntagProfile: after deleting a people tag
- $orig: a copy of the deleted Profile_tag object

StartSubscribePeopletag: when subscribing to a people tag
- $peopletag: Profile_list object being subscribed to
- $profile: subscriber's profile

EndSubscribePeopletag: after subscribing to a people tag
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
- $profile: subscriber's profile

StartUnsubscribePeopletag: when unsubscribing to a people tag
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
- $profile: subscriber's profile

EndUnsubscribePeopletag: after unsubscribing to a people tag
- $peopletag: Profile_list object being subscribed to
- $profile: subscriber's profile

StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
- $profile_list: the people tag, a Profile_list object
- &$object: activity object

EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
- $profile_list: the people tag, a Profile_list object
- &$object: activity object

StartPeopletagGroupNav: Showing the people tag nav menu
- $menu: the menu widget; use $menu->action for output

EndPeopletagGroupNav: after showing the people tag nav menu
- $menu: the menu widget; use $menu->action for output

StartShowPeopletagItem: when showing a people tag
- $widget: PeopletagListItem widget

EndShowPeopletagItem: after showing a people tag
- $widget: PeopletagListItem widget

StartSubscribePeopletagForm: when showing people tag subscription form
- $action: action being executed (for output and params)
- $peopletag: people tag being subscribed to

EndSubscribePeopletagForm: after showing the people tag subscription form
- $action: action being executed (for output and params)
- $peopletag: people tag being subscribed to

StartShowPeopletags: when showing a textual list of people tags
- $widget: PeopletagsWidget; use $widget->out for output
- $tagger: profile of the tagger
- $tagged: profile tagged

EndShowPeopletags: after showing a textual list of people tags
- $widget: PeopletagsWidget; use $widget->out for output
- $tagger: profile of the tagger
- $tagged: profile tagged

StartProfileListItemTags: when showing people tags in a profile list item widget
- $widget: ProfileListItem widget

EndProfileListItemTags: after showing people tags in a profile list item widget
- $widget: ProfileListItem widget
1241

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
- $obj: ActivityObject
- $out: XMLOutputter to append custom output

EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
- $obj: ActivityObject
- $out: XMLOutputter to append custom output

StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
- $obj ActivityObject
- &$out: array to be serialized; you're free to modify it

EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
- $obj ActivityObject
- &$out: array to be serialized; you're free to modify it
1257 1258 1259 1260 1261 1262 1263 1264

StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
- $notice Notice
- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc

EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here.  Be aware that output can be cached or used several times, so should remain idempotent.
- $notice Notice
- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1265 1266 1267 1268 1269 1270 1271 1272

StartDefaultLocalNav: When showing the default local nav
- $menu: the menu
- $user: current user

EndDefaultLocalNav: When showing the default local nav
- $menu: the menu
- $user: current user
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

StartShowAccountProfileBlock: When showing the profile block for an account
- $out: XMLOutputter to append custom output
- $profile: the profile being shown

EndShowAccountProfileBlock: After showing the profile block for an account
- $out: XMLOutputter to append custom output
- $profile: the profile being shown

StartShowGroupProfileBlock: When showing the profile block for a group
- $out: XMLOutputter to append custom output
- $profile: the profile being shown

1286
EndShowGroupProfileBlock: After showing the profile block for a group
1287
- $out: XMLOutputter to append custom output
1288 1289
- $group: the group being shown

1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
StartShowConversation: start the listing of a conversation
- $action: Action object (used mainly as HTMLOutputter)
- $conv: Conversation object, has functions to retrieve relevant notices
- $scoped: Profile for scoping (null if not logged in)

EndShowConversation: after the listing of a conversation
- $action: Action object (used mainly as HTMLOutputter)
- $conv: Conversation object, has functions to retrieve relevant notices
- $scoped: Profile for scoping (null if not logged in)

1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
StartShowThreadedNoticeTail: when showing the replies etc. to a notice
- $nli: parent noticelistitem
- $notice: parent notice
- &$children: list of children

EndShowThreadedNoticeTail: when showing the replies etc. to a notice
- $nli: parent noticelistitem
- $notice: parent notice
- $children: list of children

StartShowThreadedNoticeSub: when showing a reply to a notice
- $nli: parent noticelistitem
- $parent: parent notice
- $child: child notice

EndShowThreadedNoticeSub: when showing a reply to a notice
- $nli: parent noticelistitem
- $parent: parent notice
- $child: child notice
1319

1320 1321 1322 1323 1324 1325 1326 1327
StartAddEmailAddress: when adding an email address through the Web UI
- $user: user getting the new address
- $email: email being added

EndAddEmailAddress: done adding an email address through the Web UI
- $user: user getting the new address
- $email: email being added

1328 1329 1330 1331 1332 1333 1334 1335 1336
StartValidateEmailInvite: when validating an email address for invitations
- $user: user doing the invite
- $email: email address
- &$valid: flag for if it's valid; can be modified

EndValidateEmailInvite: after validating an email address for invitations
- $user: user doing the invite
- $email: email address
- &$valid: flag for if it's valid; can be modified
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351

StartLocalURL: before resolving a local url for an action
- &$action: action to find a path for
- &$paramsi: parameters to pass to the action
- &$fragment: any url fragement
- &$addSession: whether to add session variable
- &$url: resulting URL to local resource

EndLocalURL: before resolving a local url for an action
- &$action: action to find a path for
- &$paramsi: parameters to pass to the action
- &$fragment: any url fragement
- &$addSession: whether to add session variable
- &$url: resulting URL to local resource

1352 1353 1354 1355 1356 1357 1358 1359 1360
StartProfileGetAvatar: When getting an avatar for a profile
- $profile: profile
- $size: size of the avatar
- &$avatar: avatar

EndProfileGetAvatar: After getting an avatar for a profile
- $profile: profile
- $size: size of the avatar
- &$avatar: avatar
1361 1362 1363 1364 1365 1366

StartRegisterSuccess: Before showing the registration success message
- $action: the registration action

StartRegisterSuccess: After showing the registration success message
- $action: the registration action
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376

StartDocFileForTitle: Before searching for a doc or mail template
- $title: Title we're looking for
- &$paths: Paths we're searching
- &$filename: Filename so far (set this if you want)

EndDocFileForTitle: After searching for a doc or mail template
- $title: Title we looked for
- $paths: Paths we searched
- &$filename: Filename so far (set this if you want)
1377 1378 1379 1380 1381 1382 1383 1384 1385

StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
- &$tables: list of table names
- &$rwdb: read-write database URI

EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
- $tables: list of table names
- $rwdb: read-write database URI

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
StartShowInviteForm: Right before displaying the invitations form
- $action: invitation action

EndShowInviteForm: After displaying the invitations form
- $action: invitation action

StartSendInvitations: Right before sending invitations
- $action: invitation action

EndSendInvitations: Right after sending invitations
- $action: invitation action

StartShowInvitationSuccess: Right before showing invitations success msg
- $action: invitation action

EndShowInvitationSuccess: After showing invitations success msg
- $action: invitation action

Evan Prodromou's avatar
Evan Prodromou committed
1404 1405 1406 1407
StartUpgrade: when starting a site upgrade

EndUpgrade: when ending a site upgrade; good place to do your own upgrades

1408 1409 1410
HaveIMPlugin: is there an IM plugin loaded?
- &$haveIMPlugin: set me to true if you're loaded!

1411 1412 1413 1414 1415
StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
- $nli: NoticeListItem being shown

EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
- $nli: NoticeListItem being shown
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

StartNoticeInScope: Before checking if a notice should be visible to a user
- $notice: The notice to check
- $profile: The profile to check for scope
- &$bResult: The boolean result; fill this in if you want to skip

EndNoticeInScope: After checking if a notice should be visible to a user
- $notice: The notice to check
- $profile: The profile to check for scope
- &$bResult: The boolean result; overwrite this if you so desire

1427 1428 1429 1430 1431 1432
StartNoticeListPrefill: Before pre-filling a list of notices with extra data
- &$notices: Notices to be pre-filled
- $avatarSize: The avatar size for the list

EndNoticeListPrefill: After pre-filling a list of notices with extra data
- &$notices: Notices that were pre-filled
Bob Mottram's avatar
Bob Mottram committed
1433
- &$profiles: Profiles that were pre-filled
1434
- $avatarSize: The avatar size for the list
1435

1436 1437 1438 1439 1440 1441
OtherAccountProfiles: Hook to add account profiles to a user account profile block
- $profile: the Profile being shown
- &$others: Modifiable array of profile info arrays. Each one has the following fields:
            href: link to the profile
            text: text for the profile
            image: mini image for the profile
1442

1443
CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
1444
- $file:    'File' object to source the image from
1445 1446
- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
- $media:   MIME media type ('image', 'video', 'audio' etc.)
1447

1448 1449 1450 1451 1452
StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
- $imagefile: ImageFile object we're resizing.
- $outpath:   string with output filepath
- $box:       array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').

1453 1454 1455
FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file
- $imagefile    ImageFile object which we're getting metadata for (such as animated status, width/height etc.)

1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
- $out:     HTMLOutputter class to use for outputting HTML.
- $file:    'File' object which we're going to show representation for.

EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
- $out:     HTMLOutputter class to use for outputting HTML.
- $file:    'File' object which we're going to show representation for.

ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
- $out:     HTMLOutputter class to use for outputting HTML.
- $file:    'File' object which we're going to show representation for.
1467 1468 1469 1470 1471 1472 1473 1474

StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
- $stored:         Notice object that is being distributed.
- &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.

EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
- $stored:         Notice object that is being distributed.
- $mentioned_ids:  Array of profile IDs (not just for local users) who got mentioned by the notice.
buttle's avatar
buttle committed
1475 1476

StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
1477 1478
- $out:     HTMLOutputter used to output (usually an Action, but not always!)
- &$items:  Referenced array of items in the nav (add if desired)
buttle's avatar
buttle committed
1479 1480

EndHomeStubNavItems:
1481 1482
- $out:     HTMLOutputter used to output (usually an Action, but not always!)
- $items:   array of menu items
buttle's avatar
buttle committed
1483

1484
StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
mmn's avatar
mmn committed
1485 1486 1487 1488
- $out:     HTMLOutputter used to output (usually an Action, but not always!)
- $menu:    The Menu object outputted as a submenu.
- $label:   Localized text which represents the menu item.

1489
EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
mmn's avatar
mmn committed
1490 1491 1492
- $out:     HTMLOutputter used to output (usually an Action, but not always!)
- $menu:    The Menu object outputted as a submenu.
- $label:   Localized text which represents the menu item.
buttle's avatar
buttle committed
1493 1494 1495 1496 1497 1498

StartDocNav: Before outputting the docs Nav
- $nav: The DoclNav widget

EndDocNav: After outputting the docs Nav
- $nav: The DoclNav widget