EVENTS.txt

   1 InitializePlugin: a chance to initialize a plugin in a complete environment
   2
   3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
   4
   5 StartPrimaryNav: Showing the primary nav menu
   6 - $action: the current action
   7
   8 EndPrimaryNav: At the end of the primary nav menu
   9 - $action: the current action
  10
  11 StartSecondaryNav: Showing the secondary nav menu
  12 - $action: the current action
  13
  14 EndSecondaryNav: At the end of the secondary nav menu
  15 - $action: the current action
  16
  17 StartShowStyles: Showing Style links; good place to add UA style resets
  18 - $action: the current action
  19
  20 EndShowStyles: End showing Style links; good place to add custom styles
  21 - $action: the current action
  22
  23 StartShowStatusNetStyles: Showing StatusNet Style links
  24 - $action: the current action
  25
  26 EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
  27 - $action: the current action
  28
  29 StartShowLaconicaStyles: backwards compatibility; deprecated
  30 - $action: the current action
  31
  32 EndShowLaconicaStyles: backwards compatibility; deprecated
  33 - $action: the current action
  34
  35 StartShowUAStyles: Showing custom User-Agent style links
  36 - $action: the current action
  37
  38 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  39 - $action: the current action
  40
  41 StartShowScripts: Showing JavaScript links
  42 - $action: the current action
  43
  44 EndShowScripts: End showing JavaScript links; good place to add custom
  45                 links like Google Analytics
  46 - $action: the current action
  47
  48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  49 - $action: the current action
  50
  51 EndShowJQueryScripts: End showing JQuery script links
  52 - $action: the current action
  53
  54 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  55 - $action: the current action
  56
  57 EndShowStatusNetScripts: End showing StatusNet script links
  58 - $action: the current action
  59
  60 StartShowLaconicaScripts: backwards compatibility; deprecated
  61 - $action: the current action
  62
  63 EndShowLaconicaScripts: backwards compatibility; deprecated
  64 - $action: the current action
  65
  66 StartShowSections: Start the list of sections in the sidebar
  67 - $action: the current action
  68
  69 EndShowSections: End the list of sections in the sidebar
  70 - $action: the current action
  71
  72 StartShowHeader: Showing before the header container
  73 - $action: the current action
  74
  75 EndShowHeader: Showing after the header container
  76 - $action: the current action
  77
  78 StartShowFooter: Showing before the footer container
  79 - $action: the current action
  80
  81 EndShowFooter: Showing after the footer container
  82 - $action: the current action
  83
  84 StartShowContentBlock: Showing before the content container
  85 - $action: the current action
  86
  87 EndShowContentBlock: Showing after the content container
  88 - $action: the current action
  89
  90 StartShowAside: Showing before the Aside container
  91 - $action: the current action
  92
  93 EndShowAside: Showing after the Aside container
  94 - $action: the current action
  95
  96 StartShowNoticeFormData: Showing before the notice form data
  97 - $action: the current action
  98
  99 EndShowNoticeFormData: Showing after the notice form data
 100 - $action: the current action
 101
 102 StartNoticeSave: before inserting a notice (good place for content filters)
 103 - $notice: notice being saved (no ID or URI)
 104
 105 EndNoticeSave: after inserting a notice and related code
 106 - $notice: notice that was saved (with ID and URI)
 107
 108 StartShowLocalNavBlock: Showing the local nav menu
 109 - $action: the current action
 110
 111 EndShowLocalNavBlock: At the end of the local nav menu
 112 - $action: the current action
 113
 114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
 115 - $action: the current action
 116
 117 EndShowHTML: Showing after the html element
 118 - $action: the current action
 119
 120 StartPublicGroupNav: Showing the public group nav menu
 121 - $action: the current action
 122
 123 EndPublicGroupNav: At the end of the public group nav menu
 124 - $action: the current action
 125
 126 StartSubGroupNav: Showing the subscriptions group nav menu
 127 - $action: the current action
 128
 129 EndSubGroupNav: At the end of the subscriptions group nav menu
 130 - $action: the current action
 131
 132 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
 133 - $m: the Net_URL_Mapper that has just been set up
 134
 135 RouterInitialized: After the router instance has been initialized
 136 - $m: the Net_URL_Mapper that has just been set up
 137
 138 StartLogout: Before logging out
 139 - $action: the logout action
 140
 141 EndLogout: After logging out
 142 - $action: the logout action
 143
 144 ArgsInitialized: After the argument array has been initialized
 145 - $args: associative array of arguments, can be modified
 146
 147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 148 - $action: the current action
 149
 150 EndAddressData: At the end of <address>
 151 - $action: the current action
 152
 153 StartLoginGroupNav: Before showing the login and register navigation menu
 154 - $action: the current action
 155
 156 EndLoginGroupNav: After showing the login and register navigation menu
 157 - $action: the current action
 158
 159 StartAccountSettingsNav: Before showing the account settings menu
 160 - $action: the current action
 161
 162 EndAccountSettingsNav: After showing the account settings menu
 163 - $action: the current action
 164
 165 Autoload: When trying to autoload a class
 166 - $cls: the class being sought. A plugin might require_once the file for the class.
 167
 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
 171
 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
 175
 176 StartShowHead: called before showing the <head> element and children
 177 - $action: action object being show
 178
 179 EndShowHead: called after showing the <head> element (and </head>)
 180 - $action: action object being shown
 181
 182 StartShowBody: called before showing the <body> element and children
 183 - $action: action object being shown
 184
 185 EndShowBody: called after showing the <body> element (and </body>)
 186 - $action: action object being shown
 187
 188 StartPersonalGroupNav: beginning of personal group nav menu
 189 - $action: action object being shown
 190
 191 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 192 - $action: action object being shown
 193
 194 StartGroupGroupNav: Showing the group nav menu
 195 - $action: the current action
 196
 197 EndGroupGroupNav: At the end of the group nav menu
 198 - $action: the current action
 199
 200 StartEndHTML: just before the </html> tag
 201 - $action: action object being shown
 202
 203 EndEndHTML: just after the </html> tag
 204 - $action: action object being shown
 205
 206 StartShowDesign: just before showing a site, user, or group design
 207 - $action: action object being shown
 208
 209 EndShowDesign: just after showing a site, user, or group design
 210 - $action: action object being shown
 211
 212 StartShowExportData: just before showing the <div> with export data (feeds)
 213 - $action: action object being shown
 214
 215 EndShowExportData: just after showing the <div> with export data (feeds)
 216 - $action: action object being shown
 217
 218 StartShowNoticeItem: just before showing the notice item
 219 - $action: action object being shown
 220
 221 EndShowNoticeItem: just after showing the notice item
 222 - $action: action object being shown
 223
 224 StartShowPageNotice: just before showing the page notice (instructions or error)
 225 - $action: action object being shown
 226
 227 EndShowPageNotice: just after showing the page notice (instructions or error)
 228 - $action: action object being shown
 229
 230 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 231 - $action: action object being shown
 232
 233 StartProfileFormData: just before showing text entry fields on profile settings page
 234 - $action: action object being shown
 235
 236 EndProfileFormData: just after showing text entry fields on profile settings page
 237 - $action: action object being shown
 238
 239 StartProfileSaveForm: before starting to save a profile settings form
 240 - $action: action object being shown
 241
 242 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 243 - $action: action object being shown
 244
 245 StartRegistrationFormData: just before showing text entry fields on registration page
 246 - $action: action object being shown
 247
 248 EndRegistrationFormData: just after showing text entry fields on registration page
 249 - $action: action object being shown
 250
 251 StartRegistrationTry: before validating and saving a new user
 252 - $action: action object being shown
 253
 254 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 255 - $action: action object being shown
 256
 257 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 258 - $qm: empty queue manager to set
 259
 260 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 261 - $action: action object being shown
 262 - $user: current user
 263
 264 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 265 - $title: title of the document
 266 - $output: HTML output to show
 267
 268 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 269 - $title: title of the document
 270 - $output: HTML output to show
 271
 272 StartApiRss: after the rss <channel> element is started
 273 - $action: action object being shown
 274
 275 StartApiAtom: after the <feed> element is started
 276 - $action: action object being shown
 277
 278 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 279 - $notice: the notice being added
 280 - &$transports: modifiable list of transports (as strings) to queue for
 281
 282 EndEnqueueNotice: after adding a notice to the queues
 283 - $notice: the notice being added
 284 - $transports: modifiable list of transports to use
 285
 286 UnqueueHandleNotice: Handle a notice when no queue manager is available
 287 - $notice: the notice to handle
 288 - $queue: the "queue" that is being executed
 289
 290 GetValidDaemons: Just before determining which daemons to run
 291 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 292
 293 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 294 - &$notice: notice to handle
 295
 296 StartShowHeadElements: Right after the <head> tag
 297 - $action: the current action
 298
 299 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 300 - $action: the current action
 301
 302 CheckSchema: chance to check the schema
 303
 304 StartProfilePageProfileSection: Starting to show the section of the
 305                               profile page with the actual profile data;
 306                               hook to prevent showing the profile (e.g.)
 307 - $userprofile: UserProfile widget
 308 - &$profile: the profile being shown
 309
 310 StartProfilePageProfileElements: inside the section, before the first
 311                                element; prepend elements here
 312 - $userprofile: UserProfile widget
 313 - &$profile: the profile being shown
 314
 315 EndProfilePageProfileElements: inside the section, after the last element;
 316                              append elements here
 317 - $userprofile: UserProfile widget
 318 - &$profile: the profile being shown
 319
 320 EndProfilePageProfileSection: After showing the section of the profile
 321                             page with the profile elements
 322 - $userprofile: UserProfile widget
 323 - &$profile: the profile being shown
 324
 325 StartProfilePageActionsSection: Starting to show the section of the
 326                                     profile page with action links; hook
 327                                     to hide them (for example)
 328 - $userprofile: UserProfile widget
 329 - &$profile: the profile being shown
 330
 331 StartProfilePageActionsElements: inside the list, before the first
 332                                      element; prepend elements here
 333 - $userprofile: UserProfile widget
 334 - &$profile: the profile being shown
 335
 336 EndProfilePageActionsElements: inside the list, after the last element;
 337                                    append elements here
 338 - $userprofile: UserProfile widget
 339 - &$profile: the profile being shown
 340
 341 EndProfilePageActionsSection: After showing the section of the profile
 342                                   page with the entity actions
 343 - $userprofile: UserProfile widget
 344 - &$profile: the profile being shown
 345
 346 StartProfilePageAvatar: before showing the avatar on the profile page
 347 - $userprofile: UserProfile widget
 348 - &$profile: the profile being shown
 349
 350 EndProfilePageAvatar: after showing the avatar on the profile page
 351 - $userprofile: UserProfile widget
 352 - &$profile: the profile being shown
 353
 354 StartProfilePageNickname: before showing the nickname on the profile page
 355 - $userprofile: UserProfile widget
 356 - &$profile: the profile being shown
 357
 358 EndProfilePageNickname: after showing the nickname on the profile page
 359 - $userprofile: UserProfile widget
 360 - &$profile: the profile being shown
 361
 362 StartProfilePageFullName: before showing the fullname on the profile page
 363 - $userprofile: UserProfile widget
 364 - &$profile: the profile being shown
 365
 366 EndProfilePageFullName: after showing the fullname on the profile page
 367 - $userprofile: UserProfile widget
 368 - &$profile: the profile being shown
 369
 370 StartProfilePageLocation: before showing the location on the profile page
 371 - $userprofile: UserProfile widget
 372 - &$profile: the profile being shown
 373
 374 EndProfilePageLocation: after showing the location on the profile page
 375 - $userprofile: UserProfile widget
 376 - &$profile: the profile being shown
 377
 378 StartProfilePageHomepage: before showing the homepage link on the profile page
 379 - $userprofile: UserProfile widget
 380 - &$profile: the profile being shown
 381
 382 EndProfilePageHomepage: after showing the homepage on the profile page
 383 - $userprofile: UserProfile widget
 384 - &$profile: the profile being shown
 385
 386 StartProfilePageBio: before showing the bio on the profile page
 387 - $userprofile: UserProfile widget
 388 - &$profile: the profile being shown
 389
 390 EndProfilePageBio: after showing the bio on the profile page
 391 - $userprofile: UserProfile widget
 392 - &$profile: the profile being shown
 393
 394 StartProfilePageProfileTags: before showing the tags on the profile page
 395 - $userprofile: UserProfile widget
 396 - &$profile: the profile being shown
 397
 398 EndProfilePageProfileTags: after showing the tags on the profile page
 399 - $userprofile: UserProfile widget
 400 - &$profile: the profile being shown
 401
 402 StartProfileList: when starting a list of profiles (before <ul>)
 403 - $profilelist: ProfileList widget, with $profile, $action, and $out
 404
 405 EndProfileList: when ending a list of profiles (after </ul>)
 406 - $profilelist: ProfileList widget
 407
 408 StartProfileListItem: when starting to show a profile list item
 409 - $item: ProfileListItem widget
 410
 411 EndProfileListItem: after showing a profile list item
 412 - $item: ProfileListItem widget
 413
 414 StartProfileListItemProfile: the profile data part of the item
 415 - $item: ProfileListItem widget
 416
 417 EndProfileListItemProfile: the profile data part of the item
 418 - $item: ProfileListItem widget
 419
 420 StartProfileListItemActions: the actions (buttons) for an item
 421 - $item: ProfileListItem widget
 422
 423 EndProfileListItemActions: the actions (buttons) for an item
 424 - $item: ProfileListItem widget
 425
 426 StartProfileListItemProfileElements: inside the <div>
 427 - $item: ProfileListItem widget
 428
 429 EndProfileListItemProfileElements: inside the <div>
 430 - $item: ProfileListItem widget
 431
 432 StartProfileListItemAvatar: Showing a profile list avatar
 433 - $item: ProfileListItem widget
 434
 435 EndProfileListItemAvatar: Showing a profile list avatar
 436 - $item: ProfileListItem widget
 437
 438 StartProfileListItemFullName: Showing the profile list full name
 439 - $item: ProfileListItem widget
 440
 441 EndProfileListItemFullName: Showing the profile list full name
 442 - $item: ProfileListItem widget
 443
 444 StartProfileListItemLocation: Showing the profile list location
 445 - $item: ProfileListItem widget
 446
 447 EndProfileListItemLocation: Showing the profile list location
 448 - $item: ProfileListItem widget
 449
 450 StartProfileListItemHomepage: Showing the profile list homepage
 451 - $item: ProfileListItem widget
 452
 453 EndProfileListItemHomepage: Showing the profile list homepage
 454 - $item: ProfileListItem widget
 455
 456 StartProfileListItemBio: Showing the profile list bio
 457 - $item: ProfileListItem widget
 458
 459 EndProfileListItemBio: Showing the profile list bio
 460 - $item: ProfileListItem widget
 461
 462 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 463 - $item: ProfileListItem widget
 464
 465 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 466 - $item: ProfileListItem widget
 467
 468 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 469 - $action: the current action
 470 - &$xrdsoutputter - XRDSOutputter object to write to
 471
 472 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 473 - $action: the current action
 474 - &$xrdsoutputter - XRDSOutputter object to write to
 475
 476 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 477 - $action: the current action
 478 - &$xrdsoutputter - XRDSOutputter object to write to
 479
 480 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 481 - $action: the current action
 482 - &$xrdsoutputter - XRDSOutputter object to write to
 483
 484 CheckPassword: Check a username/password
 485 - $nickname: The nickname to check
 486 - $password: The password to check
 487 - &$authenticated: set to true to indicate authentication succeeded.
 488
 489 AutoRegister: Register a new user with the given nickname. Should insert a new User and Profile into the database.
 490 - $nickname: The nickname to register
 491
 492 ChangePassword: Handle a password change request
 493 - $nickname: user's nickname
 494 - $oldpassword: the user's old password
 495 - $newpassword: the desired new password
 496 - &$errormsg: set this to an error message if the password could not be changed. If the password was changed, leave this as false
 497
 498 CanUserChangeField: Determines if a user is allowed to change a specific profile field
 499 - $nickname: nickname of the user who would like to know which of their profile fields are mutable
 500 - $field: name of the field the user wants to change (nickname, fullname, password, avatar, etc)
 501
 502 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 503 - $user: User object
 504 - &$related: array of DB_DataObject class names to delete entries on matching user_id.