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 StartShowStatusNetStyles: Showing StatusNet Style links
24 - $action: the current action
26 EndShowStatusNetStyles: End showing StatusNet Style links; good place to add handheld or JavaScript dependant styles
27 - $action: the current action
29 StartShowLaconicaStyles: backwards compatibility; deprecated
30 - $action: the current action
32 EndShowLaconicaStyles: backwards compatibility; deprecated
33 - $action: the current action
35 StartShowUAStyles: Showing custom User-Agent style links
36 - $action: the current action
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
41 StartShowScripts: Showing JavaScript links
42 - $action: the current action
44 EndShowScripts: End showing JavaScript links; good place to add custom
45 links like Google Analytics
46 - $action: the current action
48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
49 - $action: the current action
51 EndShowJQueryScripts: End showing JQuery script links
52 - $action: the current action
54 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
55 - $action: the current action
57 EndShowStatusNetScripts: End showing StatusNet script links
58 - $action: the current action
60 StartShowLaconicaScripts: backwards compatibility; deprecated
61 - $action: the current action
63 EndShowLaconicaScripts: backwards compatibility; deprecated
64 - $action: the current action
66 StartShowSections: Start the list of sections in the sidebar
67 - $action: the current action
69 EndShowSections: End the list of sections in the sidebar
70 - $action: the current action
72 StartShowHeader: Showing before the header container
73 - $action: the current action
75 EndShowHeader: Showing after the header container
76 - $action: the current action
78 StartShowFooter: Showing before the footer container
79 - $action: the current action
81 EndShowFooter: Showing after the footer container
82 - $action: the current action
84 StartShowContentBlock: Showing before the content container
85 - $action: the current action
87 EndShowContentBlock: Showing after the content container
88 - $action: the current action
90 StartShowAside: Showing before the Aside container
91 - $action: the current action
93 EndShowAside: Showing after the Aside container
94 - $action: the current action
96 StartShowNoticeFormData: Showing before the notice form data
97 - $action: the current action
99 EndShowNoticeFormData: Showing after the notice form data
100 - $action: the current action
102 StartNoticeSave: before inserting a notice (good place for content filters)
103 - $notice: notice being saved (no ID or URI)
105 EndNoticeSave: after inserting a notice and related code
106 - $notice: notice that was saved (with ID and URI)
108 StartShowLocalNavBlock: Showing the local nav menu
109 - $action: the current action
111 EndShowLocalNavBlock: At the end of the local nav menu
112 - $action: the current action
114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
115 - $action: the current action
117 EndShowHTML: Showing after the html element
118 - $action: the current action
120 StartPublicGroupNav: Showing the public group nav menu
121 - $action: the current action
123 EndPublicGroupNav: At the end of the public group nav menu
124 - $action: the current action
126 StartSubGroupNav: Showing the subscriptions group nav menu
127 - $action: the current action
129 EndSubGroupNav: At the end of the subscriptions group nav menu
130 - $action: the current action
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
135 RouterInitialized: After the router instance has been initialized
136 - $m: the Net_URL_Mapper that has just been set up
138 StartLogout: Before logging out
139 - $action: the logout action
141 EndLogout: After logging out
142 - $action: the logout action
144 ArgsInitialized: After the argument array has been initialized
145 - $args: associative array of arguments, can be modified
147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
148 - $action: the current action
150 EndAddressData: At the end of <address>
151 - $action: the current action
153 StartLoginGroupNav: Before showing the login and register navigation menu
154 - $action: the current action
156 EndLoginGroupNav: After showing the login and register navigation menu
157 - $action: the current action
159 StartAccountSettingsNav: Before showing the account settings menu
160 - $action: the current action
162 EndAccountSettingsNav: After showing the account settings menu
163 - $action: the current action
165 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
166 - $widget: AccountSettingsNav instance being shown
168 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
169 - $widget: AccountSettingsNav instance being shown
171 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
172 - $widget: AccountSettingsNav instance being shown
174 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
175 - $widget: AccountSettingsNav instance being shown
177 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
178 - $widget: AccountSettingsNav instance being shown
180 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
181 - $widget: AccountSettingsNav instance being shown
183 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
184 - $widget: AccountSettingsNav instance being shown
186 EndAccountSettingsEmailMenuItem: After showing the Email menu item
187 - $widget: AccountSettingsNav instance being shown
189 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
190 - $widget: AccountSettingsNav instance being shown
192 EndAccountSettingsDesignMenuItem: After showing the Design menu item
193 - $widget: AccountSettingsNav instance being shown
195 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
196 - $widget: AccountSettingsNav instance being shown
198 EndAccountSettingsOtherMenuItem: After showing the Other menu item
199 - $widget: AccountSettingsNav instance being shown
201 Autoload: When trying to autoload a class
202 - $cls: the class being sought. A plugin might require_once the file for the class.
204 SensitiveAction: determines if an action is 'sensitive' and should use SSL
205 - $action: name of the action, like 'login'
206 - $sensitive: flag for whether this is a sensitive action
208 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
209 - $action: name of the action, like 'register'
210 - $login: flag for whether this is a login action
212 StartShowHead: called before showing the <head> element and children
213 - $action: action object being show
215 EndShowHead: called after showing the <head> element (and </head>)
216 - $action: action object being shown
218 StartShowBody: called before showing the <body> element and children
219 - $action: action object being shown
221 EndShowBody: called after showing the <body> element (and </body>)
222 - $action: action object being shown
224 StartPersonalGroupNav: beginning of personal group nav menu
225 - $action: action object being shown
227 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
228 - $action: action object being shown
230 StartGroupGroupNav: Showing the group nav menu
231 - $action: the current action
233 EndGroupGroupNav: At the end of the group nav menu
234 - $action: the current action
236 StartEndHTML: just before the </html> tag
237 - $action: action object being shown
239 EndEndHTML: just after the </html> tag
240 - $action: action object being shown
242 StartShowDesign: just before showing a site, user, or group design
243 - $action: action object being shown
245 EndShowDesign: just after showing a site, user, or group design
246 - $action: action object being shown
248 StartShowExportData: just before showing the <div> with export data (feeds)
249 - $action: action object being shown
251 EndShowExportData: just after showing the <div> with export data (feeds)
252 - $action: action object being shown
254 StartShowNoticeItem: just before showing the notice item
255 - $action: action object being shown
257 EndShowNoticeItem: just after showing the notice item
258 - $action: action object being shown
260 StartShowPageNotice: just before showing the page notice (instructions or error)
261 - $action: action object being shown
263 EndShowPageNotice: just after showing the page notice (instructions or error)
264 - $action: action object being shown
266 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
267 - $action: action object being shown
269 StartProfileFormData: just before showing text entry fields on profile settings page
270 - $action: action object being shown
272 EndProfileFormData: just after showing text entry fields on profile settings page
273 - $action: action object being shown
275 StartProfileSaveForm: before starting to save a profile settings form
276 - $action: action object being shown
278 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
279 - $action: action object being shown
281 StartRegistrationFormData: just before showing text entry fields on registration page
282 - $action: action object being shown
284 EndRegistrationFormData: just after showing text entry fields on registration page
285 - $action: action object being shown
287 StartRegistrationTry: before validating and saving a new user
288 - $action: action object being shown
290 EndRegistrationTry: after saving a new user (note: no profile or user object!)
291 - $action: action object being shown
293 StartAvatarFormData: before displaying avatar form
294 - $action: action object being shown
296 EndAvatarFormData: after displaying avatar form
297 - $action: action object being shown
299 StartAvatarSaveForm: before saving the avatar
300 - $action: action object being shown
302 EndAvatarSaveForm: after saving the avatar
303 - $action: action object being shown
305 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
306 - $qm: empty queue manager to set
308 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
309 - $action: action object being shown
310 - $user: current user
312 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
313 - $title: title of the document
314 - $output: HTML output to show
316 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
317 - $title: title of the document
318 - $output: HTML output to show
320 StartApiRss: after the rss <channel> element is started
321 - $action: action object being shown
323 StartApiAtom: after the <feed> element is started
324 - $action: action object being shown
326 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
327 - $notice: the notice being added
328 - &$transports: modifiable list of transports (as strings) to queue for
330 EndEnqueueNotice: after adding a notice to the queues
331 - $notice: the notice being added
332 - $transports: modifiable list of transports to use
334 UnqueueHandleNotice: Handle a notice when no queue manager is available
335 - $notice: the notice to handle
336 - $queue: the "queue" that is being executed
338 GetValidDaemons: Just before determining which daemons to run
339 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
341 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
342 - &$notice: notice to handle
344 StartShowHeadElements: Right after the <head> tag
345 - $action: the current action
347 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
348 - $action: the current action
350 CheckSchema: chance to check the schema
352 StartProfilePageProfileSection: Starting to show the section of the
353 profile page with the actual profile data;
354 hook to prevent showing the profile (e.g.)
355 - $userprofile: UserProfile widget
356 - &$profile: the profile being shown
358 StartProfilePageProfileElements: inside the section, before the first
359 element; prepend elements here
360 - $userprofile: UserProfile widget
361 - &$profile: the profile being shown
363 EndProfilePageProfileElements: inside the section, after the last element;
365 - $userprofile: UserProfile widget
366 - &$profile: the profile being shown
368 EndProfilePageProfileSection: After showing the section of the profile
369 page with the profile elements
370 - $userprofile: UserProfile widget
371 - &$profile: the profile being shown
373 StartProfilePageActionsSection: Starting to show the section of the
374 profile page with action links; hook
375 to hide them (for example)
376 - $userprofile: UserProfile widget
377 - &$profile: the profile being shown
379 StartProfilePageActionsElements: inside the list, before the first
380 element; prepend elements here
381 - $userprofile: UserProfile widget
382 - &$profile: the profile being shown
384 EndProfilePageActionsElements: inside the list, after the last element;
386 - $userprofile: UserProfile widget
387 - &$profile: the profile being shown
389 EndProfilePageActionsSection: After showing the section of the profile
390 page with the entity actions
391 - $userprofile: UserProfile widget
392 - &$profile: the profile being shown
394 StartProfilePageAvatar: before showing the avatar on the profile page
395 - $userprofile: UserProfile widget
396 - &$profile: the profile being shown
398 EndProfilePageAvatar: after showing the avatar on the profile page
399 - $userprofile: UserProfile widget
400 - &$profile: the profile being shown
402 StartProfilePageNickname: before showing the nickname on the profile page
403 - $userprofile: UserProfile widget
404 - &$profile: the profile being shown
406 EndProfilePageNickname: after showing the nickname on the profile page
407 - $userprofile: UserProfile widget
408 - &$profile: the profile being shown
410 StartProfilePageFullName: before showing the fullname on the profile page
411 - $userprofile: UserProfile widget
412 - &$profile: the profile being shown
414 EndProfilePageFullName: after showing the fullname on the profile page
415 - $userprofile: UserProfile widget
416 - &$profile: the profile being shown
418 StartProfilePageLocation: before showing the location on the profile page
419 - $userprofile: UserProfile widget
420 - &$profile: the profile being shown
422 EndProfilePageLocation: after showing the location on the profile page
423 - $userprofile: UserProfile widget
424 - &$profile: the profile being shown
426 StartProfilePageHomepage: before showing the homepage link on the profile page
427 - $userprofile: UserProfile widget
428 - &$profile: the profile being shown
430 EndProfilePageHomepage: after showing the homepage on the profile page
431 - $userprofile: UserProfile widget
432 - &$profile: the profile being shown
434 StartProfilePageBio: before showing the bio on the profile page
435 - $userprofile: UserProfile widget
436 - &$profile: the profile being shown
438 EndProfilePageBio: after showing the bio on the profile page
439 - $userprofile: UserProfile widget
440 - &$profile: the profile being shown
442 StartProfilePageProfileTags: before showing the tags on the profile page
443 - $userprofile: UserProfile widget
444 - &$profile: the profile being shown
446 EndProfilePageProfileTags: after showing the tags on the profile page
447 - $userprofile: UserProfile widget
448 - &$profile: the profile being shown
450 StartProfileList: when starting a list of profiles (before <ul>)
451 - $profilelist: ProfileList widget, with $profile, $action, and $out
453 EndProfileList: when ending a list of profiles (after </ul>)
454 - $profilelist: ProfileList widget
456 StartProfileListItem: when starting to show a profile list item
457 - $item: ProfileListItem widget
459 EndProfileListItem: after showing a profile list item
460 - $item: ProfileListItem widget
462 StartProfileListItemProfile: the profile data part of the item
463 - $item: ProfileListItem widget
465 EndProfileListItemProfile: the profile data part of the item
466 - $item: ProfileListItem widget
468 StartProfileListItemActions: the actions (buttons) for an item
469 - $item: ProfileListItem widget
471 EndProfileListItemActions: the actions (buttons) for an item
472 - $item: ProfileListItem widget
474 StartProfileListItemProfileElements: inside the <div>
475 - $item: ProfileListItem widget
477 EndProfileListItemProfileElements: inside the <div>
478 - $item: ProfileListItem widget
480 StartProfileListItemAvatar: Showing a profile list avatar
481 - $item: ProfileListItem widget
483 EndProfileListItemAvatar: Showing a profile list avatar
484 - $item: ProfileListItem widget
486 StartProfileListItemFullName: Showing the profile list full name
487 - $item: ProfileListItem widget
489 EndProfileListItemFullName: Showing the profile list full name
490 - $item: ProfileListItem widget
492 StartProfileListItemLocation: Showing the profile list location
493 - $item: ProfileListItem widget
495 EndProfileListItemLocation: Showing the profile list location
496 - $item: ProfileListItem widget
498 StartProfileListItemHomepage: Showing the profile list homepage
499 - $item: ProfileListItem widget
501 EndProfileListItemHomepage: Showing the profile list homepage
502 - $item: ProfileListItem widget
504 StartProfileListItemBio: Showing the profile list bio
505 - $item: ProfileListItem widget
507 EndProfileListItemBio: Showing the profile list bio
508 - $item: ProfileListItem widget
510 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
511 - $item: ProfileListItem widget
513 EndProfileListItemActionElements: Showing profile list actions (append a button here)
514 - $item: ProfileListItem widget
516 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
517 - $action: the current action
518 - &$xrdsoutputter - XRDSOutputter object to write to
520 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
521 - $action: the current action
522 - &$xrdsoutputter - XRDSOutputter object to write to
524 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
525 - $action: the current action
526 - &$xrdsoutputter - XRDSOutputter object to write to
528 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
529 - $action: the current action
530 - &$xrdsoutputter - XRDSOutputter object to write to
532 StartCheckPassword: Check a username/password
533 - $nickname: The nickname to check
534 - $password: The password to check
535 - &$authenticatedUser: set to User object if credentials match a user.
537 EndCheckPassword: After checking a username/password pair
538 - $nickname: The nickname that was checked
539 - $password: The password that was checked
540 - $authenticatedUser: User object if credentials match a user, else null.
542 StartChangePassword: Before changing a password
544 - $oldpassword: the user's old password
545 - $newpassword: the desired new password
547 EndChangePassword: After changing a password
550 StartSetUser: Before setting the currently logged in user
553 EndSetUser: After setting the currently logged in user
556 StartSetApiUser: Before setting the current API user
559 EndSetApiUser: After setting the current API user
562 StartHasRole: Before determing if the a profile has a given role
563 - $profile: profile in question
564 - $name: name of the role in question
565 - &$has_role: does this profile have the named role?
567 EndHasRole: Before determing if the a profile has a given role
568 - $profile: profile in question
569 - $name: name of the role in question
570 - $has_role: does this profile have the named role?
572 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
574 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
576 GetUrlShorteners: Specify URL shorteners that are available for use
577 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
579 StartShortenUrl: About to shorten a URL
580 - $url: url to be shortened
581 - $shortenerName: name of the requested shortener
582 - &$shortenedUrl: short version of the url
584 EndShortenUrl: After a URL has been shortened
585 - $url: url to be shortened
586 - $shortenerName: name of the requested shortener
587 - $shortenedUrl: short version of the url
589 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
595 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
601 StartStyleElement: Before a <style...> element is written
607 EndStyleElement: After a <style...> element is written
613 StartScriptElement: Before a <script...> element is written
618 EndScriptElement: After a <script...> element is written
623 StartInlineScriptElement: Before a <script...> element is written
628 EndInlineScriptElement: After a <script...> element is written
633 StartLog: Before writing to the logs
638 EndLog: After writing to the logs
643 StartBlockProfile: when we're about to block
644 - $user: the person doing the block
645 - $profile: the person getting blocked, can be remote
647 EndBlockProfile: when a block has succeeded
648 - $user: the person doing the block
649 - $profile: the person blocked, can be remote
651 StartUnblockProfile: when we're about to unblock
652 - $user: the person doing the unblock
653 - $profile: the person getting unblocked, can be remote
655 EndUnblockProfile: when an unblock has succeeded
656 - $user: the person doing the unblock
657 - $profile: the person unblocked, can be remote
659 StartSubscribe: when a subscription is starting
660 - $user: the person subscribing
661 - $other: the person being subscribed to
663 EndSubscribe: when a subscription is finished
664 - $user: the person subscribing
665 - $other: the person being subscribed to
667 StartUnsubscribe: when an unsubscribe is starting
668 - $user: the person unsubscribing
669 - $other: the person being unsubscribed from
671 EndUnsubscribe: when an unsubscribe is done
672 - $user: the person unsubscribing
673 - $other: the person being unsubscribed to
675 StartJoinGroup: when a user is joining a group
676 - $group: the group being joined
677 - $user: the user joining
679 EndJoinGroup: when a user finishes joining a group
680 - $group: the group being joined
681 - $user: the user joining
683 StartLeaveGroup: when a user is leaving a group
684 - $group: the group being left
685 - $user: the user leaving
687 EndLeaveGroup: when a user has left a group
688 - $group: the group being left
689 - $user: the user leaving
691 StartShowContentLicense: Showing the default license for content
692 - $action: the current action
694 EndShowContentLicense: Showing the default license for content
695 - $action: the current action