1 InitializePlugin: a chance to initialize a plugin in a complete environment
3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
5 StartPrimaryNav: Showing the primary nav menu
6 - $action: the current action
8 EndPrimaryNav: At the end of the primary nav menu
9 - $action: the current action
11 StartSecondaryNav: Showing the secondary nav menu
12 - $action: the current action
14 EndSecondaryNav: At the end of the secondary nav menu
15 - $action: the current action
17 StartShowStyles: Showing Style links; good place to add UA style resets
18 - $action: the current action
20 EndShowStyles: End showing Style links; good place to add custom styles
21 - $action: the current action
23 StartShowStylesheets: Showing stylesheet links
24 - $action: the current action
26 EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
27 - $action: the current action
29 StartShowUAStyles: Showing custom User-Agent style links
30 - $action: the current action
32 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
33 - $action: the current action
35 StartShowScripts: Showing JavaScript links
36 - $action: the current action
38 EndShowScripts: End showing JavaScript links; good place to add custom
39 links like Google Analytics
40 - $action: the current action
42 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
43 - $action: the current action
45 EndShowJQueryScripts: End showing JQuery script links
46 - $action: the current action
48 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
49 - $action: the current action
51 EndShowStatusNetScripts: End showing StatusNet script links
52 - $action: the current action
54 StartShowSections: Start the list of sections in the sidebar
55 - $action: the current action
57 EndShowSections: End the list of sections in the sidebar
58 - $action: the current action
60 StartShowHeader: Showing before the header container
61 - $action: the current action
63 EndShowHeader: Showing after the header container
64 - $action: the current action
66 StartShowFooter: Showing before the footer container
67 - $action: the current action
69 EndShowFooter: Showing after the footer container
70 - $action: the current action
72 StartShowContentBlock: Showing before the content container
73 - $action: the current action
75 EndShowContentBlock: Showing after the content container
76 - $action: the current action
78 StartShowAside: Showing before the Aside container
79 - $action: the current action
81 EndShowAside: Showing after the Aside container
82 - $action: the current action
84 StartShowNoticeFormData: Showing before the notice form data
85 - $action: the current action
87 EndShowNoticeFormData: Showing after the notice form data
88 - $action: the current action
90 StartNoticeSave: before inserting a notice (good place for content filters)
91 - $notice: notice being saved (no ID or URI)
93 EndNoticeSave: after inserting a notice and related code
94 - $notice: notice that was saved (with ID and URI)
96 StartShowLocalNavBlock: Showing the local nav menu
97 - $action: the current action
99 EndShowLocalNavBlock: At the end of the local nav menu
100 - $action: the current action
102 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
103 - $action: the current action
105 EndShowHTML: Showing after the html element
106 - $action: the current action
108 StartPublicGroupNav: Showing the public group nav menu
109 - $menu: the menu widget; use $menu->action for output
111 EndPublicGroupNav: At the end of the public group nav menu
112 - $menu: the menu widget; use $menu->action for output
114 StartSubGroupNav: Showing the subscriptions group nav menu
115 - $menu: the menu widget; use $menu->action for output
117 EndSubGroupNav: At the end of the subscriptions group nav menu
118 - $menu: the menu widget; use $menu->action for output
120 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
121 - $m: the Net_URL_Mapper that has just been set up
123 RouterInitialized: After the router instance has been initialized
124 - $m: the Net_URL_Mapper that has just been set up
126 StartLogout: Before logging out
127 - $action: the logout action
129 EndLogout: After logging out
130 - $action: the logout action
132 ArgsInitialize: After the argument array has been initialized
133 - $args: associative array of arguments, can be modified
135 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
136 - $action: the current action
138 EndAddressData: At the end of <address>
139 - $action: the current action
141 StartShowSiteNotice: Before showing site notice
142 - $action: the current action
144 EndShowSiteNotice: After showing site notice
145 - $action: the current action
147 StartLoginGroupNav: Before showing the login and register navigation menu
148 - $action: the current action
150 EndLoginGroupNav: After showing the login and register navigation menu
151 - $action: the current action
153 StartAccountSettingsNav: Before showing the account settings menu
154 - $action: the current action
156 EndAccountSettingsNav: After showing the account settings menu
157 - $action: the current action
159 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
160 - $widget: AccountSettingsNav instance being shown
162 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
163 - $widget: AccountSettingsNav instance being shown
165 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
166 - $widget: AccountSettingsNav instance being shown
168 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
169 - $widget: AccountSettingsNav instance being shown
171 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
172 - $widget: AccountSettingsNav instance being shown
174 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
175 - $widget: AccountSettingsNav instance being shown
177 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
178 - $widget: AccountSettingsNav instance being shown
180 EndAccountSettingsEmailMenuItem: After showing the Email menu item
181 - $widget: AccountSettingsNav instance being shown
183 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
184 - $widget: AccountSettingsNav instance being shown
186 EndAccountSettingsDesignMenuItem: After showing the Design menu item
187 - $widget: AccountSettingsNav instance being shown
189 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
190 - $widget: AccountSettingsNav instance being shown
192 EndAccountSettingsOtherMenuItem: After showing the Other menu item
193 - $widget: AccountSettingsNav instance being shown
195 Autoload: When trying to autoload a class
196 - $cls: the class being sought. A plugin might require_once the file for the class.
198 SensitiveAction: determines if an action is 'sensitive' and should use SSL
199 - $action: name of the action, like 'login'
200 - $sensitive: flag for whether this is a sensitive action
202 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
203 - $action: name of the action, like 'register'
204 - $login: flag for whether this is a login action
206 StartShowHead: called before showing the <head> element and children
207 - $action: action object being show
209 EndShowHead: called after showing the <head> element (and </head>)
210 - $action: action object being shown
212 StartShowBody: called before showing the <body> element and children
213 - $action: action object being shown
215 EndShowBody: called after showing the <body> element (and </body>)
216 - $action: action object being shown
218 StartPersonalGroupNav: beginning of personal group nav menu
219 - $action: action object being shown
221 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
222 - $action: action object being shown
224 StartGroupGroupNav: Showing the group nav menu
225 - $action: the current action
227 EndGroupGroupNav: At the end of the group nav menu
228 - $action: the current action
230 StartEndHTML: just before the </html> tag
231 - $action: action object being shown
233 EndEndHTML: just after the </html> tag
234 - $action: action object being shown
236 StartShowDesign: just before showing a site, user, or group design
237 - $action: action object being shown
239 EndShowDesign: just after showing a site, user, or group design
240 - $action: action object being shown
242 StartShowExportData: just before showing the <div> with export data (feeds)
243 - $action: action object being shown
245 EndShowExportData: just after showing the <div> with export data (feeds)
246 - $action: action object being shown
248 StartShowNoticeItem: just before showing the notice item
249 - $item: The NoticeListItem object being shown
251 EndShowNoticeItem: just after showing the notice item
252 - $item: the NoticeListItem object being shown
254 StartShowNoticeInfo: just before showing notice info
255 - $item: The NoticeListItem object being shown
257 EndShowNoticeInfo: just after showing notice info
258 - $item: The NoticeListItem object being shown
260 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
261 - $item: the NoticeListItem object being shown
263 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
264 - $item: the NoticeListItem object being shown
266 StartShowFaveForm: just before showing the fave form
267 - $item: the NoticeListItem object being shown
269 EndShowFaveForm: just after showing the fave form
270 - $item: the NoticeListItem object being shown
272 StartShowPageNotice: just before showing the page notice (instructions or error)
273 - $action: action object being shown
275 EndShowPageNotice: just after showing the page notice (instructions or error)
276 - $action: action object being shown
278 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
279 - $action: action object being shown
281 StartProfileFormData: just before showing text entry fields on profile settings page
282 - $action: action object being shown
284 EndProfileFormData: just after showing text entry fields on profile settings page
285 - $action: action object being shown
287 StartProfileSaveForm: before starting to save a profile settings form
288 - $action: action object being shown
290 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
291 - $action: action object being shown
293 StartEmailFormData: just before showing text entry fields on email settings page
294 - $action: action object being shown
296 EndEmailFormData: just after showing text entry fields on email settings page
297 - $action: action object being shown
299 StartEmailSaveForm: before starting to save a email settings form
300 - $action: action object being shown
301 - &$user: user being saved
303 EndEmailSaveForm: after saving a email settings form (after commit)
304 - $action: action object being shown
305 - &$user: user being saved
307 StartRegistrationFormData: just before showing text entry fields on registration page
308 - $action: action object being shown
310 EndRegistrationFormData: just after showing text entry fields on registration page
311 - $action: action object being shown
313 StartRegistrationTry: before validating and saving a new user
314 - $action: action object being shown
316 EndRegistrationTry: after saving a new user (note: no profile or user object!)
317 - $action: action object being shown
319 StartAvatarFormData: before displaying avatar form
320 - $action: action object being shown
322 EndAvatarFormData: after displaying avatar form
323 - $action: action object being shown
325 StartAvatarSaveForm: before saving the avatar
326 - $action: action object being shown
328 EndAvatarSaveForm: after saving the avatar
329 - $action: action object being shown
331 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
332 - $qm: empty queue manager to set
334 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
335 - $action: action object being shown
336 - $user: current user
338 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
339 - $title: title of the document
340 - $output: HTML output to show
342 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
343 - $title: title of the document
344 - $output: HTML output to show
346 StartApiRss: after the rss <channel> element is started
347 - $action: action object being shown
349 StartApiAtom: after the <feed> element is started
350 - $action: action object being shown
352 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
353 - $notice: the notice being added
354 - &$transports: modifiable list of transports (as strings) to queue for
356 EndEnqueueNotice: after adding a notice to the queues
357 - $notice: the notice being added
358 - $transports: modifiable list of transports to use
360 UnqueueHandleNotice: Handle a notice when no queue manager is available
361 - $notice: the notice to handle
362 - $queue: the "queue" that is being executed
364 GetValidDaemons: Just before determining which daemons to run
365 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
367 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
368 - &$notice: notice to handle
370 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
371 - $action: the current action
372 - &$attrs: attributes for the HTML element
374 EndHtmlElement: Right after outputting the HTML element
375 - $action: the current action
376 - &$attrs: attributes for the HTML element
378 StartShowHeadElements: Right after the <head> tag
379 - $action: the current action
381 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
382 - $action: the current action
384 CheckSchema: chance to check the schema
386 StartProfileRemoteSubscribe: Before showing the link to remote subscription
387 - $userprofile: UserProfile widget
388 - &$profile: the profile being shown
390 EndProfileRemoteSubscribe: After showing the link to remote subscription
391 - $userprofile: UserProfile widget
392 - &$profile: the profile being shown
394 StartGroupSubscribe: Before showing the link to remote subscription
395 - $action: the current action
396 - $group: the group being shown
398 EndGroupSubscribe: After showing the link to remote subscription
399 - $action: the current action
400 - $group: the group being shown
402 StartProfilePageProfileSection: Starting to show the section of the
403 profile page with the actual profile data;
404 hook to prevent showing the profile (e.g.)
405 - $userprofile: UserProfile widget
406 - &$profile: the profile being shown
408 StartProfilePageProfileElements: inside the section, before the first
409 element; prepend elements here
410 - $userprofile: UserProfile widget
411 - &$profile: the profile being shown
413 EndProfilePageProfileElements: inside the section, after the last element;
415 - $userprofile: UserProfile widget
416 - &$profile: the profile being shown
418 EndProfilePageProfileSection: After showing the section of the profile
419 page with the profile elements
420 - $userprofile: UserProfile widget
421 - &$profile: the profile being shown
423 StartProfilePageActionsSection: Starting to show the section of the
424 profile page with action links; hook
425 to hide them (for example)
426 - $userprofile: UserProfile widget
427 - &$profile: the profile being shown
429 StartProfilePageActionsElements: inside the list, before the first
430 element; prepend elements here
431 - $userprofile: UserProfile widget
432 - &$profile: the profile being shown
434 EndProfilePageActionsElements: inside the list, after the last element;
436 - $userprofile: UserProfile widget
437 - &$profile: the profile being shown
439 EndProfilePageActionsSection: After showing the section of the profile
440 page with the entity actions
441 - $userprofile: UserProfile widget
442 - &$profile: the profile being shown
444 StartProfilePageAvatar: before showing the avatar on the profile page
445 - $userprofile: UserProfile widget
446 - &$profile: the profile being shown
448 EndProfilePageAvatar: after showing the avatar on the profile page
449 - $userprofile: UserProfile widget
450 - &$profile: the profile being shown
452 StartProfilePageNickname: before showing the nickname on the profile page
453 - $userprofile: UserProfile widget
454 - &$profile: the profile being shown
456 EndProfilePageNickname: after showing the nickname on the profile page
457 - $userprofile: UserProfile widget
458 - &$profile: the profile being shown
460 StartProfilePageFullName: before showing the fullname on the profile page
461 - $userprofile: UserProfile widget
462 - &$profile: the profile being shown
464 EndProfilePageFullName: after showing the fullname on the profile page
465 - $userprofile: UserProfile widget
466 - &$profile: the profile being shown
468 StartProfilePageLocation: before showing the location on the profile page
469 - $userprofile: UserProfile widget
470 - &$profile: the profile being shown
472 EndProfilePageLocation: after showing the location on the profile page
473 - $userprofile: UserProfile widget
474 - &$profile: the profile being shown
476 StartProfilePageHomepage: before showing the homepage link on the profile page
477 - $userprofile: UserProfile widget
478 - &$profile: the profile being shown
480 EndProfilePageHomepage: after showing the homepage on the profile page
481 - $userprofile: UserProfile widget
482 - &$profile: the profile being shown
484 StartProfilePageBio: before showing the bio on the profile page
485 - $userprofile: UserProfile widget
486 - &$profile: the profile being shown
488 EndProfilePageBio: after showing the bio on the profile page
489 - $userprofile: UserProfile widget
490 - &$profile: the profile being shown
492 StartProfilePageProfileTags: before showing the tags on the profile page
493 - $userprofile: UserProfile widget
494 - &$profile: the profile being shown
496 EndProfilePageProfileTags: after showing the tags on the profile page
497 - $userprofile: UserProfile widget
498 - &$profile: the profile being shown
500 StartProfileList: when starting a list of profiles (before <ul>)
501 - $profilelist: ProfileList widget, with $profile, $action, and $out
503 EndProfileList: when ending a list of profiles (after </ul>)
504 - $profilelist: ProfileList widget
506 StartProfileListItem: when starting to show a profile list item
507 - $item: ProfileListItem widget
509 EndProfileListItem: after showing a profile list item
510 - $item: ProfileListItem widget
512 StartProfileListItemProfile: the profile data part of the item
513 - $item: ProfileListItem widget
515 EndProfileListItemProfile: the profile data part of the item
516 - $item: ProfileListItem widget
518 StartProfileListItemActions: the actions (buttons) for an item
519 - $item: ProfileListItem widget
521 EndProfileListItemActions: the actions (buttons) for an item
522 - $item: ProfileListItem widget
524 StartProfileListItemProfileElements: inside the <div>
525 - $item: ProfileListItem widget
527 EndProfileListItemProfileElements: inside the <div>
528 - $item: ProfileListItem widget
530 StartProfileListItemAvatar: Showing a profile list avatar
531 - $item: ProfileListItem widget
533 EndProfileListItemAvatar: Showing a profile list avatar
534 - $item: ProfileListItem widget
536 StartProfileListItemFullName: Showing the profile list full name
537 - $item: ProfileListItem widget
539 EndProfileListItemFullName: Showing the profile list full name
540 - $item: ProfileListItem widget
542 StartProfileListItemLocation: Showing the profile list location
543 - $item: ProfileListItem widget
545 EndProfileListItemLocation: Showing the profile list location
546 - $item: ProfileListItem widget
548 StartProfileListItemHomepage: Showing the profile list homepage
549 - $item: ProfileListItem widget
551 EndProfileListItemHomepage: Showing the profile list homepage
552 - $item: ProfileListItem widget
554 StartProfileListItemBio: Showing the profile list bio
555 - $item: ProfileListItem widget
557 EndProfileListItemBio: Showing the profile list bio
558 - $item: ProfileListItem widget
560 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
561 - $item: ProfileListItem widget
563 EndProfileListItemActionElements: Showing profile list actions (append a button here)
564 - $item: ProfileListItem widget
566 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
567 - $action: the current action
568 - &$xrdsoutputter - XRDSOutputter object to write to
570 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
571 - $action: the current action
572 - &$xrdsoutputter - XRDSOutputter object to write to
574 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
575 - $action: the current action
576 - &$xrdsoutputter - XRDSOutputter object to write to
578 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
579 - $action: the current action
580 - &$xrdsoutputter - XRDSOutputter object to write to
582 StartCheckPassword: Check a username/password
583 - $nickname: The nickname to check
584 - $password: The password to check
585 - &$authenticatedUser: set to User object if credentials match a user.
587 EndCheckPassword: After checking a username/password pair
588 - $nickname: The nickname that was checked
589 - $password: The password that was checked
590 - $authenticatedUser: User object if credentials match a user, else null.
592 StartChangePassword: Before changing a password
594 - $oldpassword: the user's old password
595 - $newpassword: the desired new password
597 EndChangePassword: After changing a password
600 StartHashPassword: Generate a hashed version of the password (like a salted crypt)
601 - &$hashed: Hashed version of the password, later put in the database
602 - $password: The password that should be hashed
603 - $profile: Profile that this password and hash belongs to. Can be null.
605 StartSetUser: Before setting the currently logged in user
608 EndSetUser: After setting the currently logged in user
611 StartSetApiUser: Before setting the current API user
614 EndSetApiUser: After setting the current API user
617 StartHasRole: Before determing if the a profile has a given role
618 - $profile: profile in question
619 - $name: name of the role in question
620 - &$has_role: does this profile have the named role?
622 EndHasRole: Before determing if the a profile has a given role
623 - $profile: profile in question
624 - $name: name of the role in question
625 - $has_role: does this profile have the named role?
627 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
629 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
631 GetUrlShorteners: Specify URL shorteners that are available for use
632 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
634 StartShortenUrl: About to shorten a URL
635 - $url: url to be shortened
636 - $shortenerName: name of the requested shortener
637 - &$shortenedUrl: short version of the url
639 EndShortenUrl: After a URL has been shortened
640 - $url: url to be shortened
641 - $shortenerName: name of the requested shortener
642 - $shortenedUrl: short version of the url
644 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
650 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
656 StartStyleElement: Before a <style...> element is written
662 EndStyleElement: After a <style...> element is written
668 StartScriptElement: Before a <script...> element is written
673 EndScriptElement: After a <script...> element is written
678 StartInlineScriptElement: Before a <script...> element is written
683 EndInlineScriptElement: After a <script...> element is written
688 StartLog: Before writing to the logs
693 EndLog: After writing to the logs
698 StartBlockProfile: when we're about to block
699 - $user: the person doing the block
700 - $profile: the person getting blocked, can be remote
702 EndBlockProfile: when a block has succeeded
703 - $user: the person doing the block
704 - $profile: the person blocked, can be remote
706 StartUnblockProfile: when we're about to unblock
707 - $user: the person doing the unblock
708 - $profile: the person getting unblocked, can be remote
710 EndUnblockProfile: when an unblock has succeeded
711 - $user: the person doing the unblock
712 - $profile: the person unblocked, can be remote
714 StartSubscribe: when a subscription is starting
715 - $profile: Profile that is subscribing
716 - $other: Profile that is being subscribed to
718 EndSubscribe: when a subscription is finished
719 - $profile: Profile that is subscribing
720 - $other: Profile that is being subscribed to
722 StartUnsubscribe: when an unsubscribe is starting
723 - $profile: Profile that is unsubscribing
724 - $other: Profile that is being unsubscribed from
726 EndUnsubscribe: when an unsubscribe is done
727 - $profile: Profile that is unsubscribing
728 - $other: Profile that is being unsubscribed from
730 StartJoinGroup: when a user is joining a group
731 - $group: the group being joined
732 - $profile: the local or remote user joining
734 EndJoinGroup: when a user finishes joining a group
735 - $group: the group being joined
736 - $profile: the local or remote user joining
738 StartLeaveGroup: when a user is leaving a group
739 - $group: the group being left
740 - $profile: the local or remote user leaving
742 EndLeaveGroup: when a user has left a group
743 - $group: the group being left
744 - $profile: the local or remote user leaving
746 StartShowContentLicense: Showing the default license for content
747 - $action: the current action
749 EndShowContentLicense: Showing the default license for content
750 - $action: the current action
752 GetImTransports: Get IM transports that are available
753 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
755 NormalizeImScreenname: Normalize an IM screenname
756 - $transport: transport the screenname is on
757 - &$screenname: screenname to be normalized
759 ValidateImScreenname: Validate an IM screenname
760 - $transport: transport the screenname is on
761 - $screenname: screenname to be validated
762 - $valid: is the screenname valid?
764 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
765 - $transport: transport the screenname exists on
766 - $screenname: screenname being confirmed
767 - $code: confirmation code for confirmation URL
768 - $user: user requesting the confirmation
770 StartUserRegister: When a new user is being registered
771 - $profile: Profile object with new profile data (no ID yet)
773 EndUserRegister: When a new user has been registered
774 - $profile: Profile object with new profile data
776 StartRobotsTxt: Before outputting the robots.txt page
777 - &$action: RobotstxtAction being shown
779 EndRobotsTxt: After the default robots.txt page (good place for customization)
780 - &$action: RobotstxtAction being shown
782 StartGetProfileUri: When determining the canonical URI for a given profile
783 - $profile: the current profile
786 EndGetProfileUri: After determining the canonical URI for a given profile
787 - $profile: the current profile
790 StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
791 - $profile: Profile of user we want to get acct: URI for
792 - &$acct: string with the resulting acct: uri
794 EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
795 - $profile: Profile of user we want to get acct: URI for
796 - &$acct: string with the resulting acct: uri
798 StartFavorNotice: Saving a notice as a favorite
799 - $profile: profile of the person faving (can be remote!)
800 - $notice: notice being faved
801 - &$fave: Favor object; null to start off with, but feel free to override.
803 EndFavorNotice: After saving a notice as a favorite
804 - $profile: profile of the person faving (can be remote!)
805 - $notice: notice being faved
807 StartDisfavorNotice: Saving a notice as a favorite
808 - $profile: profile of the person faving (can be remote!)
809 - $notice: notice being faved
810 - &$result: result of the disfavoring (if you override)
812 EndDisfavorNotice: After saving a notice as a favorite
813 - $profile: profile of the person faving (can be remote!)
814 - $notice: notice being faved
816 StartFavorNoticeForm: starting the data in the form for favoring a notice
817 - $FavorForm: the favor form being shown
818 - $notice: notice being favored
820 EndFavorNoticeForm: Ending the data in the form for favoring a notice
821 - $FavorForm: the favor form being shown
822 - $notice: notice being favored
824 StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
825 - $DisfavorForm: the disfavor form being shown
826 - $notice: notice being difavored
828 EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
829 - $DisfavorForm: the disfavor form being shown
830 - $notice: notice being disfavored
832 StartFindMentions: start finding mentions in a block of text
833 - $sender: sender profile
834 - $text: plain text version of the notice
835 - &$mentions: mentions found so far. Array of arrays; each array
836 has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
837 'title' (title of the link), 'position' (position of the text to
838 replace), 'text' (text to replace)
840 EndFindMentions: end finding mentions in a block of text
841 - $sender: sender profile
842 - $text: plain text version of the notice
843 - &$mentions: mentions found so far. Array of arrays; each array
844 has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
845 'title' (title of the link), 'position' (position of the text to
846 replace), 'text' (text to replace)
848 StartShowSubscriptionsContent: before showing the subscriptions content
849 - $action: the current action
851 EndShowSubscriptionsContent: after showing the subscriptions content
852 - $action: the current action
854 StartShowUserGroupsContent: before showing the user groups content
855 - $action: the current action
857 EndShowUserGroupsContent: after showing the user groups content
858 - $action: the current action
860 StartShowAllContent: before showing the all (you and friends) content
861 - $action: the current action
863 EndShowAllContent: after showing the all (you and friends) content
864 - $action: the current action
866 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
867 - $action: the current action
869 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
870 - $action: the current action
872 StartShowGroupsMiniList: at the start of groups mini list
873 - $action: the current action
875 EndShowGroupsMiniList: at the end of groups mini list
876 - $action: the current action
878 StartDeleteUserForm: starting the data in the form for deleting a user
879 - $action: action being shown
880 - $user: user being deleted
882 EndDeleteUserForm: Ending the data in the form for deleting a user
883 - $action: action being shown
884 - $user: user being deleted
886 StartDeleteUser: handling the post for deleting a user
887 - $action: action being shown
888 - $user: user being deleted
890 EndDeleteUser: handling the post for deleting a user
891 - $action: action being shown
892 - $user: user being deleted
894 StartNoticeAsActivity: before converting a notice to an activity
895 - $notice: notice being converted
896 - &$activity: initially empty activity
898 EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
899 - $notice: notice being converted
900 - &$activity: activity, now more-or-less full
902 StartNoticeSaveWeb: before saving a notice through the Web interface
903 - $action: action being executed (instance of NewNoticeAction)
904 - &$authorId: integer ID of the author
905 - &$text: text of the notice
906 - &$options: additional options (location, replies, etc.)
908 EndNoticeSaveWeb: after saving a notice through the Web interface
909 - $action: action being executed (instance of NewNoticeAction)
910 - $notice: notice that was saved
912 StartRssEntryArray: at the start of copying a notice to an array
913 - $notice: the notice being copied
914 - &$entry: the entry (empty at beginning)
916 EndRssEntryArray: at the end of copying a notice to an array
917 - $notice: the notice being copied
918 - &$entry: the entry, with all the fields filled up
920 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
921 - $notice: notice being deleted
923 StartShowHeadTitle: when beginning to show the <title> element
924 - $action: action being shown
926 EndShowHeadTitle: when done showing the <title>
927 - $action: action being shown
929 StartShowPageTitle: when beginning to show the page title <h1>
930 - $action: action being shown
932 EndShowPageTitle: when done showing the page title <h1>
933 - $action: action being shown
935 StartDeleteOwnNotice: when a user starts to delete their own notice
936 - $user: the user doing the delete
937 - $notice: the notice being deleted
939 EndDeleteOwnNotice: when a user has deleted their own notice
940 - $user: the user doing the delete
941 - $notice: the notice being deleted
943 StartShowFeedLinkList: before showing the feed list in the sidebar
944 - $action: action being executed
945 - $feeds: list of feeds to show
947 EndShowFeedLinkList: after showing the feed list in the sidebar
948 - $action: action being executed
949 - $feeds: list of feeds shown
951 StartShowFeedLink: before showing an individual feed item
952 - $action: action being executed
953 - $feed: feed to show
955 EndShowFeedLink: after showing an individual feed
956 - $action: action being executed
957 - $feed: feed to show
959 StartShowNoticeForm: before showing the notice form (before <form>)
960 - $action: action being executed
962 EndShowNoticeForm: after showing the notice form (after <form>)
963 - $action: action being executed
965 StartGrantRole: when a role is being assigned
966 - $profile: profile that will have the role
967 - $role: string name of the role
969 EndGrantRole: when a role has been successfully assigned
970 - $profile: profile that will have the role
971 - $role: string name of the role
973 StartRevokeRole: when a role is being revoked
974 - $profile: profile that will lose the role
975 - $role: string name of the role
977 EndRevokeRole: when a role has been revoked
978 - $profile: profile that lost the role
979 - $role: string name of the role
981 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
982 - &$activity: received activity
983 - $user: user publishing the entry
984 - &$notice: notice created; initially null, can be set
986 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
987 - $activity: received activity
988 - $user: user publishing the entry
989 - $notice: notice that was created
991 AdminPanelCheck: When checking whether the current user can access a given admin panel
992 - $name: Name of the admin panel
993 - &$isOK: Boolean whether the user is allowed to use the panel
995 StartAdminPanelNav: Before displaying the first item in the list of admin panels
996 - $nav The AdminPanelNav widget
998 EndAdminPanelNav: After displaying the last item in the list of admin panels
999 - $nav The AdminPanelNav widget
1001 StartActivityObjectFromNotice: When converting a notice to an activity:object
1002 - $notice: The notice being converted
1003 - &$object: The resulting object. Fill this and return false to override defaults.
1005 EndActivityObjectFromNotice: After converting a notice to an activity:object
1006 - $notice: The notice being converted
1007 - &$object: The resulting object. Can be edited
1009 StartActivityObjectFromProfile: When converting a profile to an activity:object
1010 - $profile: The profile being converted
1011 - &$object: The (empty) object. Fill it up and return false to override defaults.
1013 EndActivityObjectFromProfile: After converting a profile to an activity:object
1014 - $profile: The profile being converted
1015 - &$object: The finished object. Can be tweaked
1017 StartActivityObjectFromGroup: When converting a group to an activity:object
1018 - $group: The group being converted
1019 - &$object: The (empty) object. Fill and return false to override.
1021 EndActivityObjectFromGroup: After converting a group to an activity:object
1022 - $group: The group being converted
1023 - &$object: The finished object. Tweak as needed.
1025 StartImportActivity: when we start to import an activity
1026 - $user: User to make the author import
1027 - $author: Author of the feed; good for comparisons
1028 - $activity: The current activity
1029 - $trusted: How "trusted" the process is
1030 - &$done: Return value; whether to continue
1032 EndImportActivity: when we finish importing an activity
1033 - $user: User to make the author import
1034 - $author: Author of the feed; good for comparisons
1035 - $activity: The current activity
1036 - $trusted: How "trusted" the process is
1038 StartProfileSettingsActions: when we're showing account-management action list
1039 - $action: Action being shown (use for output)
1041 EndProfileSettingsActions: when we're showing account-management action list
1042 - $action: Action being shown (use for output)
1044 StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
1045 - $nli: The notice list item being shown
1047 EndOpenNoticeListItemElement: After the opening <li> of a notice list element
1048 - $nli: The notice list item being shown
1050 StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
1051 - $nli: The notice list item being shown
1053 EndCloseNoticeListItemElement: After the closing </li> of a notice list element
1054 - $nli: The notice list item being shown
1056 StartGroupEditFormData: Beginning the group edit form entries
1057 - $form: The form widget being shown
1059 EndGroupEditFormData: Ending the group edit form entries
1060 - $form: The form widget being shown
1062 StartGroupSave: After initializing but before saving a group
1063 - &$group: group about to be saved
1065 EndGroupSave: After saving a group, aliases, and first member
1066 - $group: group that was saved
1068 StartInterpretCommand: Before running a command
1069 - $cmd: First word in the string, 'foo' in 'foo argument'
1070 - $arg: Argument, if any, like 'argument' in 'foo argument'
1071 - $user: User who issued the command
1072 - &$result: Resulting command; you can set this!
1074 EndInterpretCommand: Before running a command
1075 - $cmd: First word in the string, 'foo' in 'foo argument'
1076 - $arg: Argument, if any, like 'argument' in 'foo argument'
1077 - $user: User who issued the command
1078 - $result: Resulting command
1080 StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
1081 - $action: action being executed (for output and params)
1082 - $group: group for the page
1084 EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
1085 - $action: action being executed (for output and params)
1086 - $group: group for the page
1088 StartGroupProfileElements: 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
1092 EndGroupProfileElements: Start showing stuff about the group on its profile page
1093 - $action: action being executed (for output and params)
1094 - $group: group for the page
1096 StartShowProfileTagContent: When showing a people tag page
1097 - $action: action being executed (for output and params)
1099 EndShowProfileTagContent: After showing the contents of a people tag page
1100 - $action: action being executed (for output and params)
1102 StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
1103 - $action: action being executed (for output and params)
1105 EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
1106 - $action: action being executed (for output and params)
1108 StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
1109 - $action: action being executed (for output and params)
1111 EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
1112 - $action: action being executed (for output and params)
1114 StartTagProfileAction: When starting to show profile tagging page
1115 - $action: action being executed (for output and params)
1116 - $profile: profile being tagged
1118 EndTagProfileAction: After showing profile tagging page
1119 - $action: action being executed (for output and params)
1120 - $profile: profile being tagged
1122 StartProfileCompletionSearch: When starting a profile search for autocompletion
1123 - $action: action being executed (for output and params)
1124 - &$profile: result Profile objects
1125 - $search_engine: the search engine
1127 EndProfileCompletionSearch: After search results for profile autocompletion have been found
1128 - $action: profilec completion action
1129 - &$profile: current result Profile objects
1130 - $search_engine: The search engine object
1132 StartShowTagProfileForm: When showing people tagging form
1133 - $action: action being executed (for output and params)
1134 - $profile: profile being tagged
1136 EndShowTagProfileForm: After showing people tagging form
1137 - $action: action being executed (for output and params)
1138 - $profile: profile being tagged
1140 StartSavePeopletags: When starting to save people tags
1141 - $action: action being executed (for output and params)
1142 - $tagstring: string input, a list of tags
1144 EndSavePeopletags: After saving people tags
1145 - $action: action being executed (for output and params)
1146 - $tagstring: string input, a list of tags
1148 StartProfiletagGetUri: when generating the Uri for a people tag
1149 - $profile_list: the people tag, a Profile_list object
1152 EndProfiletagGetUri: after generating the uri for a people tag
1153 - $profile_list: the people tag, a Profile_list object
1156 StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
1157 - $profile_list: the people tag, a Profile_list object
1160 EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
1161 - $profile_list: the people tag, a Profile_list object
1164 StartProfiletagPermalink: when generating the permalink url for a people tag
1165 - $profile_list: the people tag, a Profile_list object
1168 EndProfiletagPermalink: after generating the permalink url for a people tag
1169 - $profile_list: the people tag, a Profile_list object
1172 StartTagProfile: when tagging a profile
1173 - $tagger: profile tagging
1174 - $tagged: profile being tagged
1177 EndTagProfile: after tagging a profile
1178 - $newtag: the newly created Profile_tag object
1180 StartUntagProfile: when deleting a people tag
1181 - $ptag: the Profile_tag object being deleted
1183 EndUntagProfile: after deleting a people tag
1184 - $orig: a copy of the deleted Profile_tag object
1186 StartSubscribePeopletag: when subscribing to a people tag
1187 - $peopletag: Profile_list object being subscribed to
1188 - $profile: subscriber's profile
1190 EndSubscribePeopletag: after subscribing 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
1194 StartUnsubscribePeopletag: when unsubscribing to a people tag
1195 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1196 - $profile: subscriber's profile
1198 EndUnsubscribePeopletag: after unsubscribing to a people tag
1199 - $peopletag: Profile_list object being subscribed to
1200 - $profile: subscriber's profile
1202 StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
1203 - $profile_list: the people tag, a Profile_list object
1204 - &$object: activity object
1206 EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
1207 - $profile_list: the people tag, a Profile_list object
1208 - &$object: activity object
1210 StartPeopletagGroupNav: Showing the people tag nav menu
1211 - $menu: the menu widget; use $menu->action for output
1213 EndPeopletagGroupNav: after showing the people tag nav menu
1214 - $menu: the menu widget; use $menu->action for output
1216 StartShowPeopletagItem: when showing a people tag
1217 - $widget: PeopletagListItem widget
1219 EndShowPeopletagItem: after showing a people tag
1220 - $widget: PeopletagListItem widget
1222 StartSubscribePeopletagForm: when showing people tag subscription form
1223 - $action: action being executed (for output and params)
1224 - $peopletag: people tag being subscribed to
1226 EndSubscribePeopletagForm: after showing the people tag subscription form
1227 - $action: action being executed (for output and params)
1228 - $peopletag: people tag being subscribed to
1230 StartShowPeopletags: when showing a textual list of people tags
1231 - $widget: PeopletagsWidget; use $widget->out for output
1232 - $tagger: profile of the tagger
1233 - $tagged: profile tagged
1235 EndShowPeopletags: after showing a textual list of people tags
1236 - $widget: PeopletagsWidget; use $widget->out for output
1237 - $tagger: profile of the tagger
1238 - $tagged: profile tagged
1240 StartProfileListItemTags: when showing people tags in a profile list item widget
1241 - $widget: ProfileListItem widget
1243 EndProfileListItemTags: after showing people tags in a profile list item widget
1244 - $widget: ProfileListItem widget
1246 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)
1247 - $obj: ActivityObject
1248 - $out: XMLOutputter to append custom output
1250 EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
1251 - $obj: ActivityObject
1252 - $out: XMLOutputter to append custom output
1254 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)
1255 - $obj ActivityObject
1256 - &$out: array to be serialized; you're free to modify it
1258 EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
1259 - $obj ActivityObject
1260 - &$out: array to be serialized; you're free to modify it
1262 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.
1264 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1266 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.
1268 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1270 StartDefaultLocalNav: When showing the default local nav
1272 - $user: current user
1274 EndDefaultLocalNav: When showing the default local nav
1276 - $user: current user
1278 StartShowAccountProfileBlock: When showing the profile block for an account
1279 - $out: XMLOutputter to append custom output
1280 - $profile: the profile being shown
1282 EndShowAccountProfileBlock: After showing the profile block for an account
1283 - $out: XMLOutputter to append custom output
1284 - $profile: the profile being shown
1286 StartShowGroupProfileBlock: When showing the profile block for a group
1287 - $out: XMLOutputter to append custom output
1288 - $profile: the profile being shown
1290 EndShowGroupProfileBlock: After showing the profile block for a group
1291 - $out: XMLOutputter to append custom output
1292 - $group: the group being shown
1294 StartShowThreadedNoticeTail: when showing the replies etc. to a notice
1295 - $nli: parent noticelistitem
1296 - $notice: parent notice
1297 - &$children: list of children
1299 EndShowThreadedNoticeTail: when showing the replies etc. to a notice
1300 - $nli: parent noticelistitem
1301 - $notice: parent notice
1302 - $children: list of children
1304 StartShowThreadedNoticeSub: when showing a reply to a notice
1305 - $nli: parent noticelistitem
1306 - $parent: parent notice
1307 - $child: child notice
1309 EndShowThreadedNoticeSub: when showing a reply to a notice
1310 - $nli: parent noticelistitem
1311 - $parent: parent notice
1312 - $child: child notice
1314 StartAddEmailAddress: when adding an email address through the Web UI
1315 - $user: user getting the new address
1316 - $email: email being added
1318 EndAddEmailAddress: done adding an email address through the Web UI
1319 - $user: user getting the new address
1320 - $email: email being added
1322 StartValidateEmailInvite: when validating an email address for invitations
1323 - $user: user doing the invite
1324 - $email: email address
1325 - &$valid: flag for if it's valid; can be modified
1327 EndValidateEmailInvite: after validating an email address for invitations
1328 - $user: user doing the invite
1329 - $email: email address
1330 - &$valid: flag for if it's valid; can be modified
1332 StartLocalURL: before resolving a local url for an action
1333 - &$action: action to find a path for
1334 - &$paramsi: parameters to pass to the action
1335 - &$fragment: any url fragement
1336 - &$addSession: whether to add session variable
1337 - &$url: resulting URL to local resource
1339 EndLocalURL: before resolving a local url for an action
1340 - &$action: action to find a path for
1341 - &$paramsi: parameters to pass to the action
1342 - &$fragment: any url fragement
1343 - &$addSession: whether to add session variable
1344 - &$url: resulting URL to local resource
1346 StartProfileGetAvatar: When getting an avatar for a profile
1348 - $size: size of the avatar
1351 EndProfileGetAvatar: After getting an avatar for a profile
1353 - $size: size of the avatar
1356 StartRegisterSuccess: Before showing the registration success message
1357 - $action: the registration action
1359 StartRegisterSuccess: After showing the registration success message
1360 - $action: the registration action
1362 StartDocFileForTitle: Before searching for a doc or mail template
1363 - $title: Title we're looking for
1364 - &$paths: Paths we're searching
1365 - &$filename: Filename so far (set this if you want)
1367 EndDocFileForTitle: After searching for a doc or mail template
1368 - $title: Title we looked for
1369 - $paths: Paths we searched
1370 - &$filename: Filename so far (set this if you want)
1372 StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
1373 - &$tables: list of table names
1374 - &$rwdb: read-write database URI
1376 EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
1377 - $tables: list of table names
1378 - $rwdb: read-write database URI
1380 StartShowInviteForm: Right before displaying the invitations form
1381 - $action: invitation action
1383 EndShowInviteForm: After displaying the invitations form
1384 - $action: invitation action
1386 StartSendInvitations: Right before sending invitations
1387 - $action: invitation action
1389 EndSendInvitations: Right after sending invitations
1390 - $action: invitation action
1392 StartShowInvitationSuccess: Right before showing invitations success msg
1393 - $action: invitation action
1395 EndShowInvitationSuccess: After showing invitations success msg
1396 - $action: invitation action
1398 StartUpgrade: when starting a site upgrade
1400 EndUpgrade: when ending a site upgrade; good place to do your own upgrades
1402 HaveIMPlugin: is there an IM plugin loaded?
1403 - &$haveIMPlugin: set me to true if you're loaded!
1405 StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
1406 - $nli: NoticeListItem being shown
1408 EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
1409 - $nli: NoticeListItem being shown
1411 StartNoticeInScope: Before checking if a notice should be visible to a user
1412 - $notice: The notice to check
1413 - $profile: The profile to check for scope
1414 - &$bResult: The boolean result; fill this in if you want to skip
1416 EndNoticeInScope: After checking if a notice should be visible to a user
1417 - $notice: The notice to check
1418 - $profile: The profile to check for scope
1419 - &$bResult: The boolean result; overwrite this if you so desire
1421 StartNoticeListPrefill: Before pre-filling a list of notices with extra data
1422 - &$notices: Notices to be pre-filled
1423 - $avatarSize: The avatar size for the list
1425 EndNoticeListPrefill: After pre-filling a list of notices with extra data
1426 - &$notices: Notices that were pre-filled
1427 - &$profiles: Profiles that were pre-filled
1428 - $avatarSize: The avatar size for the list
1430 OtherAccountProfiles: Hook to add account profiles to a user account profile block
1431 - $profile: the Profile being shown
1432 - &$others: Modifiable array of profile info arrays. Each one has the following fields:
1433 href: link to the profile
1434 text: text for the profile
1435 image: mini image for the profile