]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - EVENTS.txt
Merge branch 'master' into 0.9.x
[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 StartShowHeadElements: Right after the <head> tag
383 - $action: the current action
384
385 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
386 - $action: the current action
387
388 CheckSchema: chance to check the schema
389
390 StartProfileRemoteSubscribe: Before showing the link to remote subscription
391 - $userprofile: UserProfile widget
392 - &$profile: the profile being shown
393
394 EndProfileRemoteSubscribe: After showing the link to remote subscription
395 - $userprofile: UserProfile widget
396 - &$profile: the profile being shown
397
398 StartGroupSubscribe: Before showing the link to remote subscription
399 - $action: the current action
400 - $group: the group being shown
401
402 EndGroupSubscribe: After showing the link to remote subscription
403 - $action: the current action
404 - $group: the group being shown
405
406 StartProfilePageProfileSection: Starting to show the section of the
407                               profile page with the actual profile data;
408                               hook to prevent showing the profile (e.g.)
409 - $userprofile: UserProfile widget
410 - &$profile: the profile being shown
411
412 StartProfilePageProfileElements: inside the section, before the first
413                                element; prepend elements here
414 - $userprofile: UserProfile widget
415 - &$profile: the profile being shown
416
417 EndProfilePageProfileElements: inside the section, after the last element;
418                              append elements here
419 - $userprofile: UserProfile widget
420 - &$profile: the profile being shown
421
422 EndProfilePageProfileSection: After showing the section of the profile
423                             page with the profile elements
424 - $userprofile: UserProfile widget
425 - &$profile: the profile being shown
426
427 StartProfilePageActionsSection: Starting to show the section of the
428                                     profile page with action links; hook
429                                     to hide them (for example)
430 - $userprofile: UserProfile widget
431 - &$profile: the profile being shown
432
433 StartProfilePageActionsElements: inside the list, before the first
434                                      element; prepend elements here
435 - $userprofile: UserProfile widget
436 - &$profile: the profile being shown
437
438 EndProfilePageActionsElements: inside the list, after the last element;
439                                    append elements here
440 - $userprofile: UserProfile widget
441 - &$profile: the profile being shown
442
443 EndProfilePageActionsSection: After showing the section of the profile
444                                   page with the entity actions
445 - $userprofile: UserProfile widget
446 - &$profile: the profile being shown
447
448 StartProfilePageAvatar: before showing the avatar on the profile page
449 - $userprofile: UserProfile widget
450 - &$profile: the profile being shown
451
452 EndProfilePageAvatar: after showing the avatar on the profile page
453 - $userprofile: UserProfile widget
454 - &$profile: the profile being shown
455
456 StartProfilePageNickname: before showing the nickname on the profile page
457 - $userprofile: UserProfile widget
458 - &$profile: the profile being shown
459
460 EndProfilePageNickname: after showing the nickname on the profile page
461 - $userprofile: UserProfile widget
462 - &$profile: the profile being shown
463
464 StartProfilePageFullName: before showing the fullname on the profile page
465 - $userprofile: UserProfile widget
466 - &$profile: the profile being shown
467
468 EndProfilePageFullName: after showing the fullname on the profile page
469 - $userprofile: UserProfile widget
470 - &$profile: the profile being shown
471
472 StartProfilePageLocation: before showing the location on the profile page
473 - $userprofile: UserProfile widget
474 - &$profile: the profile being shown
475
476 EndProfilePageLocation: after showing the location on the profile page
477 - $userprofile: UserProfile widget
478 - &$profile: the profile being shown
479
480 StartProfilePageHomepage: before showing the homepage link on the profile page
481 - $userprofile: UserProfile widget
482 - &$profile: the profile being shown
483
484 EndProfilePageHomepage: after showing the homepage on the profile page
485 - $userprofile: UserProfile widget
486 - &$profile: the profile being shown
487
488 StartProfilePageBio: before showing the bio on the profile page
489 - $userprofile: UserProfile widget
490 - &$profile: the profile being shown
491
492 EndProfilePageBio: after showing the bio on the profile page
493 - $userprofile: UserProfile widget
494 - &$profile: the profile being shown
495
496 StartProfilePageProfileTags: before showing the tags on the profile page
497 - $userprofile: UserProfile widget
498 - &$profile: the profile being shown
499
500 EndProfilePageProfileTags: after showing the tags on the profile page
501 - $userprofile: UserProfile widget
502 - &$profile: the profile being shown
503
504 StartProfileList: when starting a list of profiles (before <ul>)
505 - $profilelist: ProfileList widget, with $profile, $action, and $out
506
507 EndProfileList: when ending a list of profiles (after </ul>)
508 - $profilelist: ProfileList widget
509
510 StartProfileListItem: when starting to show a profile list item
511 - $item: ProfileListItem widget
512
513 EndProfileListItem: after showing a profile list item
514 - $item: ProfileListItem widget
515
516 StartProfileListItemProfile: the profile data part of the item
517 - $item: ProfileListItem widget
518
519 EndProfileListItemProfile: the profile data part of the item
520 - $item: ProfileListItem widget
521
522 StartProfileListItemActions: the actions (buttons) for an item
523 - $item: ProfileListItem widget
524
525 EndProfileListItemActions: the actions (buttons) for an item
526 - $item: ProfileListItem widget
527
528 StartProfileListItemProfileElements: inside the <div>
529 - $item: ProfileListItem widget
530
531 EndProfileListItemProfileElements: inside the <div>
532 - $item: ProfileListItem widget
533
534 StartProfileListItemAvatar: Showing a profile list avatar
535 - $item: ProfileListItem widget
536
537 EndProfileListItemAvatar: Showing a profile list avatar
538 - $item: ProfileListItem widget
539
540 StartProfileListItemFullName: Showing the profile list full name
541 - $item: ProfileListItem widget
542
543 EndProfileListItemFullName: Showing the profile list full name
544 - $item: ProfileListItem widget
545
546 StartProfileListItemLocation: Showing the profile list location
547 - $item: ProfileListItem widget
548
549 EndProfileListItemLocation: Showing the profile list location
550 - $item: ProfileListItem widget
551
552 StartProfileListItemHomepage: Showing the profile list homepage
553 - $item: ProfileListItem widget
554
555 EndProfileListItemHomepage: Showing the profile list homepage
556 - $item: ProfileListItem widget
557
558 StartProfileListItemBio: Showing the profile list bio
559 - $item: ProfileListItem widget
560
561 EndProfileListItemBio: Showing the profile list bio
562 - $item: ProfileListItem widget
563
564 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
565 - $item: ProfileListItem widget
566
567 EndProfileListItemActionElements: Showing profile list actions (append a button here)
568 - $item: ProfileListItem widget
569
570 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
571 - $action: the current action
572 - &$xrdsoutputter - XRDSOutputter object to write to
573
574 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
575 - $action: the current action
576 - &$xrdsoutputter - XRDSOutputter object to write to
577
578 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
579 - $action: the current action
580 - &$xrdsoutputter - XRDSOutputter object to write to
581
582 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
583 - $action: the current action
584 - &$xrdsoutputter - XRDSOutputter object to write to
585
586 StartCheckPassword: Check a username/password
587 - $nickname: The nickname to check
588 - $password: The password to check
589 - &$authenticatedUser: set to User object if credentials match a user.
590
591 EndCheckPassword: After checking a username/password pair
592 - $nickname: The nickname that was checked
593 - $password: The password that was checked
594 - $authenticatedUser: User object if credentials match a user, else null.
595
596 StartChangePassword: Before changing a password
597 - $user: user
598 - $oldpassword: the user's old password
599 - $newpassword: the desired new password
600
601 EndChangePassword: After changing a password
602 - $user: user
603
604 StartSetUser: Before setting the currently logged in user
605 - $user: user
606
607 EndSetUser: After setting the currently logged in user
608 - $user: user
609
610 StartSetApiUser: Before setting the current API user
611 - $user: user
612
613 EndSetApiUser: After setting the current API user
614 - $user: user
615
616 StartHasRole: Before determing if the a profile has a given role
617 - $profile: profile in question
618 - $name: name of the role in question
619 - &$has_role: does this profile have the named role?
620
621 EndHasRole: Before determing if the a profile has a given role
622 - $profile: profile in question
623 - $name: name of the role in question
624 - $has_role: does this profile have the named role?
625
626 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
627 - $user: User object
628 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
629
630 GetUrlShorteners: Specify URL shorteners that are available for use
631 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
632
633 StartShortenUrl: About to shorten a URL
634 - $url: url to be shortened
635 - $shortenerName: name of the requested shortener
636 - &$shortenedUrl: short version of the url
637
638 EndShortenUrl: After a URL has been shortened
639 - $url: url to be shortened
640 - $shortenerName: name of the requested shortener
641 - $shortenedUrl: short version of the url
642
643 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
644 - $action
645 - &$src
646 - &$theme
647 - &$media
648
649 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
650 - $action
651 - $src
652 - $theme
653 - $media
654
655 StartStyleElement: Before a <style...> element is written
656 - $action
657 - &$code
658 - &$type
659 - &$media
660
661 EndStyleElement: After a <style...> element is written
662 - $action
663 - $code
664 - $type
665 - $media
666
667 StartScriptElement: Before a <script...> element is written
668 - $action
669 - &$src
670 - &$type
671
672 EndScriptElement: After a <script...> element is written
673 - $action
674 - $src
675 - $type
676
677 StartInlineScriptElement: Before a <script...> element is written
678 - $action
679 - &$code
680 - &$type
681
682 EndInlineScriptElement: After a <script...> element is written
683 - $action
684 - $code
685 - $type
686
687 StartLog: Before writing to the logs
688 - &$priority
689 - &$msg
690 - &$filename
691
692 EndLog: After writing to the logs
693 - $priority
694 - $msg
695 - $filename
696
697 StartBlockProfile: when we're about to block
698 - $user: the person doing the block
699 - $profile: the person getting blocked, can be remote
700
701 EndBlockProfile: when a block has succeeded
702 - $user: the person doing the block
703 - $profile: the person blocked, can be remote
704
705 StartUnblockProfile: when we're about to unblock
706 - $user: the person doing the unblock
707 - $profile: the person getting unblocked, can be remote
708
709 EndUnblockProfile: when an unblock has succeeded
710 - $user: the person doing the unblock
711 - $profile: the person unblocked, can be remote
712
713 StartSubscribe: when a subscription is starting
714 - $user: the person subscribing
715 - $other: the person being subscribed to
716
717 EndSubscribe: when a subscription is finished
718 - $user: the person subscribing
719 - $other: the person being subscribed to
720
721 StartUnsubscribe: when an unsubscribe is starting
722 - $user: the person unsubscribing
723 - $other: the person being unsubscribed from
724
725 EndUnsubscribe: when an unsubscribe is done
726 - $user: the person unsubscribing
727 - $other: the person being unsubscribed to
728
729 StartJoinGroup: when a user is joining a group
730 - $group: the group being joined
731 - $user: the user joining
732
733 EndJoinGroup: when a user finishes joining a group
734 - $group: the group being joined
735 - $user: the user joining
736
737 StartLeaveGroup: when a user is leaving a group
738 - $group: the group being left
739 - $user: the user leaving
740
741 EndLeaveGroup: when a user has left a group
742 - $group: the group being left
743 - $user: the user leaving
744
745 StartShowContentLicense: Showing the default license for content
746 - $action: the current action
747
748 EndShowContentLicense: Showing the default license for content
749 - $action: the current action
750
751 StartUserRegister: When a new user is being registered
752 - &$profile: new profile data (no ID)
753 - &$user: new user account (no ID or URI)
754
755 EndUserRegister: When a new user has been registered
756 - &$profile: new profile data
757 - &$user: new user account
758
759 StartRobotsTxt: Before outputting the robots.txt page
760 - &$action: RobotstxtAction being shown
761
762 EndRobotsTxt: After the default robots.txt page (good place for customization)
763 - &$action: RobotstxtAction being shown
764
765 StartGetProfileUri: When determining the canonical URI for a given profile
766 - $profile: the current profile
767 - &$uri: the URI
768
769 EndGetProfileUri: After determining the canonical URI for a given profile
770 - $profile: the current profile
771 - &$uri: the URI
772
773 StartFavorNotice: Saving a notice as a favorite
774 - $profile: profile of the person faving (can be remote!)
775 - $notice: notice being faved
776 - &$fave: Favor object; null to start off with, but feel free to override.
777
778 EndFavorNotice: After saving a notice as a favorite
779 - $profile: profile of the person faving (can be remote!)
780 - $notice: notice being faved
781
782 StartDisfavorNotice: Saving a notice as a favorite
783 - $profile: profile of the person faving (can be remote!)
784 - $notice: notice being faved
785 - &$result: result of the disfavoring (if you override)
786
787 EndDisfavorNotice: After saving a notice as a favorite
788 - $profile: profile of the person faving (can be remote!)
789 - $notice: notice being faved
790
791 StartFavorNoticeForm: starting the data in the form for favoring a notice
792 - $FavorForm: the favor form being shown
793 - $notice: notice being favored
794
795 EndFavorNoticeForm: Ending the data in the form for favoring a notice
796 - $FavorForm: the favor form being shown
797 - $notice: notice being favored
798
799 StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
800 - $DisfavorForm: the disfavor form being shown
801 - $notice: notice being difavored
802
803 EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
804 - $DisfavorForm: the disfavor form being shown
805 - $notice: notice being disfavored
806
807 StartFindMentions: start finding mentions in a block of text
808 - $sender: sender profile
809 - $text: plain text version of the notice
810 - &$mentions: mentions found so far. Array of arrays; each array
811   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
812   'title' (title of the link), 'position' (position of the text to
813   replace), 'text' (text to replace)
814
815 EndFindMentions: end finding mentions in a block of text
816 - $sender: sender profile
817 - $text: plain text version of the notice
818 - &$mentions: mentions found so far. Array of arrays; each array
819   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
820   'title' (title of the link), 'position' (position of the text to
821   replace), 'text' (text to replace)
822
823 StartShowSubscriptionsContent: before showing the subscriptions content
824 - $action: the current action
825
826 EndShowSubscriptionsContent: after showing the subscriptions content
827 - $action: the current action
828
829 StartShowUserGroupsContent: before showing the user groups content
830 - $action: the current action
831
832 EndShowUserGroupsContent: after showing the user groups content
833 - $action: the current action
834
835 StartShowAllContent: before showing the all (you and friends) content
836 - $action: the current action
837
838 EndShowAllContent: after showing the all (you and friends) content
839 - $action: the current action
840
841 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
842 - $action: the current action
843
844 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
845 - $action: the current action
846
847 StartShowGroupsMiniList: at the start of groups mini list
848 - $action: the current action
849
850 EndShowGroupsMiniList: at the end of groups mini list
851 - $action: the current action
852
853 StartDeleteUserForm: starting the data in the form for deleting a user
854 - $action: action being shown
855 - $user: user being deleted
856
857 EndDeleteUserForm: Ending the data in the form for deleting a user
858 - $action: action being shown
859 - $user: user being deleted
860
861 StartDeleteUser: handling the post for deleting a user
862 - $action: action being shown
863 - $user: user being deleted
864
865 EndDeleteUser: handling the post for deleting a user
866 - $action: action being shown
867 - $user: user being deleted
868
869 StartActivityStart: starting the output for a notice activity <event>
870 - &$notice: notice being output
871 - &$xs: XMLStringer for output
872 - &$attrs: <entry> attributes (mostly namespace declarations, if any)
873
874 EndActivityStart: end the opening tag for an activity <event>
875 - &$notice: notice being output
876 - &$xs: XMLStringer for output
877 - $attrs: <entry> attributes (mostly namespace declarations, if any)
878
879 StartActivitySource: before outputting the <source> element for a notice activity
880 - &$notice: notice being output
881 - &$xs: XMLStringer for output
882
883 EndActivitySource: after outputting the <source> element for a notice activity
884 - &$notice: notice being output
885 - &$xs: XMLStringer for output
886
887 StartActivityTitle: before outputting notice activity title
888 - &$notice: notice being output
889 - &$xs: XMLStringer for output
890 - &$title: title of the notice, mutable
891
892 EndActivityTitle: after outputting notice activity title
893 - $notice: notice being output
894 - &$xs: XMLStringer for output
895 - $title: title of the notice
896
897 StartActivityAuthor: before outputting atom author
898 - &$notice: notice being output
899 - &$xs: XMLStringer for output
900 - &$atomAuthor: string for XML representing atom author
901
902 EndActivityAuthor: after outputting atom author
903 - &$notice: notice being output
904 - &$xs: XMLStringer for output
905 - &$atomAuthor: string for XML representing atom author
906
907 StartActivityActor: before outputting activity actor element for a notice activity entry
908 - &$notice: notice being output
909 - &$xs: XMLStringer for output
910 - &$actor: string for XML representing activity actor
911
912 EndActivityActor: after outputting activity actor element for a notice activity entry
913 - &$notice: notice being output
914 - &$xs: XMLStringer for output
915 - &$actor: string for XML representing activity actor
916
917 StartActivityLink: before outputting activity HTML link element for a notice activity entry
918 - &$notice: notice being output
919 - &$xs: XMLStringer for output
920 - &$url: URL for activity HTML link element for a notice activity entry
921
922 EndActivityLink: before outputting activity HTML link element for a notice activity entry
923 - &$notice: notice being output
924 - &$xs: XMLStringer for output
925 - $url:  URL for activity HTML link element for a notice activity entry
926
927 StartActivityId: before outputting atom:id element for a notice activity entry
928 - &$notice: notice being output
929 - &$xs: XMLStringer for output
930 - &$id: atom:id (notice URI by default)
931
932 EndActivityId: after outputting atom:id element for a notice activity entry
933 - &$notice: notice being output
934 - &$xs: XMLStringer for output
935 - $id:  atom:id (notice URI by default)
936
937 StartActivityPublished: before outputting atom:published element for a notice activity entry
938 - &$notice: notice being output
939 - &$xs: XMLStringer for output
940 - &$published: atom:published value (notice created by default)
941
942 EndActivityPublished: before outputting atom:published element for a notice activity entry
943 - &$notice: notice being output
944 - &$xs: XMLStringer for output
945 - $published:  atom:published value (notice created by default)
946
947 StartActivityUpdated: before outputting atom:updated element for a notice activity entry
948 - &$notice: notice being output
949 - &$xs: XMLStringer for output
950 - &$updated: atom:updated value (same as atom:published by default)
951
952 EndActivityUpdated: after outputting atom:updated element for a notice activity entry
953 - &$notice: notice being output
954 - &$xs: XMLStringer for output
955 - $updated: atom:updated value (same as atom:published by default)
956
957 StartActivityContent: before outputting atom:content element for a notice activity entry
958 - &$notice: notice being output
959 - &$xs: XMLStringer for output
960 - &$content: atom:content value (notice rendered HTML by default)
961
962 EndActivityContent: after outputting atom:content element for a notice activity entry
963 - &$notice: notice being output
964 - &$xs: XMLStringer for output
965 - $content: atom:content value (notice rendered HTML by default)
966
967 StartActivityVerb: before outputting activity:verb element for a notice activity entry
968 - &$notice: notice being output
969 - &$xs: XMLStringer for output
970 - &$verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
971
972 EndActivityVerb: after outputting activity:verb element for a notice activity entry
973 - &$notice: notice being output
974 - &$xs: XMLStringer for output
975 - $verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
976
977 StartActivityDefaultObjectType: before outputting activity:object-type element for a notice activity entry
978 - &$notice: notice being output
979 - &$xs: XMLStringer for output
980 - &$type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
981
982 EndActivityDefaultObjectType: after outputting activity:verb element for a notice activity entry
983 - &$notice: notice being output
984 - &$xs: XMLStringer for output
985 - $type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
986
987 StartActivityObjects: before outputting activity:object elements for a notice activity entry
988 - &$notice: notice being output
989 - &$xs: XMLStringer for output
990 - &$objects: array of ActivityObject objects to output (empty by default)
991
992 EndActivityObjects: after outputting activity:object elements for a notice activity entry
993 - &$notice: notice being output
994 - &$xs: XMLStringer for output
995 - $objects: array of ActivityObject objects to output (empty by default)
996
997 StartActivityNoticeInfo: before outputting statusnet:notice-info element for a notice activity entry
998 - &$notice: notice being output
999 - &$xs: XMLStringer for output
1000 - &$noticeInfoAttr: array of attributes for notice info element
1001
1002 EndActivityNoticeInfo: after outputting statusnet:notice-info element for a notice activity entry
1003 - &$notice: notice being output
1004 - &$xs: XMLStringer for output
1005 - $noticeInfoAttr: array of attributes for notice info element
1006
1007 StartActivityInReplyTo: before outputting thr:in-reply-to element for a notice activity entry
1008 - &$notice: notice being output
1009 - &$xs: XMLStringer for output
1010 - &$replyNotice: Notice object the main notice is in-reply-to
1011
1012 EndActivityInReplyTo: after outputting thr:in-reply-to element for a notice activity entry
1013 - &$notice: notice being output
1014 - &$xs: XMLStringer for output
1015 - $replyNotice: Notice object the main notice is in-reply-to
1016
1017 StartActivityConversation: before outputting ostatus:conversation link element for a notice activity entry
1018 - &$notice: notice being output
1019 - &$xs: XMLStringer for output
1020 - &$conv: Conversation object
1021
1022 EndActivityConversation: after outputting ostatus:conversation link element for a notice activity entry
1023 - &$notice: notice being output
1024 - &$xs: XMLStringer for output
1025 - $conv: Conversation object
1026
1027 StartActivityAttentionProfiles: before outputting ostatus:attention link element for people in a notice activity entry
1028 - &$notice: notice being output
1029 - &$xs: XMLStringer for output
1030 - &$replyProfiles: array of profiles of people being replied to
1031
1032 EndActivityAttentionProfiles: after outputting ostatus:attention link element for people in a notice activity entry
1033 - &$notice: notice being output
1034 - &$xs: XMLStringer for output
1035 - $replyProfiles: array of Profile object of people being replied to
1036
1037 StartActivityAttentionGroups: before outputting ostatus:attention link element for groups in a notice activity entry
1038 - &$notice: notice being output
1039 - &$xs: XMLStringer for output
1040 - &$groups: array of Group objects of groups being addressed
1041
1042 EndActivityAttentionGroups: after outputting ostatus:attention link element for groups in a notice activity entry
1043 - &$notice: notice being output
1044 - &$xs: XMLStringer for output
1045 - $groups: array of Group objects of groups being addressed
1046
1047 StartActivityForward: before outputting ostatus:forward link element in a notice activity entry
1048 - &$notice: notice being output
1049 - &$xs: XMLStringer for output
1050 - &$repeat: Notice that was repeated
1051
1052 EndActivityForward: after outputting ostatus:forward link element in a notice activity entry
1053 - &$notice: notice being output
1054 - &$xs: XMLStringer for output
1055 - $repeat: Notice that was repeated
1056
1057 StartActivityCategories: before outputting atom:category elements in a notice activity entry
1058 - &$notice: notice being output
1059 - &$xs: XMLStringer for output
1060 - &$tags: array of strings for tags on the notice (used for categories)
1061
1062 EndActivityCategories: after outputting atom:category elements in a notice activity entry
1063 - &$notice: notice being output
1064 - &$xs: XMLStringer for output
1065 - $tags: array of strings for tags on the notice (used for categories)
1066
1067 StartActivityEnclosures: before outputting enclosure link elements in a notice activity entry
1068 - &$notice: notice being output
1069 - &$xs: XMLStringer for output
1070 - &$enclosures: array of enclosure objects (see File::getEnclosure() for details)
1071
1072 EndActivityEnclosures: after outputting enclosure link elements in a notice activity entry
1073 - &$notice: notice being output
1074 - &$xs: XMLStringer for output
1075 - $enclosures: array of enclosure objects (see File::getEnclosure() for details)
1076
1077 StartActivityGeo: before outputting geo:rss element in a notice activity entry
1078 - &$notice: notice being output
1079 - &$xs: XMLStringer for output
1080 - &$lat: latitude
1081 - &$lon: longitude
1082
1083 EndActivityGeo: after outputting geo:rss element in a notice activity entry
1084 - &$notice: notice being output
1085 - &$xs: XMLStringer for output
1086 - $lat: latitude
1087 - $lon: longitude
1088
1089 StartActivityEnd: before the closing </entry> in a notice activity entry (last chance for data!)
1090 - &$notice: notice being output
1091 - &$xs: XMLStringer for output
1092
1093 EndActivityEnd: after the closing </entry> in a notice activity entry
1094 - &$notice: notice being output
1095 - &$xs: XMLStringer for output
1096
1097 StartNoticeSaveWeb: before saving a notice through the Web interface
1098 - $action: action being executed (instance of NewNoticeAction)
1099 - &$authorId: integer ID of the author
1100 - &$text: text of the notice
1101 - &$options: additional options (location, replies, etc.)
1102
1103 EndNoticeSaveWeb: after saving a notice through the Web interface
1104 - $action: action being executed (instance of NewNoticeAction)
1105 - $notice: notice that was saved
1106
1107 StartRssEntryArray: at the start of copying a notice to an array
1108 - $notice: the notice being copied
1109 - &$entry: the entry (empty at beginning)
1110
1111 EndRssEntryArray: at the end of copying a notice to an array
1112 - $notice: the notice being copied
1113 - &$entry: the entry, with all the fields filled up
1114
1115 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
1116 - $notice: notice being deleted
1117
1118 StartShowHeadTitle: when beginning to show the <title> element
1119 - $action: action being shown
1120
1121 EndShowHeadTitle: when done showing the <title>
1122 - $action: action being shown
1123
1124 StartShowPageTitle: when beginning to show the page title <h1>
1125 - $action: action being shown
1126
1127 EndShowPageTitle: when done showing the page title <h1>
1128 - $action: action being shown
1129
1130 StartDeleteOwnNotice: when a user starts to delete their own notice
1131 - $user: the user doing the delete
1132 - $notice: the notice being deleted
1133
1134 EndDeleteOwnNotice: when a user has deleted their own notice
1135 - $user: the user doing the delete
1136 - $notice: the notice being deleted
1137
1138 StartShowFeedLinkList: before showing the feed list in the sidebar
1139 - $action: action being executed
1140 - $feeds: list of feeds to show
1141
1142 EndShowFeedLinkList: after showing the feed list in the sidebar
1143 - $action: action being executed
1144 - $feeds: list of feeds shown
1145
1146 StartShowFeedLink: before showing an individual feed item
1147 - $action: action being executed
1148 - $feed: feed to show
1149
1150 EndShowFeedLink: after showing an individual feed
1151 - $action: action being executed
1152 - $feed: feed to show
1153
1154 StartShowNoticeForm: before showing the notice form (before <form>)
1155 - $action: action being executed
1156
1157 EndShowNoticeForm: after showing the notice form (after <form>)
1158 - $action: action being executed
1159
1160 StartGrantRole: when a role is being assigned
1161 - $profile: profile that will have the role
1162 - $role: string name of the role
1163
1164 EndGrantRole: when a role has been successfully assigned
1165 - $profile: profile that will have the role
1166 - $role: string name of the role
1167
1168 StartRevokeRole: when a role is being revoked
1169 - $profile: profile that will lose the role
1170 - $role: string name of the role
1171
1172 EndRevokeRole: when a role has been revoked
1173 - $profile: profile that lost the role
1174 - $role: string name of the role
1175
1176 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
1177 - &$activity: received activity
1178
1179 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
1180 - $activity: received activity
1181 - $notice: notice that was created
1182