EVENTS.txt 17.2 KB
Newer Older
1
InitializePlugin: a chance to initialize a plugin in a complete environment
2 3 4

CleanupPlugin: a chance to cleanup a plugin at the end of a program

5 6 7 8 9 10 11 12 13 14 15
StartPrimaryNav: Showing the primary nav menu
- $action: the current action

EndPrimaryNav: At the end of the primary nav menu
- $action: the current action

StartSecondaryNav: Showing the secondary nav menu
- $action: the current action

EndSecondaryNav: At the end of the secondary nav menu
- $action: the current action
16

17 18 19 20 21 22
StartShowStyles: Showing Style links; good place to add UA style resets
- $action: the current action

EndShowStyles: End showing Style links; good place to add custom styles
- $action: the current action

23
StartShowStatusNetStyles: Showing StatusNet Style links
24 25
- $action: the current action

26
EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
27 28
- $action: the current action

29 30 31 32
StartShowLaconicaStyles: backwards compatibility; deprecated
- $action: the current action

EndShowLaconicaStyles: backwards compatibility; deprecated
33 34
- $action: the current action

35
StartShowUAStyles: Showing custom User-Agent style links
36 37
- $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 40
- $action: the current action

41 42 43 44 45 46 47 48 49 50 51 52 53
StartShowScripts: Showing JavaScript links
- $action: the current action

EndShowScripts: End showing JavaScript links; good place to add custom
		links like Google Analytics
- $action: the current action

StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
- $action: the current action

EndShowJQueryScripts: End showing JQuery script links
- $action: the current action

54
StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
55 56
- $action: the current action

57
EndShowStatusNetScripts: End showing StatusNet script links
58 59
- $action: the current action

60
StartShowLaconicaScripts: backwards compatibility; deprecated
61 62
- $action: the current action

63
EndShowLaconicaScripts: backwards compatibility; deprecated
64 65
- $action: the current action

66 67 68 69 70
StartShowSections: Start the list of sections in the sidebar
- $action: the current action

EndShowSections: End the list of sections in the sidebar
- $action: the current action
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

StartShowHeader: Showing before the header container
- $action: the current action

EndShowHeader: Showing after the header container
- $action: the current action

StartShowFooter: Showing before the footer container
- $action: the current action

EndShowFooter: Showing after the footer container
- $action: the current action

StartShowContentBlock: Showing before the content container
- $action: the current action

EndShowContentBlock: Showing after the content container
- $action: the current action

90 91 92 93 94 95
StartShowAside: Showing before the Aside container
- $action: the current action

EndShowAside: Showing after the Aside container
- $action: the current action

96 97 98 99 100 101
StartShowNoticeFormData: Showing before the notice form data
- $action: the current action

EndShowNoticeFormData: Showing after the notice form data
- $action: the current action

102 103 104 105 106 107
StartNoticeSave: before inserting a notice (good place for content filters)
- $notice: notice being saved (no ID or URI)

EndNoticeSave: after inserting a notice and related code
- $notice: notice that was saved (with ID and URI)

Sarven Capadisli's avatar
Sarven Capadisli committed
108 109 110 111 112 113
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action

EndShowLocalNavBlock: At the end of the local nav menu
- $action: the current action

114
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
115 116 117 118 119
- $action: the current action

EndShowHTML: Showing after the html element
- $action: the current action

120 121 122 123 124
StartPublicGroupNav: Showing the public group nav menu
- $action: the current action

EndPublicGroupNav: At the end of the public group nav menu
- $action: the current action
125

126 127 128 129 130 131
StartSubGroupNav: Showing the subscriptions group nav menu
- $action: the current action

EndSubGroupNav: At the end of the subscriptions group nav menu
- $action: the current action

132 133 134
StartInitializeRouter: Before the router instance has been initialized; good place to add routes
- $m: the Net_URL_Mapper that has just been set up

135 136 137
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up

138 139 140 141 142 143
StartLogout: Before logging out
- $action: the logout action

EndLogout: After logging out
- $action: the logout action

144 145
ArgsInitialized: After the argument array has been initialized
- $args: associative array of arguments, can be modified
146 147 148 149 150 151

StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
- $action: the current action

EndAddressData: At the end of <address>
- $action: the current action
152 153 154 155 156 157

StartLoginGroupNav: Before showing the login and register navigation menu
- $action: the current action

EndLoginGroupNav: After showing the login and register navigation menu
- $action: the current action
158 159 160 161 162 163

