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