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