]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - EVENTS.txt
Use an Event to present notices conversations
[quix0rs-gnu-social.git] / EVENTS.txt
1 InitializePlugin: a chance to initialize a plugin in a complete environment
2
3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
4
5 StartPrimaryNav: Showing the primary nav menu
6 - $action: the current action
7
8 EndPrimaryNav: At the end of the primary nav menu
9 - $action: the current action
10
11 StartSecondaryNav: Showing the secondary nav menu
12 - $action: the current action
13
14 EndSecondaryNav: At the end of the secondary nav menu
15 - $action: the current action
16
17 StartShowStyles: Showing Style links; good place to add UA style resets
18 - $action: the current action
19
20 EndShowStyles: End showing Style links; good place to add custom styles
21 - $action: the current action
22
23 StartShowStylesheets: Showing stylesheet links
24 - $action: the current action
25
26 EndShowStylesheets: End showing stylesheet links;  good place to add handheld or JavaScript dependant styles
27 - $action: the current action
28
29 StartShowUAStyles: Showing custom User-Agent style links
30 - $action: the current action
31
32 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
33 - $action: the current action
34
35 StartShowScripts: Showing JavaScript links
36 - $action: the current action
37
38 EndShowScripts: End showing JavaScript links; good place to add custom
39                 links like Google Analytics
40 - $action: the current action
41
42 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
43 - $action: the current action
44
45 EndShowJQueryScripts: End showing JQuery script links
46 - $action: the current action
47
48 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
49 - $action: the current action
50
51 EndShowStatusNetScripts: End showing StatusNet script links
52 - $action: the current action
53
54 StartShowSections: Start the list of sections in the sidebar
55 - $action: the current action
56
57 EndShowSections: End the list of sections in the sidebar
58 - $action: the current action
59
60 StartShowHeader: Showing before the header container
61 - $action: the current action
62
63 EndShowHeader: Showing after the header container
64 - $action: the current action
65
66 StartShowFooter: Showing before the footer container
67 - $action: the current action
68
69 EndShowFooter: Showing after the footer container
70 - $action: the current action
71
72 StartShowContentBlock: Showing before the content container
73 - $action: the current action
74
75 EndShowContentBlock: Showing after the content container
76 - $action: the current action
77
78 StartShowAside: Showing before the Aside container
79 - $action: the current action
80
81 EndShowAside: Showing after the Aside container
82 - $action: the current action
83
84 StartShowNoticeFormData: Showing before the notice form data
85 - $action: the current action
86
87 EndShowNoticeFormData: Showing after the notice form data
88 - $action: the current action
89
90 StartNoticeSave: before inserting a notice (good place for content filters)
91 - $notice: notice being saved (no ID or URI)
92
93 EndNoticeSave: after inserting a notice and related code
94 - $notice: notice that was saved (with ID and URI)
95
96 StartShowLocalNavBlock: Showing the local nav menu
97 - $action: the current action
98
99 EndShowLocalNavBlock: At the end of the local nav menu
100 - $action: the current action
101
102 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
103 - $action: the current action
104
105 EndShowHTML: Showing after the html element
106 - $action: the current action
107
108 StartPublicGroupNav: Showing the public group nav menu
109 - $menu: the menu widget; use $menu->action for output
110
111 EndPublicGroupNav: At the end of the public group nav menu
112 - $menu: the menu widget; use $menu->action for output
113
114 StartSubGroupNav: Showing the subscriptions group nav menu
115 - $menu: the menu widget; use $menu->action for output
116
117 EndSubGroupNav: At the end of the subscriptions group nav menu
118 - $menu: the menu widget; use $menu->action for output
119
120 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
121 - $m: the Net_URL_Mapper that has just been set up
122
123 RouterInitialized: After the router instance has been initialized
124 - $m: the Net_URL_Mapper that has just been set up
125
126 StartLogout: Before logging out
127 - $action: the logout action
128
129 EndLogout: After logging out
130 - $action: the logout action
131
132 ArgsInitialize: After the argument array has been initialized
133 - $args: associative array of arguments, can be modified
134
135 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
136 - $action: the current action
137
138 EndAddressData: At the end of <address>
139 - $action: the current action
140
141 StartShowSiteNotice: Before showing site notice
142 - $action: the current action
143
144 EndShowSiteNotice: After showing site notice
145 - $action: the current action
146
147 StartLoginGroupNav: Before showing the login and register navigation menu
148 - $action: the current action
149
150 EndLoginGroupNav: After showing the login and register navigation menu
151 - $action: the current action
152
153 StartAccountSettingsNav: Before showing the account settings menu
154 - $action: the current action
155
156 EndAccountSettingsNav: After showing the account settings menu
157 - $action: the current action
158
159 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
160 - $widget: AccountSettingsNav instance being shown
161
162 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
163 - $widget: AccountSettingsNav instance being shown
164
165 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
166 - $widget: AccountSettingsNav instance being shown
167
168 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
169 - $widget: AccountSettingsNav instance being shown
170
171 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
172 - $widget: AccountSettingsNav instance being shown
173
174 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
175 - $widget: AccountSettingsNav instance being shown
176
177 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
178 - $widget: AccountSettingsNav instance being shown
179
180 EndAccountSettingsEmailMenuItem: After showing the Email menu item
181 - $widget: AccountSettingsNav instance being shown
182
183 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
184 - $widget: AccountSettingsNav instance being shown
185
186 EndAccountSettingsDesignMenuItem: After showing the Design menu item
187 - $widget: AccountSettingsNav instance being shown
188
189 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
190 - $widget: AccountSettingsNav instance being shown
191
192 EndAccountSettingsOtherMenuItem: After showing the Other menu item
193 - $widget: AccountSettingsNav instance being shown
194
195 Autoload: When trying to autoload a class
196 - $cls: the class being sought. A plugin might require_once the file for the class.
197
198 SensitiveAction: determines if an action is 'sensitive' and should use SSL
199 - $action: name of the action, like 'login'
200 - $sensitive: flag for whether this is a sensitive action
201
202 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
203 - $action: name of the action, like 'register'
204 - $login: flag for whether this is a login action
205
206 StartShowHead: called before showing the <head> element and children
207 - $action: action object being show
208
209 EndShowHead: called after showing the <head> element (and </head>)
210 - $action: action object being shown
211
212 StartShowBody: called before showing the <body> element and children
213 - $action: action object being shown
214
215 EndShowBody: called after showing the <body> element (and </body>)
216 - $action: action object being shown
217
218 StartPersonalGroupNav: beginning of personal group nav menu
219 - $action: action object being shown
220
221 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
222 - $action: action object being shown
223
224 StartGroupGroupNav: Showing the group nav menu
225 - $action: the current action
226
227 EndGroupGroupNav: At the end of the group nav menu
228 - $action: the current action
229
230 StartEndHTML: just before the </html> tag
231 - $action: action object being shown
232
233 EndEndHTML: just after the </html> tag
234 - $action: action object being shown
235
236 FinalAction: After prepare() (and possible handle) in Action class.
237 - $status: result of "prepare" call on action
238 - $action: Action that is currently running
239
240 StartShowDesign: just before showing a site, user, or group design
241 - $action: action object being shown
242
243 EndShowDesign: just after showing a site, user, or group design
244 - $action: action object being shown
245
246 StartShowExportData: just before showing the <div> with export data (feeds)
247 - $action: action object being shown
248
249 EndShowExportData: just after showing the <div> with export data (feeds)
250 - $action: action object being shown
251
252 StartShowNoticeItem: just before showing the notice item
253 - $item: The NoticeListItem object being shown
254
255 EndShowNoticeItem: just after showing the notice item
256 - $item: the NoticeListItem object being shown
257
258 StartShowNoticeInfo: just before showing notice info
259 - $item: The NoticeListItem object being shown
260
261 EndShowNoticeInfo: just after showing notice info
262 - $item: The NoticeListItem object being shown
263
264 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
265 - $item: the NoticeListItem object being shown
266
267 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
268 - $item: the NoticeListItem object being shown
269
270 StartShowFaveForm: just before showing the fave form
271 - $item: the NoticeListItem object being shown
272
273 EndShowFaveForm: just after showing the fave form
274 - $item: the NoticeListItem object being shown
275
276 StartShowPageNotice: just before showing the page notice (instructions or error)
277 - $action: action object being shown
278
279 EndShowPageNotice: just after showing the page notice (instructions or error)
280 - $action: action object being shown
281
282 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
283 - $action: action object being shown
284
285 StartProfileFormData: just before showing text entry fields on profile settings page
286 - $action: action object being shown
287
288 EndProfileFormData: just after showing text entry fields on profile settings page
289 - $action: action object being shown
290
291 StartProfileSaveForm: before starting to save a profile settings form
292 - $action: action object being shown
293
294 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
295 - $action: action object being shown
296
297 StartEmailFormData: just before showing text entry fields on email settings page
298 - $action: action object being shown
299
300 EndEmailFormData: just after showing text entry fields on email settings page
301 - $action: action object being shown
302
303 StartEmailSaveForm: before starting to save a email settings form
304 - $action: action object being shown
305 - &$user: user being saved
306
307 EndEmailSaveForm: after saving a email settings form (after commit)
308 - $action: action object being shown
309 - &$user: user being saved
310
311 StartRegistrationFormData: just before showing text entry fields on registration page
312 - $action: action object being shown
313
314 EndRegistrationFormData: just after showing text entry fields on registration page
315 - $action: action object being shown
316
317 StartRegistrationTry: before validating and saving a new user
318 - $action: action object being shown
319
320 EndRegistrationTry: after saving a new user (note: no profile or user object!)
321 - $action: action object being shown
322
323 StartAvatarFormData: before displaying avatar form
324 - $action: action object being shown
325
326 EndAvatarFormData: after displaying avatar form
327 - $action: action object being shown
328
329 StartAvatarSaveForm: before saving the avatar
330 - $action: action object being shown
331
332 EndAvatarSaveForm: after saving the avatar
333 - $action: action object being shown
334
335 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
336 - $qm: empty queue manager to set
337
338 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
339 - $action: action object being shown
340 - $user: current user
341
342 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
343 - $title: title of the document
344 - $output: HTML output to show
345
346 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
347 - $title: title of the document
348 - $output: HTML output to show
349
350 StartApiRss: after the rss <channel> element is started
351 - $action: action object being shown
352
353 StartApiAtom: after the <feed> element is started
354 - $action: action object being shown
355
356 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
357 - $notice: the notice being added
358 - &$transports: modifiable list of transports (as strings) to queue for
359
360 EndEnqueueNotice: after adding a notice to the queues
361 - $notice: the notice being added
362 - $transports: modifiable list of transports to use
363
364 UnqueueHandleNotice: Handle a notice when no queue manager is available
365 - $notice: the notice to handle
366 - $queue: the "queue" that is being executed
367
368 GetValidDaemons: Just before determining which daemons to run
369 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
370
371 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
372 - &$notice: notice to handle
373
374 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
375 - $action: the current action
376 - &$attrs: attributes for the HTML element
377
378 EndHtmlElement: Right after outputting the HTML element
379 - $action: the current action
380 - &$attrs: attributes for the HTML element
381
382 StartShowHeadElements: Right after the <head> tag
383 - $action: the current action
384
385 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
386 - $action: the current action
387
388 CheckSchema: chance to check the schema
389
390 StartProfileRemoteSubscribe: Before showing the link to remote subscription
391 - $userprofile: UserProfile widget
392 - &$profile: the profile being shown
393
394 EndProfileRemoteSubscribe: After showing the link to remote subscription
395 - $userprofile: UserProfile widget
396 - &$profile: the profile being shown
397
398 StartGroupSubscribe: Before showing the link to remote subscription
399 - $action: the current action
400 - $group: the group being shown
401
402 EndGroupSubscribe: After showing the link to remote subscription
403 - $action: the current action
404 - $group: the group being shown
405
406 StartProfilePageProfileSection: Starting to show the section of the
407                               profile page with the actual profile data;
408                               hook to prevent showing the profile (e.g.)
409 - $userprofile: UserProfile widget
410 - &$profile: the profile being shown
411
412 StartProfilePageProfileElements: inside the section, before the first
413                                element; prepend elements here
414 - $userprofile: UserProfile widget
415 - &$profile: the profile being shown
416
417 EndProfilePageProfileElements: inside the section, after the last element;
418                              append elements here
419 - $userprofile: UserProfile widget
420 - &$profile: the profile being shown
421
422 EndProfilePageProfileSection: After showing the section of the profile
423                             page with the profile elements
424 - $userprofile: UserProfile widget
425 - &$profile: the profile being shown
426
427 StartProfilePageActionsSection: Starting to show the section of the
428                                     profile page with action links; hook
429                                     to hide them (for example)
430 - $userprofile: UserProfile widget
431 - &$profile: the profile being shown
432
433 StartProfilePageActionsElements: inside the list, before the first
434                                      element; prepend elements here
435 - $userprofile: UserProfile widget
436 - &$profile: the profile being shown
437
438 EndProfilePageActionsElements: inside the list, after the last element;
439                                    append elements here
440 - $userprofile: UserProfile widget
441 - &$profile: the profile being shown
442
443 EndProfilePageActionsSection: After showing the section of the profile
444                                   page with the entity actions
445 - $userprofile: UserProfile widget
446 - &$profile: the profile being shown
447
448 StartProfilePageAvatar: before showing the avatar on the profile page
449 - $userprofile: UserProfile widget
450 - &$profile: the profile being shown
451
452 EndProfilePageAvatar: after showing the avatar on the profile page
453 - $userprofile: UserProfile widget
454 - &$profile: the profile being shown
455
456 StartProfilePageNickname: before showing the nickname on the profile page
457 - $userprofile: UserProfile widget
458 - &$profile: the profile being shown
459
460 EndProfilePageNickname: after showing the nickname on the profile page
461 - $userprofile: UserProfile widget
462 - &$profile: the profile being shown
463
464 StartProfilePageFullName: before showing the fullname on the profile page
465 - $userprofile: UserProfile widget
466 - &$profile: the profile being shown
467
468 EndProfilePageFullName: after showing the fullname on the profile page
469 - $userprofile: UserProfile widget
470 - &$profile: the profile being shown
471
472 StartProfilePageLocation: before showing the location on the profile page
473 - $userprofile: UserProfile widget
474 - &$profile: the profile being shown
475
476 EndProfilePageLocation: after showing the location on the profile page
477 - $userprofile: UserProfile widget
478 - &$profile: the profile being shown
479
480 StartProfilePageHomepage: before showing the homepage link on the profile page
481 - $userprofile: UserProfile widget
482 - &$profile: the profile being shown
483
484 EndProfilePageHomepage: after showing the homepage on the profile page
485 - $userprofile: UserProfile widget
486 - &$profile: the profile being shown
487
488 StartProfilePageBio: before showing the bio on the profile page
489 - $userprofile: UserProfile widget
490 - &$profile: the profile being shown
491
492 EndProfilePageBio: after showing the bio on the profile page
493 - $userprofile: UserProfile widget
494 - &$profile: the profile being shown
495
496 StartProfilePageProfileTags: before showing the tags on the profile page
497 - $userprofile: UserProfile widget
498 - &$profile: the profile being shown
499
500 EndProfilePageProfileTags: after showing the tags on the profile page
501 - $userprofile: UserProfile widget
502 - &$profile: the profile being shown
503
504 StartProfileList: when starting a list of profiles (before <ul>)
505 - $profilelist: ProfileList widget, with $profile, $action, and $out
506
507 EndProfileList: when ending a list of profiles (after </ul>)
508 - $profilelist: ProfileList widget
509
510 StartProfileListItem: when starting to show a profile list item
511 - $item: ProfileListItem widget
512
513 EndProfileListItem: after showing a profile list item
514 - $item: ProfileListItem widget
515
516 StartProfileListItemProfile: the profile data part of the item
517 - $item: ProfileListItem widget
518
519 EndProfileListItemProfile: the profile data part of the item
520 - $item: ProfileListItem widget
521
522 StartProfileListItemActions: the actions (buttons) for an item
523 - $item: ProfileListItem widget
524
525 EndProfileListItemActions: the actions (buttons) for an item
526 - $item: ProfileListItem widget
527
528 StartProfileListItemProfileElements: inside the <div>
529 - $item: ProfileListItem widget
530
531 EndProfileListItemProfileElements: inside the <div>
532 - $item: ProfileListItem widget
533
534 StartProfileListItemAvatar: Showing a profile list avatar
535 - $item: ProfileListItem widget
536
537 EndProfileListItemAvatar: Showing a profile list avatar
538 - $item: ProfileListItem widget
539
540 StartProfileListItemFullName: Showing the profile list full name
541 - $item: ProfileListItem widget
542
543 EndProfileListItemFullName: Showing the profile list full name
544 - $item: ProfileListItem widget
545
546 StartProfileListItemLocation: Showing the profile list location
547 - $item: ProfileListItem widget
548
549 EndProfileListItemLocation: Showing the profile list location
550 - $item: ProfileListItem widget
551
552 StartProfileListItemHomepage: Showing the profile list homepage
553 - $item: ProfileListItem widget
554
555 EndProfileListItemHomepage: Showing the profile list homepage
556 - $item: ProfileListItem widget
557
558 StartProfileListItemBio: Showing the profile list bio
559 - $item: ProfileListItem widget
560
561 EndProfileListItemBio: Showing the profile list bio
562 - $item: ProfileListItem widget
563
564 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
565 - $item: ProfileListItem widget
566
567 EndProfileListItemActionElements: Showing profile list actions (append a button here)
568 - $item: ProfileListItem widget
569
570 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
571 - $action: the current action
572 - &$xrdsoutputter - XRDSOutputter object to write to
573
574 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
575 - $action: the current action
576 - &$xrdsoutputter - XRDSOutputter object to write to
577
578 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
579 - $action: the current action
580 - &$xrdsoutputter - XRDSOutputter object to write to
581
582 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
583 - $action: the current action
584 - &$xrdsoutputter - XRDSOutputter object to write to
585
586 StartCheckPassword: Check a username/password
587 - $nickname: The nickname to check
588 - $password: The password to check
589 - &$authenticatedUser: set to User object if credentials match a user.
590
591 EndCheckPassword: After checking a username/password pair
592 - $nickname: The nickname that was checked
593 - $password: The password that was checked
594 - $authenticatedUser: User object if credentials match a user, else null.
595
596 StartChangePassword: Before changing a password
597 - $user: user
598 - $oldpassword: the user's old password
599 - $newpassword: the desired new password
600
601 EndChangePassword: After changing a password
602 - $user: user
603
604 StartHashPassword: Generate a hashed version of the password (like a salted crypt)
605 - &$hashed: Hashed version of the password, later put in the database
606 - $password: The password that should be hashed
607 - $profile: Profile that this password and hash belongs to. Can be null.
608
609 StartSetUser: Before setting the currently logged in user
610 - $user: user
611
612 EndSetUser: After setting the currently logged in user
613 - $user: user
614
615 StartSetApiUser: Before setting the current API user
616 - $user: user
617
618 EndSetApiUser: After setting the current API user
619 - $user: user
620
621 StartHasRole: Before determing if the a profile has a given role
622 - $profile: profile in question
623 - $name: name of the role in question
624 - &$has_role: does this profile have the named role?
625
626 EndHasRole: Before determing if the a profile has a given role
627 - $profile: profile in question
628 - $name: name of the role in question
629 - $has_role: does this profile have the named role?
630
631 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
632 - $user: User object
633 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
634
635 GetUrlShorteners: Specify URL shorteners that are available for use
636 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
637
638 StartShortenUrl: About to shorten a URL
639 - $url: url to be shortened
640 - $shortenerName: name of the requested shortener
641 - &$shortenedUrl: short version of the url
642
643 EndShortenUrl: After a URL has been shortened
644 - $url: url to be shortened
645 - $shortenerName: name of the requested shortener
646 - $shortenedUrl: short version of the url
647
648 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
649 - $action
650 - &$src
651 - &$theme
652 - &$media
653
654 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
655 - $action
656 - $src
657 - $theme
658 - $media
659
660 StartStyleElement: Before a <style...> element is written
661 - $action
662 - &$code
663 - &$type
664 - &$media
665
666 EndStyleElement: After a <style...> element is written
667 - $action
668 - $code
669 - $type
670 - $media
671
672 StartScriptElement: Before a <script...> element is written
673 - $action
674 - &$src
675 - &$type
676
677 EndScriptElement: After a <script...> element is written
678 - $action
679 - $src
680 - $type
681
682 StartInlineScriptElement: Before a <script...> element is written
683 - $action
684 - &$code
685 - &$type
686
687 EndInlineScriptElement: After a <script...> element is written
688 - $action
689 - $code
690 - $type
691
692 StartLog: Before writing to the logs
693 - &$priority
694 - &$msg
695 - &$filename
696
697 EndLog: After writing to the logs
698 - $priority
699 - $msg
700 - $filename
701
702 StartBlockProfile: when we're about to block
703 - $user: the person doing the block
704 - $profile: the person getting blocked, can be remote
705
706 EndBlockProfile: when a block has succeeded
707 - $user: the person doing the block
708 - $profile: the person blocked, can be remote
709
710 StartUnblockProfile: when we're about to unblock
711 - $user: the person doing the unblock
712 - $profile: the person getting unblocked, can be remote
713
714 EndUnblockProfile: when an unblock has succeeded
715 - $user: the person doing the unblock
716 - $profile: the person unblocked, can be remote
717
718 StartSubscribe: when a subscription is starting
719 - $profile: Profile that is subscribing
720 - $other: Profile that is being subscribed to
721
722 EndSubscribe: when a subscription is finished
723 - $profile: Profile that is subscribing
724 - $other: Profile that is being subscribed to
725
726 StartUnsubscribe: when an unsubscribe is starting
727 - $profile: Profile that is unsubscribing
728 - $other: Profile that is being unsubscribed from
729
730 EndUnsubscribe: when an unsubscribe is done
731 - $profile: Profile that is unsubscribing
732 - $other: Profile that is being unsubscribed from
733
734 StartJoinGroup: when a user is joining a group
735 - $group: the group being joined
736 - $profile: the local or remote user joining
737
738 EndJoinGroup: when a user finishes joining a group
739 - $group: the group being joined
740 - $profile: the local or remote user joining
741
742 StartLeaveGroup: when a user is leaving a group
743 - $group: the group being left
744 - $profile: the local or remote user leaving
745
746 EndLeaveGroup: when a user has left a group
747 - $group: the group being left
748 - $profile: the local or remote user leaving
749
750 StartShowContentLicense: Showing the default license for content
751 - $action: the current action
752
753 EndShowContentLicense: Showing the default license for content
754 - $action: the current action
755
756 GetImTransports: Get IM transports that are available
757 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
758
759 NormalizeImScreenname: Normalize an IM screenname
760 - $transport: transport the screenname is on
761 - &$screenname: screenname to be normalized
762
763 ValidateImScreenname: Validate an IM screenname
764 - $transport: transport the screenname is on
765 - $screenname: screenname to be validated
766 - $valid: is the screenname valid?
767
768 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
769 - $transport: transport the screenname exists on
770 - $screenname: screenname being confirmed
771 - $code: confirmation code for confirmation URL
772 - $user: user requesting the confirmation
773
774 StartUserRegister: When a new user is being registered
775 - $profile: Profile object with new profile data (no ID yet)
776
777 EndUserRegister: When a new user has been registered
778 - $profile: Profile object with new profile data
779
780 StartRobotsTxt: Before outputting the robots.txt page
781 - &$action: RobotstxtAction being shown
782
783 EndRobotsTxt: After the default robots.txt page (good place for customization)
784 - &$action: RobotstxtAction being shown
785
786 StartGetProfileUri: When determining the canonical URI for a given profile
787 - $profile: the current profile
788 - &$uri: the URI
789
790 EndGetProfileUri: After determining the canonical URI for a given profile
791 - $profile: the current profile
792 - &$uri: the URI
793
794 StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
795 - $profile: Profile of user we want to get acct: URI for
796 - &$acct:   string with the resulting acct: uri
797
798 EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
799 - $profile: Profile of user we want to get acct: URI for
800 - &$acct:   string with the resulting acct: uri
801
802 StartFavorNotice: Saving a notice as a favorite
803 - $profile: profile of the person faving (can be remote!)
804 - $notice: notice being faved
805 - &$fave: Favor object; null to start off with, but feel free to override.
806
807 EndFavorNotice: After saving a notice as a favorite
808 - $profile: profile of the person faving (can be remote!)
809 - $notice: notice being faved
810
811 StartDisfavorNotice: Saving a notice as a favorite
812 - $profile: profile of the person faving (can be remote!)
813 - $notice: notice being faved
814 - &$result: result of the disfavoring (if you override)
815
816 EndDisfavorNotice: After saving a notice as a favorite
817 - $profile: profile of the person faving (can be remote!)
818 - $notice: notice being faved
819
820 StartFavorNoticeForm: starting the data in the form for favoring a notice
821 - $FavorForm: the favor form being shown
822 - $notice: notice being favored
823
824 EndFavorNoticeForm: Ending the data in the form for favoring a notice
825 - $FavorForm: the favor form being shown
826 - $notice: notice being favored
827
828 StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
829 - $DisfavorForm: the disfavor form being shown
830 - $notice: notice being difavored
831
832 EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
833 - $DisfavorForm: the disfavor form being shown
834 - $notice: notice being disfavored
835
836 StartFindMentions: start finding mentions in a block of text
837 - $sender: sender profile
838 - $text: plain text version of the notice
839 - &$mentions: mentions found so far. Array of arrays; each array
840   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
841   'title' (title of the link), 'position' (position of the text to
842   replace), 'text' (text to replace)
843
844 EndFindMentions: end finding mentions in a block of text
845 - $sender: sender profile
846 - $text: plain text version of the notice
847 - &$mentions: mentions found so far. Array of arrays; each array
848   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
849   'title' (title of the link), 'position' (position of the text to
850   replace), 'text' (text to replace)
851
852 StartShowSubscriptionsContent: before showing the subscriptions content
853 - $action: the current action
854
855 EndShowSubscriptionsContent: after showing the subscriptions content
856 - $action: the current action
857
858 StartShowUserGroupsContent: before showing the user groups content
859 - $action: the current action
860
861 EndShowUserGroupsContent: after showing the user groups content
862 - $action: the current action
863
864 StartShowAllContent: before showing the all (you and friends) content
865 - $action: the current action
866
867 EndShowAllContent: after showing the all (you and friends) content
868 - $action: the current action
869
870 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
871 - $action: the current action
872
873 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
874 - $action: the current action
875
876 StartShowGroupsMiniList: at the start of groups mini list
877 - $action: the current action
878
879 EndShowGroupsMiniList: at the end of groups mini list
880 - $action: the current action
881
882 StartDeleteUserForm: starting the data in the form for deleting a user
883 - $action: action being shown
884 - $user: user being deleted
885
886 EndDeleteUserForm: Ending the data in the form for deleting a user
887 - $action: action being shown
888 - $user: user being deleted
889
890 StartDeleteUser: handling the post for deleting a user
891 - $action: action being shown
892 - $user: user being deleted
893
894 EndDeleteUser: handling the post for deleting a user
895 - $action: action being shown
896 - $user: user being deleted
897
898 StartNoticeAsActivity: before converting a notice to an activity
899 - $notice: notice being converted
900 - &$activity: initially empty activity
901
902 EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
903 - $notice: notice being converted
904 - &$activity: activity, now more-or-less full
905
906 StartNoticeSaveWeb: before saving a notice through the Web interface
907 - $action: action being executed (instance of NewNoticeAction)
908 - &$authorId: integer ID of the author
909 - &$text: text of the notice
910 - &$options: additional options (location, replies, etc.)
911
912 EndNoticeSaveWeb: after saving a notice through the Web interface
913 - $action: action being executed (instance of NewNoticeAction)
914 - $notice: notice that was saved
915
916 StartRssEntryArray: at the start of copying a notice to an array
917 - $notice: the notice being copied
918 - &$entry: the entry (empty at beginning)
919
920 EndRssEntryArray: at the end of copying a notice to an array
921 - $notice: the notice being copied
922 - &$entry: the entry, with all the fields filled up
923
924 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
925 - $notice: notice being deleted
926
927 StartShowHeadTitle: when beginning to show the <title> element
928 - $action: action being shown
929
930 EndShowHeadTitle: when done showing the <title>
931 - $action: action being shown
932
933 StartShowPageTitle: when beginning to show the page title <h1>
934 - $action: action being shown
935
936 EndShowPageTitle: when done showing the page title <h1>
937 - $action: action being shown
938
939 StartDeleteOwnNotice: when a user starts to delete their own notice
940 - $user: the user doing the delete
941 - $notice: the notice being deleted
942
943 EndDeleteOwnNotice: when a user has deleted their own notice
944 - $user: the user doing the delete
945 - $notice: the notice being deleted
946
947 StartShowFeedLinkList: before showing the feed list in the sidebar
948 - $action: action being executed
949 - $feeds: list of feeds to show
950
951 EndShowFeedLinkList: after showing the feed list in the sidebar
952 - $action: action being executed
953 - $feeds: list of feeds shown
954
955 StartShowFeedLink: before showing an individual feed item
956 - $action: action being executed
957 - $feed: feed to show
958
959 EndShowFeedLink: after showing an individual feed
960 - $action: action being executed
961 - $feed: feed to show
962
963 StartShowNoticeForm: before showing the notice form (before <form>)
964 - $action: action being executed
965
966 EndShowNoticeForm: after showing the notice form (after <form>)
967 - $action: action being executed
968
969 StartShowEntryForms: microapp entry form tab data
970 - &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
971
972 StartGrantRole: when a role is being assigned
973 - $profile: profile that will have the role
974 - $role: string name of the role
975
976 EndGrantRole: when a role has been successfully assigned
977 - $profile: profile that will have the role
978 - $role: string name of the role
979
980 StartRevokeRole: when a role is being revoked
981 - $profile: profile that will lose the role
982 - $role: string name of the role
983
984 EndRevokeRole: when a role has been revoked
985 - $profile: profile that lost the role
986 - $role: string name of the role
987
988 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
989 - &$activity: received activity
990 - $user: user publishing the entry
991 - &$notice: notice created; initially null, can be set
992
993 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
994 - $activity: received activity
995 - $user: user publishing the entry
996 - $notice: notice that was created
997
998 AdminPanelCheck: When checking whether the current user can access a given admin panel
999 - $name:  Name of the admin panel
1000 - &$isOK: Boolean whether the user is allowed to use the panel
1001
1002 StartAdminPanelNav: Before displaying the first item in the list of admin panels
1003 - $nav The AdminPanelNav widget
1004
1005 EndAdminPanelNav: After displaying the last item in the list of admin panels
1006 - $nav The AdminPanelNav widget
1007
1008 StartActivityObjectFromNotice: When converting a notice to an activity:object
1009 - $notice: The notice being converted
1010 - &$object: The resulting object. Fill this and return false to override defaults.
1011
1012 EndActivityObjectFromNotice: After converting a notice to an activity:object
1013 - $notice: The notice being converted
1014 - &$object: The resulting object. Can be edited
1015
1016 StartActivityObjectFromProfile: When converting a profile to an activity:object
1017 - $profile: The profile being converted
1018 - &$object: The (empty) object. Fill it up and return false to override defaults.
1019
1020 EndActivityObjectFromProfile: After converting a profile to an activity:object
1021 - $profile: The profile being converted
1022 - &$object: The finished object. Can be tweaked
1023
1024 StartActivityObjectFromGroup: When converting a group to an activity:object
1025 - $group: The group being converted
1026 - &$object: The (empty) object. Fill and return false to override.
1027
1028 EndActivityObjectFromGroup:  After converting a group to an activity:object
1029 - $group:  The group being converted
1030 - &$object: The finished object. Tweak as needed.
1031
1032 StartImportActivity: when we start to import an activity
1033 - $user: User to make the author import
1034 - $author: Author of the feed; good for comparisons
1035 - $activity: The current activity
1036 - $trusted: How "trusted" the process is
1037 - &$done: Return value; whether to continue
1038
1039 EndImportActivity: when we finish importing an activity
1040 - $user: User to make the author import
1041 - $author: Author of the feed; good for comparisons
1042 - $activity: The current activity
1043 - $trusted: How "trusted" the process is
1044
1045 StartProfileSettingsActions: when we're showing account-management action list
1046 - $action: Action being shown (use for output)
1047
1048 EndProfileSettingsActions: when we're showing account-management action list
1049 - $action: Action being shown (use for output)
1050
1051 StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
1052 - $nli: The notice list item being shown
1053
1054 EndOpenNoticeListItemElement: After the opening <li> of a notice list element
1055 - $nli: The notice list item being shown
1056
1057 StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
1058 - $nli: The notice list item being shown
1059
1060 EndCloseNoticeListItemElement: After the closing </li> of a notice list element
1061 - $nli: The notice list item being shown
1062
1063 StartGroupEditFormData: Beginning the group edit form entries
1064 - $form: The form widget being shown
1065
1066 EndGroupEditFormData: Ending the group edit form entries
1067 - $form: The form widget being shown
1068
1069 StartGroupSave: After initializing but before saving a group
1070 - &$group: group about to be saved
1071
1072 EndGroupSave: After saving a group, aliases, and first member
1073 - $group: group that was saved
1074
1075 StartInterpretCommand: Before running a command
1076 - $cmd: First word in the string, 'foo' in 'foo argument'
1077 - $arg: Argument, if any, like 'argument' in 'foo argument'
1078 - $user: User who issued the command
1079 - &$result: Resulting command; you can set this!
1080
1081 EndInterpretCommand: Before running a command
1082 - $cmd: First word in the string, 'foo' in 'foo argument'
1083 - $arg: Argument, if any, like 'argument' in 'foo argument'
1084 - $user: User who issued the command
1085 - $result: Resulting command
1086
1087 StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
1088 - $action: action being executed (for output and params)
1089 - $group: group for the page
1090
1091 EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
1092 - $action: action being executed (for output and params)
1093 - $group: group for the page
1094
1095 StartGroupProfileElements: Start showing stuff about the group on its profile page
1096 - $action: action being executed (for output and params)
1097 - $group: group for the page
1098
1099 EndGroupProfileElements: Start showing stuff about the group on its profile page
1100 - $action: action being executed (for output and params)
1101 - $group: group for the page
1102
1103 StartShowProfileTagContent: When showing a people tag page
1104 - $action: action being executed (for output and params)
1105
1106 EndShowProfileTagContent: After showing the contents of a people tag page
1107 - $action: action being executed (for output and params)
1108
1109 StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
1110 - $action: action being executed (for output and params)
1111
1112 EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
1113 - $action: action being executed (for output and params)
1114
1115 StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
1116 - $action: action being executed (for output and params)
1117
1118 EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
1119 - $action: action being executed (for output and params)
1120
1121 StartTagProfileAction: When starting to show profile tagging page
1122 - $action: action being executed (for output and params)
1123 - $profile: profile being tagged
1124
1125 EndTagProfileAction: After showing profile tagging page
1126 - $action: action being executed (for output and params)
1127 - $profile: profile being tagged
1128
1129 StartProfileCompletionSearch: When starting a profile search for autocompletion
1130 - $action: action being executed (for output and params)
1131 - &$profile: result Profile objects
1132 - $search_engine: the search engine
1133
1134 EndProfileCompletionSearch: After search results for profile autocompletion have been found
1135 - $action: profilec completion action
1136 - &$profile: current result Profile objects
1137 - $search_engine: The search engine object
1138
1139 StartShowTagProfileForm: When showing people tagging form
1140 - $action: action being executed (for output and params)
1141 - $profile: profile being tagged
1142
1143 EndShowTagProfileForm: After showing people tagging form
1144 - $action: action being executed (for output and params)
1145 - $profile: profile being tagged
1146
1147 StartSavePeopletags: When starting to save people tags
1148 - $action: action being executed (for output and params)
1149 - $tagstring: string input, a list of tags
1150
1151 EndSavePeopletags: After saving people tags
1152 - $action: action being executed (for output and params)
1153 - $tagstring: string input, a list of tags
1154
1155 StartProfiletagGetUri: when generating the Uri for a people tag
1156 - $profile_list: the people tag, a Profile_list object
1157 - &$uri: the URI
1158
1159 EndProfiletagGetUri: after generating the uri for a people tag
1160 - $profile_list: the people tag, a Profile_list object
1161 - &$uri: the URI
1162
1163 StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
1164 - $profile_list: the people tag, a Profile_list object
1165 - &$url: the URL
1166
1167 EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
1168 - $profile_list: the people tag, a Profile_list object
1169 - &$url: the URL
1170
1171 StartProfiletagPermalink: when generating the permalink url for a people tag
1172 - $profile_list: the people tag, a Profile_list object
1173 - &$url: the URL
1174
1175 EndProfiletagPermalink: after generating the permalink url for a people tag
1176 - $profile_list: the people tag, a Profile_list object
1177 - &$url: the URL
1178
1179 StartTagProfile: when tagging a profile
1180 - $tagger: profile tagging
1181 - $tagged: profile being tagged
1182 - $tag: the tag
1183
1184 EndTagProfile: after tagging a profile
1185 - $newtag: the newly created Profile_tag object
1186
1187 StartUntagProfile: when deleting a people tag
1188 - $ptag: the Profile_tag object being deleted
1189
1190 EndUntagProfile: after deleting a people tag
1191 - $orig: a copy of the deleted Profile_tag object
1192
1193 StartSubscribePeopletag: when subscribing to a people tag
1194 - $peopletag: Profile_list object being subscribed to
1195 - $profile: subscriber's profile
1196
1197 EndSubscribePeopletag: after subscribing to a people tag
1198 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1199 - $profile: subscriber's profile
1200
1201 StartUnsubscribePeopletag: when unsubscribing to a people tag
1202 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1203 - $profile: subscriber's profile
1204
1205 EndUnsubscribePeopletag: after unsubscribing to a people tag
1206 - $peopletag: Profile_list object being subscribed to
1207 - $profile: subscriber's profile
1208
1209 StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
1210 - $profile_list: the people tag, a Profile_list object
1211 - &$object: activity object
1212
1213 EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
1214 - $profile_list: the people tag, a Profile_list object
1215 - &$object: activity object
1216
1217 StartPeopletagGroupNav: Showing the people tag nav menu
1218 - $menu: the menu widget; use $menu->action for output
1219
1220 EndPeopletagGroupNav: after showing the people tag nav menu
1221 - $menu: the menu widget; use $menu->action for output
1222
1223 StartShowPeopletagItem: when showing a people tag
1224 - $widget: PeopletagListItem widget
1225
1226 EndShowPeopletagItem: after showing a people tag
1227 - $widget: PeopletagListItem widget
1228
1229 StartSubscribePeopletagForm: when showing people tag subscription form
1230 - $action: action being executed (for output and params)
1231 - $peopletag: people tag being subscribed to
1232
1233 EndSubscribePeopletagForm: after showing the people tag subscription form
1234 - $action: action being executed (for output and params)
1235 - $peopletag: people tag being subscribed to
1236
1237 StartShowPeopletags: when showing a textual list of people tags
1238 - $widget: PeopletagsWidget; use $widget->out for output
1239 - $tagger: profile of the tagger
1240 - $tagged: profile tagged
1241
1242 EndShowPeopletags: after showing a textual list of people tags
1243 - $widget: PeopletagsWidget; use $widget->out for output
1244 - $tagger: profile of the tagger
1245 - $tagged: profile tagged
1246
1247 StartProfileListItemTags: when showing people tags in a profile list item widget
1248 - $widget: ProfileListItem widget
1249
1250 EndProfileListItemTags: after showing people tags in a profile list item widget
1251 - $widget: ProfileListItem widget
1252
1253 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)
1254 - $obj: ActivityObject
1255 - $out: XMLOutputter to append custom output
1256
1257 EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
1258 - $obj: ActivityObject
1259 - $out: XMLOutputter to append custom output
1260
1261 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)
1262 - $obj ActivityObject
1263 - &$out: array to be serialized; you're free to modify it
1264
1265 EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
1266 - $obj ActivityObject
1267 - &$out: array to be serialized; you're free to modify it
1268
1269 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.
1270 - $notice Notice
1271 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1272
1273 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.
1274 - $notice Notice
1275 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1276
1277 StartDefaultLocalNav: When showing the default local nav
1278 - $menu: the menu
1279 - $user: current user
1280
1281 EndDefaultLocalNav: When showing the default local nav
1282 - $menu: the menu
1283 - $user: current user
1284
1285 StartShowAccountProfileBlock: When showing the profile block for an account
1286 - $out: XMLOutputter to append custom output
1287 - $profile: the profile being shown
1288
1289 EndShowAccountProfileBlock: After showing the profile block for an account
1290 - $out: XMLOutputter to append custom output
1291 - $profile: the profile being shown
1292
1293 StartShowGroupProfileBlock: When showing the profile block for a group
1294 - $out: XMLOutputter to append custom output
1295 - $profile: the profile being shown
1296
1297 EndShowGroupProfileBlock: After showing the profile block for a group
1298 - $out: XMLOutputter to append custom output
1299 - $group: the group being shown
1300
1301 StartShowConversation: start the listing of a conversation
1302 - $action: Action object (used mainly as HTMLOutputter)
1303 - $conv: Conversation object, has functions to retrieve relevant notices
1304 - $scoped: Profile for scoping (null if not logged in)
1305
1306 EndShowConversation: after the listing of a conversation
1307 - $action: Action object (used mainly as HTMLOutputter)
1308 - $conv: Conversation object, has functions to retrieve relevant notices
1309 - $scoped: Profile for scoping (null if not logged in)
1310
1311 StartShowThreadedNoticeTail: when showing the replies etc. to a notice
1312 - $nli: parent noticelistitem
1313 - $notice: parent notice
1314 - &$children: list of children
1315
1316 EndShowThreadedNoticeTail: when showing the replies etc. to a notice
1317 - $nli: parent noticelistitem
1318 - $notice: parent notice
1319 - $children: list of children
1320
1321 StartShowThreadedNoticeSub: when showing a reply to a notice
1322 - $nli: parent noticelistitem
1323 - $parent: parent notice
1324 - $child: child notice
1325
1326 EndShowThreadedNoticeSub: when showing a reply to a notice
1327 - $nli: parent noticelistitem
1328 - $parent: parent notice
1329 - $child: child notice
1330
1331 StartAddEmailAddress: when adding an email address through the Web UI
1332 - $user: user getting the new address
1333 - $email: email being added
1334
1335 EndAddEmailAddress: done adding an email address through the Web UI
1336 - $user: user getting the new address
1337 - $email: email being added
1338
1339 StartValidateEmailInvite: when validating an email address for invitations
1340 - $user: user doing the invite
1341 - $email: email address
1342 - &$valid: flag for if it's valid; can be modified
1343
1344 EndValidateEmailInvite: after validating an email address for invitations
1345 - $user: user doing the invite
1346 - $email: email address
1347 - &$valid: flag for if it's valid; can be modified
1348
1349 StartLocalURL: before resolving a local url for an action
1350 - &$action: action to find a path for
1351 - &$paramsi: parameters to pass to the action
1352 - &$fragment: any url fragement
1353 - &$addSession: whether to add session variable
1354 - &$url: resulting URL to local resource
1355
1356 EndLocalURL: before resolving a local url for an action
1357 - &$action: action to find a path for
1358 - &$paramsi: parameters to pass to the action
1359 - &$fragment: any url fragement
1360 - &$addSession: whether to add session variable
1361 - &$url: resulting URL to local resource
1362
1363 StartProfileGetAvatar: When getting an avatar for a profile
1364 - $profile: profile
1365 - $size: size of the avatar
1366 - &$avatar: avatar
1367
1368 EndProfileGetAvatar: After getting an avatar for a profile
1369 - $profile: profile
1370 - $size: size of the avatar
1371 - &$avatar: avatar
1372
1373 StartRegisterSuccess: Before showing the registration success message
1374 - $action: the registration action
1375
1376 StartRegisterSuccess: After showing the registration success message
1377 - $action: the registration action
1378
1379 StartDocFileForTitle: Before searching for a doc or mail template
1380 - $title: Title we're looking for
1381 - &$paths: Paths we're searching
1382 - &$filename: Filename so far (set this if you want)
1383
1384 EndDocFileForTitle: After searching for a doc or mail template
1385 - $title: Title we looked for
1386 - $paths: Paths we searched
1387 - &$filename: Filename so far (set this if you want)
1388
1389 StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
1390 - &$tables: list of table names
1391 - &$rwdb: read-write database URI
1392
1393 EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
1394 - $tables: list of table names
1395 - $rwdb: read-write database URI
1396
1397 StartShowInviteForm: Right before displaying the invitations form
1398 - $action: invitation action
1399
1400 EndShowInviteForm: After displaying the invitations form
1401 - $action: invitation action
1402
1403 StartSendInvitations: Right before sending invitations
1404 - $action: invitation action
1405
1406 EndSendInvitations: Right after sending invitations
1407 - $action: invitation action
1408
1409 StartShowInvitationSuccess: Right before showing invitations success msg
1410 - $action: invitation action
1411
1412 EndShowInvitationSuccess: After showing invitations success msg
1413 - $action: invitation action
1414
1415 StartUpgrade: when starting a site upgrade
1416
1417 EndUpgrade: when ending a site upgrade; good place to do your own upgrades
1418
1419 HaveIMPlugin: is there an IM plugin loaded?
1420 - &$haveIMPlugin: set me to true if you're loaded!
1421
1422 StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
1423 - $nli: NoticeListItem being shown
1424
1425 EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
1426 - $nli: NoticeListItem being shown
1427
1428 StartNoticeInScope: Before checking if a notice should be visible to a user
1429 - $notice: The notice to check
1430 - $profile: The profile to check for scope
1431 - &$bResult: The boolean result; fill this in if you want to skip
1432
1433 EndNoticeInScope: After checking if a notice should be visible to a user
1434 - $notice: The notice to check
1435 - $profile: The profile to check for scope
1436 - &$bResult: The boolean result; overwrite this if you so desire
1437
1438 StartNoticeListPrefill: Before pre-filling a list of notices with extra data
1439 - &$notices: Notices to be pre-filled
1440 - $avatarSize: The avatar size for the list
1441
1442 EndNoticeListPrefill: After pre-filling a list of notices with extra data
1443 - &$notices: Notices that were pre-filled
1444 - &$profiles: Profiles that were pre-filled 
1445 - $avatarSize: The avatar size for the list
1446
1447 OtherAccountProfiles: Hook to add account profiles to a user account profile block
1448 - $profile: the Profile being shown
1449 - &$others: Modifiable array of profile info arrays. Each one has the following fields:
1450             href: link to the profile
1451             text: text for the profile
1452             image: mini image for the profile
1453
1454 CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
1455 - $file:    'File' object to source the image from
1456 - &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
1457 - $media:   MIME media type ('image', 'video', 'audio' etc.)
1458
1459 StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1460 - $out:     HTMLOutputter class to use for outputting HTML.
1461 - $file:    'File' object which we're going to show representation for.
1462
1463 EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
1464 - $out:     HTMLOutputter class to use for outputting HTML.
1465 - $file:    'File' object which we're going to show representation for.
1466
1467 ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1468 - $out:     HTMLOutputter class to use for outputting HTML.
1469 - $file:    'File' object which we're going to show representation for.