StartAccountSettingsNav: Before showing the account settings menu
- $action: the current action

EndAccountSettingsNav: After showing the account settings menu
- $action: the current action
164 165 166

Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
167 168 169 170 171

SensitiveAction: determines if an action is 'sensitive' and should use SSL
- $action: name of the action, like 'login'
- $sensitive: flag for whether this is a sensitive action

172 173 174
LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
- $action: name of the action, like 'register'
- $login: flag for whether this is a login action
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

StartShowHead: called before showing the <head> element and children
- $action: action object being show

EndShowHead: called after showing the <head> element (and </head>)
- $action: action object being shown

StartShowBody: called before showing the <body> element and children
- $action: action object being shown

EndShowBody: called after showing the <body> element (and </body>)
- $action: action object being shown

StartPersonalGroupNav: beginning of personal group nav menu
- $action: action object being shown

EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
- $action: action object being shown

StartEndHTML: just before the </html> tag
- $action: action object being shown

EndEndHTML: just after the </html> tag
- $action: action object being shown

StartShowDesign: just before showing a site, user, or group design
- $action: action object being shown

EndShowDesign: just after showing a site, user, or group design
- $action: action object being shown

StartShowExportData: just before showing the <div> with export data (feeds)
- $action: action object being shown

EndShowExportData: just after showing the <div> with export data (feeds)
- $action: action object being shown

212 213 214 215 216 217
StartShowNoticeItem: just before showing the notice item
- $action: action object being shown

EndShowNoticeItem: just after showing the notice item
- $action: action object being shown

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
StartShowPageNotice: just before showing the page notice (instructions or error)
- $action: action object being shown

EndShowPageNotice: just after showing the page notice (instructions or error)
- $action: action object being shown

StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
- $action: action object being shown

StartProfileFormData: just before showing text entry fields on profile settings page
- $action: action object being shown

EndProfileFormData: just after showing text entry fields on profile settings page
- $action: action object being shown

StartProfileSaveForm: before starting to save a profile settings form
- $action: action object being shown

EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
- $action: action object being shown

StartRegistrationFormData: just before showing text entry fields on registration page
- $action: action object being shown

EndRegistrationFormData: just after showing text entry fields on registration page
- $action: action object being shown

StartRegistrationTry: before validating and saving a new user
- $action: action object being shown

EndRegistrationTry: after saving a new user (note: no profile or user object!)
- $action: action object being shown

StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
- $qm: empty queue manager to set
253 254 255 256

RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
- $action: action object being shown
- $user: current user
257 258 259 260 261 262 263 264

StartLoadDoc: before loading a help doc (hook this to show your own documentation)
- $title: title of the document
- $output: HTML output to show

EndLoadDoc: after loading a help doc (hook this to modify other documentation)
- $title: title of the document
- $output: HTML output to show
265 266 267 268 269 270 271

StartApiRss: after the rss <channel> element is started
- $action: action object being shown

StartApiAtom: after the <feed> element is started
- $action: action object being shown

272 273 274 275 276 277 278
StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
- $notice: the notice being added
- &$transports: modifiable list of transports (as strings) to queue for

EndEnqueueNotice: after adding a notice to the queues
- $notice: the notice being added
- $transports: modifiable list of transports to use
279 280 281

UnqueueHandleNotice: Handle a notice when no queue manager is available
- $notice: the notice to handle
282 283 284 285
- $queue: the "queue" that is being executed

GetValidDaemons: Just before determining which daemons to run
- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
286 287 288

HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
- &$notice: notice to handle
289

290 291 292 293 294
StartShowHeadElements: Right after the <head> tag
- $action: the current action

EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
- $action: the current action
Evan Prodromou's avatar
Evan Prodromou committed
295 296

CheckSchema: chance to check the schema
297

298
StartProfilePageProfileSection: Starting to show the section of the
299 300
                              profile page with the actual profile data;
                              hook to prevent showing the profile (e.g.)
301
- $userprofile: UserProfile widget
302 303
- &$profile: the profile being shown

304
StartProfilePageProfileElements: inside the section, before the first
305
                               element; prepend elements here
306
- $userprofile: UserProfile widget
307 308
- &$profile: the profile being shown

309
EndProfilePageProfileElements: inside the section, after the last element;
310
                             append elements here
311
- $userprofile: UserProfile widget
312 313
- &$profile: the profile being shown

314
EndProfilePageProfileSection: After showing the section of the profile
315
                            page with the profile elements
