]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - EVENTS.txt
First version of 3cl theme neo.
[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 StartShowStatusNetStyles: Showing StatusNet Style links
24 - $action: the current action
25
26 EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
27 - $action: the current action
28
29 StartShowLaconicaStyles: backwards compatibility; deprecated
30 - $action: the current action
31
32 EndShowLaconicaStyles: backwards compatibility; deprecated
33 - $action: the current action
34
35 StartShowUAStyles: Showing custom User-Agent style links
36 - $action: the current action
37
38 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
39 - $action: the current action
40
41 StartShowScripts: Showing JavaScript links
42 - $action: the current action
43
44 EndShowScripts: End showing JavaScript links; good place to add custom
45                 links like Google Analytics
46 - $action: the current action
47
48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
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 StartShowLaconicaScripts: backwards compatibility; deprecated
61 - $action: the current action
62
63 EndShowLaconicaScripts: backwards compatibility; deprecated
64 - $action: the current action
65
66 StartShowSections: Start the list of sections in the sidebar
67 - $action: the current action
68
69 EndShowSections: End the list of sections in the sidebar
70 - $action: the current action
71
72 StartShowHeader: Showing before the header container
73 - $action: the current action
74
75 EndShowHeader: Showing after the header container
76 - $action: the current action
77
78 StartShowFooter: Showing before the footer container
79 - $action: the current action
80
81 EndShowFooter: Showing after the footer container
82 - $action: the current action
83
84 StartShowContentBlock: Showing before the content container
85 - $action: the current action
86
87 EndShowContentBlock: Showing after the content container
88 - $action: the current action
89
90 StartShowAside: Showing before the Aside container
91 - $action: the current action
92
93 EndShowAside: Showing after the Aside container
94 - $action: the current action
95
96 StartShowNoticeFormData: Showing before the notice form data
97 - $action: the current action
98
99 EndShowNoticeFormData: Showing after the notice form data
100 - $action: the current action
101
102 StartNoticeSave: before inserting a notice (good place for content filters)
103 - $notice: notice being saved (no ID or URI)
104
105 EndNoticeSave: after inserting a notice and related code
106 - $notice: notice that was saved (with ID and URI)
107
108 StartShowLocalNavBlock: Showing the local nav menu
109 - $action: the current action
110
111 EndShowLocalNavBlock: At the end of the local nav menu
112 - $action: the current action
113
114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
115 - $action: the current action
116
117 EndShowHTML: Showing after the html element
118 - $action: the current action
119
120 StartPublicGroupNav: Showing the public group nav menu
121 - $menu: the menu widget; use $menu->action for output
122
123 EndPublicGroupNav: At the end of the public group nav menu
124 - $menu: the menu widget; use $menu->action for output
125
126 StartSubGroupNav: Showing the subscriptions group nav menu
127 - $menu: the menu widget; use $menu->action for output
128
129 EndSubGroupNav: At the end of the subscriptions group nav menu
130 - $menu: the menu widget; use $menu->action for output
131
132 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
133 - $m: the Net_URL_Mapper that has just been set up
134
135 RouterInitialized: After the router instance has been initialized
136 - $m: the Net_URL_Mapper that has just been set up
137
138 StartLogout: Before logging out
139 - $action: the logout action
140
141 EndLogout: After logging out
142 - $action: the logout action
143
144 ArgsInitialize: After the argument array has been initialized
145 - $args: associative array of arguments, can be modified
146
147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
148 - $action: the current action
149
150 EndAddressData: At the end of <address>
151 - $action: the current action
152
153 StartShowSiteNotice: Before showing site notice
154 - $action: the current action
155
156 EndShowSiteNotice: After showing site notice
157 - $action: the current action
158
159 StartLoginGroupNav: Before showing the login and register navigation menu
160 - $action: the current action
161
162 EndLoginGroupNav: After showing the login and register navigation menu
163 - $action: the current action
164
165 StartAccountSettingsNav: Before showing the account settings menu
166 - $action: the current action
167
168 EndAccountSettingsNav: After showing the account settings menu
169 - $action: the current action
170
171 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
172 - $widget: AccountSettingsNav instance being shown
173
174 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
175 - $widget: AccountSettingsNav instance being shown
176
177 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
178 - $widget: AccountSettingsNav instance being shown
179
180 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
181 - $widget: AccountSettingsNav instance being shown
182
183 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
184 - $widget: AccountSettingsNav instance being shown
185
186 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
187 - $widget: AccountSettingsNav instance being shown
188
189 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
190 - $widget: AccountSettingsNav instance being shown
191
192 EndAccountSettingsEmailMenuItem: After showing the Email menu item
193 - $widget: AccountSettingsNav instance being shown
194
195 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
196 - $widget: AccountSettingsNav instance being shown
197
198 EndAccountSettingsDesignMenuItem: After showing the Design menu item
199 - $widget: AccountSettingsNav instance being shown
200
201 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
202 - $widget: AccountSettingsNav instance being shown
203
204 EndAccountSettingsOtherMenuItem: After showing the Other menu item
205 - $widget: AccountSettingsNav instance being shown
206
207 Autoload: When trying to autoload a class
208 - $cls: the class being sought. A plugin might require_once the file for the class.
209
210 SensitiveAction: determines if an action is 'sensitive' and should use SSL
211 - $action: name of the action, like 'login'
212 - $sensitive: flag for whether this is a sensitive action
213
214 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
215 - $action: name of the action, like 'register'
216 - $login: flag for whether this is a login action
217
218 StartShowHead: called before showing the <head> element and children
219 - $action: action object being show
220
221 EndShowHead: called after showing the <head> element (and </head>)
222 - $action: action object being shown
223
224 StartShowBody: called before showing the <body> element and children
225 - $action: action object being shown
226
227 EndShowBody: called after showing the <body> element (and </body>)
228 - $action: action object being shown
229
230 StartPersonalGroupNav: beginning of personal group nav menu
231 - $action: action object being shown
232
233 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
234 - $action: action object being shown
235
236 StartGroupGroupNav: Showing the group nav menu
237 - $action: the current action
238
239 EndGroupGroupNav: At the end of the group nav menu
240 - $action: the current action
241
242 StartEndHTML: just before the </html> tag
243 - $action: action object being shown
244
245 EndEndHTML: just after the </html> tag
246 - $action: action object being shown
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 StartShowNoticeInfo: just before showing notice info
267 - $item: The NoticeListItem object being shown
268
269 EndShowNoticeInfo: just after showing notice info
270 - $item: The NoticeListItem object being shown
271
272 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
273 - $item: the NoticeListItem object being shown
274
275 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
276 - $item: the NoticeListItem object being shown
277
278 StartShowFaveForm: just before showing the fave form
279 - $item: the NoticeListItem object being shown
280
281 EndShowFaveForm: just after showing the fave form
282 - $item: the NoticeListItem object being shown
283
284 StartShowPageNotice: just before showing the page notice (instructions or error)
285 - $action: action object being shown
286
287 EndShowPageNotice: just after showing the page notice (instructions or error)
288 - $action: action object being shown
289
290 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
291 - $action: action object being shown
292
293 StartProfileFormData: just before showing text entry fields on profile settings page
294 - $action: action object being shown
295
296 EndProfileFormData: just after showing text entry fields on profile settings page
297 - $action: action object being shown
298
299 StartProfileSaveForm: before starting to save a profile settings form
300 - $action: action object being shown
301
302 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
303 - $action: action object being shown
304
305 StartEmailFormData: just before showing text entry fields on email settings page
306 - $action: action object being shown
307
308 EndEmailFormData: just after showing text entry fields on email settings page
309 - $action: action object being shown
310
311 StartEmailSaveForm: before starting to save a email settings form
312 - $action: action object being shown
313 - &$user: user being saved
314
315 EndEmailSaveForm: after saving a email settings form (after commit)
316 - $action: action object being shown
317 - &$user: user being saved
318
319 StartRegistrationFormData: just before showing text entry fields on registration page
320 - $action: action object being shown
321
322 EndRegistrationFormData: just after showing text entry fields on registration page
323 - $action: action object being shown
324
325 StartRegistrationTry: before validating and saving a new user
326 - $action: action object being shown
327
328 EndRegistrationTry: after saving a new user (note: no profile or user object!)
329 - $action: action object being shown
330
331 StartAvatarFormData: before displaying avatar form
332 - $action: action object being shown
333
334 EndAvatarFormData: after displaying avatar form
335 - $action: action object being shown
336
337 StartAvatarSaveForm: before saving the avatar
338 - $action: action object being shown
339
340 EndAvatarSaveForm: after saving the avatar
341 - $action: action object being shown
342
343 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
344 - $qm: empty queue manager to set
345
346 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
347 - $action: action object being shown
348 - $user: current user
349
350 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
351 - $title: title of the document
352 - $output: HTML output to show
353
354 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
355 - $title: title of the document
356 - $output: HTML output to show
357
358 StartApiRss: after the rss <channel> element is started
359 - $action: action object being shown
360
361 StartApiAtom: after the <feed> element is started
362 - $action: action object being shown
363
364 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
365 - $notice: the notice being added
366 - &$transports: modifiable list of transports (as strings) to queue for
367
368 EndEnqueueNotice: after adding a notice to the queues
369 - $notice: the notice being added
370 - $transports: modifiable list of transports to use
371
372 UnqueueHandleNotice: Handle a notice when no queue manager is available
373 - $notice: the notice to handle
374 - $queue: the "queue" that is being executed
375
376 GetValidDaemons: Just before determining which daemons to run
377 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
378
379 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
380 - &$notice: notice to handle
381
382 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
383 - $action: the current action
384 - &$attrs: attributes for the HTML element
385
386 EndHtmlElement: Right after outputting the HTML element
387 - $action: the current action
388 - &$attrs: attributes for the HTML element
389
390 StartShowHeadElements: Right after the <head> tag
391 - $action: the current action
392
393 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
394 - $action: the current action
395
396 CheckSchema: chance to check the schema
397
398 StartProfileRemoteSubscribe: Before showing the link to remote subscription
399 - $userprofile: UserProfile widget
400 - &$profile: the profile being shown
401
402 EndProfileRemoteSubscribe: After showing the link to remote subscription
403 - $userprofile: UserProfile widget
404 - &$profile: the profile being shown
405
406 StartGroupSubscribe: Before showing the link to remote subscription
407 - $action: the current action
408 - $group: the group being shown
409
410 EndGroupSubscribe: After showing the link to remote subscription
411 - $action: the current action
412 - $group: the group being shown
413
414 StartProfilePageProfileSection: Starting to show the section of the
415                               profile page with the actual profile data;
416                               hook to prevent showing the profile (e.g.)
417 - $userprofile: UserProfile widget
418 - &$profile: the profile being shown
419
420 StartProfilePageProfileElements: inside the section, before the first
421                                element; prepend elements here
422 - $userprofile: UserProfile widget
423 - &$profile: the profile being shown
424
425 EndProfilePageProfileElements: inside the section, after the last element;
426                              append elements here
427 - $userprofile: UserProfile widget
428 - &$profile: the profile being shown
429
430 EndProfilePageProfileSection: After showing the section of the profile
431                             page with the profile elements
432 - $userprofile: UserProfile widget
433 - &$profile: the profile being shown
434
435 StartProfilePageActionsSection: Starting to show the section of the
436                                     profile page with action links; hook
437                                     to hide them (for example)
438 - $userprofile: UserProfile widget
439 - &$profile: the profile being shown
440
441 StartProfilePageActionsElements: inside the list, before the first
442                                      element; prepend elements here
443 - $userprofile: UserProfile widget
444 - &$profile: the profile being shown
445
446 EndProfilePageActionsElements: inside the list, after the last element;
447                                    append elements here
448 - $userprofile: UserProfile widget
449 - &$profile: the profile being shown
450
451 EndProfilePageActionsSection: After showing the section of the profile
452                                   page with the entity actions
453 - $userprofile: UserProfile widget
454 - &$profile: the profile being shown
455
456 StartProfilePageAvatar: before showing the avatar on the profile page
457 - $userprofile: UserProfile widget
458 - &$profile: the profile being shown
459
460 EndProfilePageAvatar: after showing the avatar on the profile page
461 - $userprofile: UserProfile widget
462 - &$profile: the profile being shown
463
464 StartProfilePageNickname: before showing the nickname on the profile page
465 - $userprofile: UserProfile widget
466 - &$profile: the profile being shown
467
468 EndProfilePageNickname: after showing the nickname on the profile page
469 - $userprofile: UserProfile widget
470 - &$profile: the profile being shown
471
472 StartProfilePageFullName: before showing the fullname on the profile page
473 - $userprofile: UserProfile widget
474 - &$profile: the profile being shown
475
476 EndProfilePageFullName: after showing the fullname on the profile page
477 - $userprofile: UserProfile widget
478 - &$profile: the profile being shown
479
480 StartProfilePageLocation: before showing the location on the profile page
481 - $userprofile: UserProfile widget
482 - &$profile: the profile being shown
483
484 EndProfilePageLocation: after showing the location on the profile page
485 - $userprofile: UserProfile widget
486 - &$profile: the profile being shown
487
488 StartProfilePageHomepage: before showing the homepage link on the profile page
489 - $userprofile: UserProfile widget
490 - &$profile: the profile being shown
491
492 EndProfilePageHomepage: after showing the homepage on the profile page
493 - $userprofile: UserProfile widget
494 - &$profile: the profile being shown
495
496 StartProfilePageBio: before showing the bio on the profile page
497 - $userprofile: UserProfile widget
498 - &$profile: the profile being shown
499
500 EndProfilePageBio: after showing the bio on the profile page
501 - $userprofile: UserProfile widget
502 - &$profile: the profile being shown
503
504 StartProfilePageProfileTags: before showing the tags on the profile page
505 - $userprofile: UserProfile widget
506 - &$profile: the profile being shown
507
508 EndProfilePageProfileTags: after showing the tags on the profile page
509 - $userprofile: UserProfile widget
510 - &$profile: the profile being shown
511
512 StartProfileList: when starting a list of profiles (before <ul>)
513 - $profilelist: ProfileList widget, with $profile, $action, and $out
514
515 EndProfileList: when ending a list of profiles (after </ul>)
516 - $profilelist: ProfileList widget
517
518 StartProfileListItem: when starting to show a profile list item
519 - $item: ProfileListItem widget
520
521 EndProfileListItem: after showing a profile list item
522 - $item: ProfileListItem widget
523
524 StartProfileListItemProfile: the profile data part of the item
525 - $item: ProfileListItem widget
526
527 EndProfileListItemProfile: the profile data part of the item
528 - $item: ProfileListItem widget
529
530 StartProfileListItemActions: the actions (buttons) for an item
531 - $item: ProfileListItem widget
532
533 EndProfileListItemActions: the actions (buttons) for an item
534 - $item: ProfileListItem widget
535
536 StartProfileListItemProfileElements: inside the <div>
537 - $item: ProfileListItem widget
538
539 EndProfileListItemProfileElements: inside the <div>
540 - $item: ProfileListItem widget
541
542 StartProfileListItemAvatar: Showing a profile list avatar
543 - $item: ProfileListItem widget
544
545 EndProfileListItemAvatar: Showing a profile list avatar
546 - $item: ProfileListItem widget
547
548 StartProfileListItemFullName: Showing the profile list full name
549 - $item: ProfileListItem widget
550
551 EndProfileListItemFullName: Showing the profile list full name
552 - $item: ProfileListItem widget
553
554 StartProfileListItemLocation: Showing the profile list location
555 - $item: ProfileListItem widget
556
557 EndProfileListItemLocation: Showing the profile list location
558 - $item: ProfileListItem widget
559
560 StartProfileListItemHomepage: Showing the profile list homepage
561 - $item: ProfileListItem widget
562
563 EndProfileListItemHomepage: Showing the profile list homepage
564 - $item: ProfileListItem widget
565
566 StartProfileListItemBio: Showing the profile list bio
567 - $item: ProfileListItem widget
568
569 EndProfileListItemBio: Showing the profile list bio
570 - $item: ProfileListItem widget
571
572 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
573 - $item: ProfileListItem widget
574
575 EndProfileListItemActionElements: Showing profile list actions (append a button here)
576 - $item: ProfileListItem widget
577
578 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
579 - $action: the current action
580 - &$xrdsoutputter - XRDSOutputter object to write to
581
582 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
583 - $action: the current action
584 - &$xrdsoutputter - XRDSOutputter object to write to
585
586 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
587 - $action: the current action
588 - &$xrdsoutputter - XRDSOutputter object to write to
589
590 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
591 - $action: the current action
592 - &$xrdsoutputter - XRDSOutputter object to write to
593
594 StartHostMetaLinks: Start /.well-known/host-meta links
595 - &links: array containing the links elements to be written
596
597 EndHostMetaLinks: End /.well-known/host-meta links
598 - &links: array containing the links elements to be written
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 StartSetUser: Before setting the currently logged in user
619 - $user: user
620
621 EndSetUser: After setting the currently logged in user
622 - $user: user
623
624 StartSetApiUser: Before setting the current API user
625 - $user: user
626
627 EndSetApiUser: After setting the current API user
628 - $user: user
629
630 StartHasRole: Before determing if the a profile has a given role
631 - $profile: profile in question
632 - $name: name of the role in question
633 - &$has_role: does this profile have the named role?
634
635 EndHasRole: 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 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
641 - $user: User object
642 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
643
644 GetUrlShorteners: Specify URL shorteners that are available for use
645 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
646
647 StartShortenUrl: About to shorten a URL
648 - $url: url to be shortened
649 - $shortenerName: name of the requested shortener
650 - &$shortenedUrl: short version of the url
651
652 EndShortenUrl: After a URL has been shortened
653 - $url: url to be shortened
654 - $shortenerName: name of the requested shortener
655 - $shortenedUrl: short version of the url
656
657 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
658 - $action
659 - &$src
660 - &$theme
661 - &$media
662
663 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
664 - $action
665 - $src
666 - $theme
667 - $media
668
669 StartStyleElement: Before a <style...> element is written
670 - $action
671 - &$code
672 - &$type
673 - &$media
674
675 EndStyleElement: After a <style...> element is written
676 - $action
677 - $code
678 - $type
679 - $media
680
681 StartScriptElement: Before a <script...> element is written
682 - $action
683 - &$src
684 - &$type
685
686 EndScriptElement: After a <script...> element is written
687 - $action
688 - $src
689 - $type
690
691 StartInlineScriptElement: Before a <script...> element is written
692 - $action
693 - &$code
694 - &$type
695
696 EndInlineScriptElement: After a <script...> element is written
697 - $action
698 - $code
699 - $type
700
701 StartLog: Before writing to the logs
702 - &$priority
703 - &$msg
704 - &$filename
705
706 EndLog: After writing to the logs
707 - $priority
708 - $msg
709 - $filename
710
711 StartBlockProfile: when we're about to block
712 - $user: the person doing the block
713 - $profile: the person getting blocked, can be remote
714
715 EndBlockProfile: when a block has succeeded
716 - $user: the person doing the block
717 - $profile: the person blocked, can be remote
718
719 StartUnblockProfile: when we're about to unblock
720 - $user: the person doing the unblock
721 - $profile: the person getting unblocked, can be remote
722
723 EndUnblockProfile: when an unblock has succeeded
724 - $user: the person doing the unblock
725 - $profile: the person unblocked, can be remote
726
727 StartSubscribe: when a subscription is starting
728 - $user: the person subscribing
729 - $other: the person being subscribed to
730
731 EndSubscribe: when a subscription is finished
732 - $user: the person subscribing
733 - $other: the person being subscribed to
734
735 StartUnsubscribe: when an unsubscribe is starting
736 - $user: the person unsubscribing
737 - $other: the person being unsubscribed from
738
739 EndUnsubscribe: when an unsubscribe is done
740 - $user: the person unsubscribing
741 - $other: the person being unsubscribed to
742
743 StartJoinGroup: when a user is joining a group
744 - $group: the group being joined
745 - $user: the user joining
746
747 EndJoinGroup: when a user finishes joining a group
748 - $group: the group being joined
749 - $user: the user joining
750
751 StartLeaveGroup: when a user is leaving a group
752 - $group: the group being left
753 - $user: the user leaving
754
755 EndLeaveGroup: when a user has left a group
756 - $group: the group being left
757 - $user: the user leaving
758
759 StartShowContentLicense: Showing the default license for content
760 - $action: the current action
761
762 EndShowContentLicense: Showing the default license for content
763 - $action: the current action
764
765 GetImTransports: Get IM transports that are available
766 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
767
768 NormalizeImScreenname: Normalize an IM screenname
769 - $transport: transport the screenname is on
770 - &$screenname: screenname to be normalized
771
772 ValidateImScreenname: Validate an IM screenname
773 - $transport: transport the screenname is on
774 - $screenname: screenname to be validated
775 - $valid: is the screenname valid?
776
777 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
778 - $transport: transport the screenname exists on
779 - $screenname: screenname being confirmed
780 - $code: confirmation code for confirmation URL
781 - $user: user requesting the confirmation
782
783 StartUserRegister: When a new user is being registered
784 - &$profile: new profile data (no ID)
785 - &$user: new user account (no ID or URI)
786
787 EndUserRegister: When a new user has been registered
788 - &$profile: new profile data
789 - &$user: new user account
790
791 StartRobotsTxt: Before outputting the robots.txt page
792 - &$action: RobotstxtAction being shown
793
794 EndRobotsTxt: After the default robots.txt page (good place for customization)
795 - &$action: RobotstxtAction being shown
796
797 StartGetProfileUri: When determining the canonical URI for a given profile
798 - $profile: the current profile
799 - &$uri: the URI
800
801 EndGetProfileUri: After determining the canonical URI for a given profile
802 - $profile: the current profile
803 - &$uri: the URI
804
805 StartFavorNotice: Saving a notice as a favorite
806 - $profile: profile of the person faving (can be remote!)
807 - $notice: notice being faved
808 - &$fave: Favor object; null to start off with, but feel free to override.
809
810 EndFavorNotice: After saving a notice as a favorite
811 - $profile: profile of the person faving (can be remote!)
812 - $notice: notice being faved
813
814 StartDisfavorNotice: Saving a notice as a favorite
815 - $profile: profile of the person faving (can be remote!)
816 - $notice: notice being faved
817 - &$result: result of the disfavoring (if you override)
818
819 EndDisfavorNotice: After saving a notice as a favorite
820 - $profile: profile of the person faving (can be remote!)
821 - $notice: notice being faved
822
823 StartFavorNoticeForm: starting the data in the form for favoring a notice
824 - $FavorForm: the favor form being shown
825 - $notice: notice being favored
826
827 EndFavorNoticeForm: Ending the data in the form for favoring a notice
828 - $FavorForm: the favor form being shown
829 - $notice: notice being favored
830
831 StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
832 - $DisfavorForm: the disfavor form being shown
833 - $notice: notice being difavored
834
835 EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
836 - $DisfavorForm: the disfavor form being shown
837 - $notice: notice being disfavored
838
839 StartFindMentions: start finding mentions in a block of text
840 - $sender: sender profile
841 - $text: plain text version of the notice
842 - &$mentions: mentions found so far. Array of arrays; each array
843   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
844   'title' (title of the link), 'position' (position of the text to
845   replace), 'text' (text to replace)
846
847 EndFindMentions: end finding mentions in a block of text
848 - $sender: sender profile
849 - $text: plain text version of the notice
850 - &$mentions: mentions found so far. Array of arrays; each array
851   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
852   'title' (title of the link), 'position' (position of the text to
853   replace), 'text' (text to replace)
854
855 StartShowSubscriptionsContent: before showing the subscriptions content
856 - $action: the current action
857
858 EndShowSubscriptionsContent: after showing the subscriptions content
859 - $action: the current action
860
861 StartShowUserGroupsContent: before showing the user groups content
862 - $action: the current action
863
864 EndShowUserGroupsContent: after showing the user groups content
865 - $action: the current action
866
867 StartShowAllContent: before showing the all (you and friends) content
868 - $action: the current action
869
870 EndShowAllContent: after showing the all (you and friends) content
871 - $action: the current action
872
873 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
874 - $action: the current action
875
876 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
877 - $action: the current action
878
879 StartShowGroupsMiniList: at the start of groups mini list
880 - $action: the current action
881
882 EndShowGroupsMiniList: at the end of groups mini list
883 - $action: the current action
884
885 StartDeleteUserForm: starting the data in the form for deleting a user
886 - $action: action being shown
887 - $user: user being deleted
888
889 EndDeleteUserForm: Ending the data in the form for deleting a user
890 - $action: action being shown
891 - $user: user being deleted
892
893 StartDeleteUser: handling the post for deleting a user
894 - $action: action being shown
895 - $user: user being deleted
896
897 EndDeleteUser: handling the post for deleting a user
898 - $action: action being shown
899 - $user: user being deleted
900
901 StartNoticeAsActivity: before converting a notice to an activity
902 - $notice: notice being converted
903 - &$activity: initially empty activity
904
905 EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
906 - $notice: notice being converted
907 - &$activity: activity, now more-or-less full
908
909 StartNoticeSaveWeb: before saving a notice through the Web interface
910 - $action: action being executed (instance of NewNoticeAction)
911 - &$authorId: integer ID of the author
912 - &$text: text of the notice
913 - &$options: additional options (location, replies, etc.)
914
915 EndNoticeSaveWeb: after saving a notice through the Web interface
916 - $action: action being executed (instance of NewNoticeAction)
917 - $notice: notice that was saved
918
919 StartRssEntryArray: at the start of copying a notice to an array
920 - $notice: the notice being copied
921 - &$entry: the entry (empty at beginning)
922
923 EndRssEntryArray: at the end of copying a notice to an array
924 - $notice: the notice being copied
925 - &$entry: the entry, with all the fields filled up
926
927 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
928 - $notice: notice being deleted
929
930 StartShowHeadTitle: when beginning to show the <title> element
931 - $action: action being shown
932
933 EndShowHeadTitle: when done showing the <title>
934 - $action: action being shown
935
936 StartShowPageTitle: when beginning to show the page title <h1>
937 - $action: action being shown
938
939 EndShowPageTitle: when done showing the page title <h1>
940 - $action: action being shown
941
942 StartDeleteOwnNotice: when a user starts to delete their own notice
943 - $user: the user doing the delete
944 - $notice: the notice being deleted
945
946 EndDeleteOwnNotice: when a user has deleted their own notice
947 - $user: the user doing the delete
948 - $notice: the notice being deleted
949
950 StartShowFeedLinkList: before showing the feed list in the sidebar
951 - $action: action being executed
952 - $feeds: list of feeds to show
953
954 EndShowFeedLinkList: after showing the feed list in the sidebar
955 - $action: action being executed
956 - $feeds: list of feeds shown
957
958 StartShowFeedLink: before showing an individual feed item
959 - $action: action being executed
960 - $feed: feed to show
961
962 EndShowFeedLink: after showing an individual feed
963 - $action: action being executed
964 - $feed: feed to show
965
966 StartShowNoticeForm: before showing the notice form (before <form>)
967 - $action: action being executed
968
969 EndShowNoticeForm: after showing the notice form (after <form>)
970 - $action: action being executed
971
972 StartGrantRole: when a role is being assigned
973 - $profile: profile that will have the role
974 - $role: string name of the role
975
976 EndGrantRole: when a role has been successfully assigned
977 - $profile: profile that will have the role
978 - $role: string name of the role
979
980 StartRevokeRole: when a role is being revoked
981 - $profile: profile that will lose the role
982 - $role: string name of the role
983
984 EndRevokeRole: when a role has been revoked
985 - $profile: profile that lost the role
986 - $role: string name of the role
987
988 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
989 - &$activity: received activity
990 - $user: user publishing the entry
991 - &$notice: notice created; initially null, can be set
992
993 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
994 - $activity: received activity
995 - $user: user publishing the entry
996 - $notice: notice that was created
997
998 StartXrdActionAliases: About to set aliases for the XRD object for a user
999 - &$xrd: XRD object being shown
1000 - $user: User being shown
1001
1002 EndXrdActionAliases: Done with aliases for the XRD object for a user
1003 - &$xrd: XRD object being shown
1004 - $user: User being shown
1005
1006 StartXrdActionLinks: About to set links for the XRD object for a user
1007 - &$xrd: XRD object being shown
1008 - $user: User being shown
1009
1010 EndXrdActionLinks: Done with links for the XRD object for a user
1011 - &$xrd: XRD object being shown
1012 - $user: User being shown
1013
1014 AdminPanelCheck: When checking whether the current user can access a given admin panel
1015 - $name:  Name of the admin panel
1016 - &$isOK: Boolean whether the user is allowed to use the panel
1017
1018 StartAdminPanelNav: Before displaying the first item in the list of admin panels
1019 - $nav The AdminPanelNav widget
1020
1021 EndAdminPanelNav: After displaying the last item in the list of admin panels
1022 - $nav The AdminPanelNav widget
1023
1024 StartActivityObjectFromNotice: When converting a notice to an activity:object
1025 - $notice: The notice being converted
1026 - &$object: The resulting object. Fill this and return false to override defaults.
1027
1028 EndActivityObjectFromNotice: After converting a notice to an activity:object
1029 - $notice: The notice being converted
1030 - &$object: The resulting object. Can be edited
1031
1032 StartActivityObjectFromProfile: When converting a profile to an activity:object
1033 - $profile: The profile being converted
1034 - &$object: The (empty) object. Fill it up and return false to override defaults.
1035
1036 EndActivityObjectFromProfile: After converting a profile to an activity:object
1037 - $profile: The profile being converted
1038 - &$object: The finished object. Can be tweaked
1039
1040 StartActivityObjectFromGroup: When converting a group to an activity:object
1041 - $group: The group being converted
1042 - &$object: The (empty) object. Fill and return false to override.
1043
1044 EndActivityObjectFromGroup:  After converting a group to an activity:object
1045 - $group:  The group being converted
1046 - &$object: The finished object. Tweak as needed.
1047
1048 StartImportActivity: when we start to import an activity
1049 - $user: User to make the author import
1050 - $author: Author of the feed; good for comparisons
1051 - $activity: The current activity
1052 - $trusted: How "trusted" the process is
1053 - &$done: Return value; whether to continue
1054
1055 EndImportActivity: when we finish importing an activity
1056 - $user: User to make the author import
1057 - $author: Author of the feed; good for comparisons
1058 - $activity: The current activity
1059 - $trusted: How "trusted" the process is
1060
1061 StartProfileSettingsActions: when we're showing account-management action list
1062 - $action: Action being shown (use for output)
1063
1064 EndProfileSettingsActions: when we're showing account-management action list
1065 - $action: Action being shown (use for output)
1066
1067 StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
1068 - $nli: The notice list item being shown
1069
1070 EndOpenNoticeListItemElement: After the opening <li> of a notice list element
1071 - $nli: The notice list item being shown
1072
1073 StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
1074 - $nli: The notice list item being shown
1075
1076 EndCloseNoticeListItemElement: After the closing </li> of a notice list element
1077 - $nli: The notice list item being shown
1078
1079 StartGroupEditFormData: Beginning the group edit form entries
1080 - $form: The form widget being shown
1081
1082 EndGroupEditFormData: Ending the group edit form entries
1083 - $form: The form widget being shown
1084
1085 StartGroupSave: After initializing but before saving a group
1086 - &$group: group about to be saved
1087
1088 EndGroupSave: After saving a group, aliases, and first member
1089 - $group: group that was saved
1090
1091 StartInterpretCommand: Before running a command
1092 - $cmd: First word in the string, 'foo' in 'foo argument' 
1093 - $arg: Argument, if any, like 'argument' in 'foo argument'
1094 - $user: User who issued the command
1095 - &$result: Resulting command; you can set this!
1096
1097 EndInterpretCommand: Before running a command
1098 - $cmd: First word in the string, 'foo' in 'foo argument' 
1099 - $arg: Argument, if any, like 'argument' in 'foo argument'
1100 - $user: User who issued the command
1101 - $result: Resulting command
1102
1103 StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
1104 - $action: action being executed (for output and params)
1105 - $group: group for the page
1106
1107 EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
1108 - $action: action being executed (for output and params)
1109 - $group: group for the page
1110
1111 StartGroupProfileElements: Start showing stuff about the group on its profile page
1112 - $action: action being executed (for output and params)
1113 - $group: group for the page
1114                            
1115 EndGroupProfileElements: Start showing stuff about the group on its profile page
1116 - $action: action being executed (for output and params)
1117 - $group: group for the page