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 Autoload: When trying to autoload a class
166 - $cls: the class being sought. A plugin might require_once the file for the class.
168 SensitiveAction: determines if an action is 'sensitive' and should use SSL
169 - $action: name of the action, like 'login'
170 - $sensitive: flag for whether this is a sensitive action
172 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
173 - $action: name of the action, like 'register'
174 - $login: flag for whether this is a login action
176 StartShowHead: called before showing the <head> element and children
177 - $action: action object being show
179 EndShowHead: called after showing the <head> element (and </head>)
180 - $action: action object being shown
182 StartShowBody: called before showing the <body> element and children
183 - $action: action object being shown
185 EndShowBody: called after showing the <body> element (and </body>)
186 - $action: action object being shown
188 StartPersonalGroupNav: beginning of personal group nav menu
189 - $action: action object being shown
191 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
192 - $action: action object being shown
194 StartEndHTML: just before the </html> tag
195 - $action: action object being shown
197 EndEndHTML: just after the </html> tag
198 - $action: action object being shown
200 StartShowDesign: just before showing a site, user, or group design
201 - $action: action object being shown
203 EndShowDesign: just after showing a site, user, or group design
204 - $action: action object being shown
206 StartShowExportData: just before showing the <div> with export data (feeds)
207 - $action: action object being shown
209 EndShowExportData: just after showing the <div> with export data (feeds)
210 - $action: action object being shown
212 StartShowNoticeItem: just before showing the notice item
213 - $action: action object being shown
215 EndShowNoticeItem: just after showing the notice item
216 - $action: action object being shown
218 StartShowPageNotice: just before showing the page notice (instructions or error)
219 - $action: action object being shown
221 EndShowPageNotice: just after showing the page notice (instructions or error)
222 - $action: action object being shown
224 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
225 - $action: action object being shown
227 StartProfileFormData: just before showing text entry fields on profile settings page
228 - $action: action object being shown
230 EndProfileFormData: just after showing text entry fields on profile settings page
231 - $action: action object being shown
233 StartProfileSaveForm: before starting to save a profile settings form
234 - $action: action object being shown
236 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
237 - $action: action object being shown
239 StartRegistrationFormData: just before showing text entry fields on registration page
240 - $action: action object being shown
242 EndRegistrationFormData: just after showing text entry fields on registration page
243 - $action: action object being shown
245 StartRegistrationTry: before validating and saving a new user
246 - $action: action object being shown
248 EndRegistrationTry: after saving a new user (note: no profile or user object!)
249 - $action: action object being shown
251 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
252 - $qm: empty queue manager to set
254 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
255 - $action: action object being shown
256 - $user: current user
258 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
259 - $title: title of the document
260 - $output: HTML output to show
262 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
263 - $title: title of the document
264 - $output: HTML output to show
266 StartApiRss: after the rss <channel> element is started
267 - $action: action object being shown
269 StartApiAtom: after the <feed> element is started
270 - $action: action object being shown
272 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
273 - $notice: the notice being added
274 - &$transports: modifiable list of transports (as strings) to queue for
276 EndEnqueueNotice: after adding a notice to the queues
277 - $notice: the notice being added
278 - $transports: modifiable list of transports to use
280 UnqueueHandleNotice: Handle a notice when no queue manager is available
281 - $notice: the notice to handle
282 - $queue: the "queue" that is being executed
284 GetValidDaemons: Just before determining which daemons to run
285 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
287 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
288 - &$notice: notice to handle
290 StartShowHeadElements: Right after the <head> tag
291 - $action: the current action
293 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
294 - $action: the current action
296 CheckSchema: chance to check the schema
298 StartProfilePageProfileSection: Starting to show the section of the
299 profile page with the actual profile data;
300 hook to prevent showing the profile (e.g.)
301 - $action: the current action
302 - &$profile: the profile being shown
304 StartProfilePageProfileElements: inside the section, before the first
305 element; prepend elements here
306 - $action: the current action
307 - &$profile: the profile being shown
309 EndProfilePageProfileElements: inside the section, after the last element;
311 - $action: the current action
312 - &$profile: the profile being shown
314 EndProfilePageProfileSection: After showing the section of the profile
315 page with the profile elements
316 - $action: the current action
317 - &$profile: the profile being shown
319 StartProfilePageActionsSection: Starting to show the section of the
320 profile page with action links; hook
321 to hide them (for example)
322 - $action: the current action
323 - &$profile: the profile being shown
325 StartProfilePageActionsElements: inside the list, before the first
326 element; prepend elements here
327 - $action: the current action
328 - &$profile: the profile being shown
330 EndProfilePageActionsElements: inside the list, after the last element;
332 - $action: the current action
333 - &$profile: the profile being shown
335 EndProfilePageActionsSection: After showing the section of the profile
336 page with the entity actions
337 - $action: the current action
338 - &$profile: the profile being shown
340 StartProfilePageAvatar: before showing the avatar on the profile page
341 - $action: the current action
342 - &$profile: the profile being shown
344 EndProfilePageAvatar: after showing the avatar on the profile page
345 - $action: the current action
346 - &$profile: the profile being shown
348 StartProfilePageNickname: before showing the nickname on the profile page
349 - $action: the current action
350 - &$profile: the profile being shown
352 EndProfilePageNickname: after showing the nickname on the profile page
353 - $action: the current action
354 - &$profile: the profile being shown
356 StartProfilePageFullName: before showing the fullname on the profile page
357 - $action: the current action
358 - &$profile: the profile being shown
360 EndProfilePageFullName: after showing the fullname on the profile page
361 - $action: the current action
362 - &$profile: the profile being shown
364 StartProfilePageLocation: before showing the location on the profile page
365 - $action: the current action
366 - &$profile: the profile being shown
368 EndProfilePageLocation: after showing the location on the profile page
369 - $action: the current action
370 - &$profile: the profile being shown
372 StartProfilePageHomepage: before showing the homepage link on the profile page
373 - $action: the current action
374 - &$profile: the profile being shown
376 EndProfilePageHomepage: after showing the homepage on the profile page
377 - $action: the current action
378 - &$profile: the profile being shown
380 StartProfilePageBio: before showing the bio on the profile page
381 - $action: the current action
382 - &$profile: the profile being shown
384 EndProfilePageBio: after showing the bio on the profile page
385 - $action: the current action
386 - &$profile: the profile being shown
388 StartProfilePageProfileTags: before showing the tags on the profile page
389 - $action: the current action
390 - &$profile: the profile being shown
392 EndProfilePageProfileTags: after showing the tags on the profile page
393 - $action: the current action
394 - &$profile: the profile being shown
396 StartProfileList: when starting a list of profiles (before <ul>)
397 - $profilelist: ProfileList widget, with $profile, $action, and $out
399 EndProfileList: when ending a list of profiles (after </ul>)
400 - $profilelist: ProfileList widget
402 StartProfileListItem: when starting to show a profile list item
403 - $item: ProfileListItem widget
405 EndProfileListItem: after showing a profile list item
406 - $item: ProfileListItem widget
408 StartProfileListItemProfile: the profile data part of the item
409 - $item: ProfileListItem widget
411 EndProfileListItemProfile: the profile data part of the item
412 - $item: ProfileListItem widget
414 StartProfileListItemActions: the actions (buttons) for an item
415 - $item: ProfileListItem widget
417 EndProfileListItemActions: the actions (buttons) for an item
418 - $item: ProfileListItem widget
420 StartProfileListItemProfileElements: inside the <div>
421 - $item: ProfileListItem widget
423 EndProfileListItemProfileElements: inside the <div>
424 - $item: ProfileListItem widget
426 StartProfileListItemAvatar: Showing a profile list avatar
427 - $item: ProfileListItem widget
429 EndProfileListItemAvatar: Showing a profile list avatar
430 - $item: ProfileListItem widget
432 StartProfileListItemFullName: Showing the profile list full name
433 - $item: ProfileListItem widget
435 EndProfileListItemFullName: Showing the profile list full name
436 - $item: ProfileListItem widget
438 StartProfileListItemLocation: Showing the profile list location
439 - $item: ProfileListItem widget
441 EndProfileListItemLocation: Showing the profile list location
442 - $item: ProfileListItem widget
444 StartProfileListItemHomepage: Showing the profile list homepage
445 - $item: ProfileListItem widget
447 EndProfileListItemHomepage: Showing the profile list homepage
448 - $item: ProfileListItem widget
450 StartProfileListItemBio: Showing the profile list bio
451 - $item: ProfileListItem widget
453 EndProfileListItemBio: Showing the profile list bio
454 - $item: ProfileListItem widget
456 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
457 - $item: ProfileListItem widget
459 EndProfileListItemActionElements: Showing profile list actions (append a button here)
460 - $item: ProfileListItem widget
462 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
463 - $action: the current action
464 - &$xrdsoutputter - XRDSOutputter object to write to
466 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
467 - $action: the current action
468 - &$xrdsoutputter - XRDSOutputter object to write to
470 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
471 - $action: the current action
472 - &$xrdsoutputter - XRDSOutputter object to write to
474 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
475 - $action: the current action
476 - &$xrdsoutputter - XRDSOutputter object to write to
478 CheckPassword: Check a username/password
479 - $nickname: The nickname to check
480 - $password: The password to check
481 - &$authenticated: set to true to indicate authentication succeeded.
483 AutoRegister: Register a new user with the given nickname. Should insert a new User and Profile into the database.
484 - $nickname: The nickname to register
486 ChangePassword: Handle a password change request
487 - $nickname: user's nickname
488 - $oldpassword: the user's old password
489 - $newpassword: the desired new password
490 - &$errormsg: set this to an error message if the password could not be changed. If the password was changed, leave this as false