316
- $userprofile: UserProfile widget
317 318
- &$profile: the profile being shown

319
StartProfilePageActionsSection: Starting to show the section of the
320 321
                                    profile page with action links; hook
                                    to hide them (for example)
322
- $userprofile: UserProfile widget
323 324
- &$profile: the profile being shown

325
StartProfilePageActionsElements: inside the list, before the first
326
                                     element; prepend elements here
327
- $userprofile: UserProfile widget
328 329
- &$profile: the profile being shown

330
EndProfilePageActionsElements: inside the list, after the last element;
331
                                   append elements here
332
- $userprofile: UserProfile widget
333 334
- &$profile: the profile being shown

335
EndProfilePageActionsSection: After showing the section of the profile
336
                                  page with the entity actions
337
- $userprofile: UserProfile widget
338
- &$profile: the profile being shown
339 340

StartProfilePageAvatar: before showing the avatar on the profile page
341
- $userprofile: UserProfile widget
342 343 344
- &$profile: the profile being shown

EndProfilePageAvatar: after showing the avatar on the profile page
345
- $userprofile: UserProfile widget
346 347 348
- &$profile: the profile being shown

StartProfilePageNickname: before showing the nickname on the profile page
349
- $userprofile: UserProfile widget
350 351 352
- &$profile: the profile being shown

EndProfilePageNickname: after showing the nickname on the profile page
353
- $userprofile: UserProfile widget
354 355 356
- &$profile: the profile being shown

StartProfilePageFullName: before showing the fullname on the profile page
357
- $userprofile: UserProfile widget
358 359 360
- &$profile: the profile being shown

EndProfilePageFullName: after showing the fullname on the profile page
361
- $userprofile: UserProfile widget
362 363 364
- &$profile: the profile being shown

StartProfilePageLocation: before showing the location on the profile page
365
- $userprofile: UserProfile widget
366 367 368
- &$profile: the profile being shown

EndProfilePageLocation: after showing the location on the profile page
369
- $userprofile: UserProfile widget
370 371 372
- &$profile: the profile being shown

StartProfilePageHomepage: before showing the homepage link on the profile page
373
- $userprofile: UserProfile widget
374 375 376
- &$profile: the profile being shown

EndProfilePageHomepage: after showing the homepage on the profile page
377
- $userprofile: UserProfile widget
378 379 380
- &$profile: the profile being shown

StartProfilePageBio: before showing the bio on the profile page
381
- $userprofile: UserProfile widget
382 383 384
- &$profile: the profile being shown

EndProfilePageBio: after showing the bio on the profile page
385
- $userprofile: UserProfile widget
386 387 388
- &$profile: the profile being shown

StartProfilePageProfileTags: before showing the tags on the profile page
389
- $userprofile: UserProfile widget
390 391 392
- &$profile: the profile being shown

EndProfilePageProfileTags: after showing the tags on the profile page
393
- $userprofile: UserProfile widget
394 395
- &$profile: the profile being shown

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
StartProfileList: when starting a list of profiles (before <ul>)
- $profilelist: ProfileList widget, with $profile, $action, and $out

EndProfileList: when ending a list of profiles (after </ul>)
- $profilelist: ProfileList widget

StartProfileListItem: when starting to show a profile list item
- $item: ProfileListItem widget

EndProfileListItem: after showing a profile list item
- $item: ProfileListItem widget

StartProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

EndProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

StartProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

EndProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

StartProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

EndProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

StartProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

EndProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

StartProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

EndProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

StartProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

EndProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

StartProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

EndProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

StartProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

EndProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
- $item: ProfileListItem widget

EndProfileListItemActionElements: Showing profile list actions (append a button here)
- $item: ProfileListItem widget
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndUserXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
Craig Andrews's avatar
Craig Andrews committed
477 478 479 480 481

CheckPassword: Check a username/password
- $nickname: The nickname to check
- $password: The password to check
- &$authenticated: set to true to indicate authentication succeeded.
Craig Andrews's avatar
Craig Andrews committed
482 483 484 485

AutoRegister: Register a new user with the given nickname. Should insert a new User and Profile into the database.
- $nickname: The nickname to register

Craig Andrews's avatar
Craig Andrews committed
486 487 488 489 490 491
ChangePassword: Handle a password change request
- $nickname: user's nickname
- $oldpassword: the user's old password
- $newpassword: the desired new password
- &$errormsg: set this to an error message if the password could not be changed. If the password was changed, leave this as false