| 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 |
ArgsInitialize: 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 |
StartShowSiteNotice: Before showing site notice |
| 154 |
- $action: the current action |
| 155 |
|
| 156 |
EndShowSiteNotice: After showing site notice |
| 157 |
- $action: the current action |
| 158 |
|
| 159 |
StartLoginGroupNav: Before showing the login and register navigation menu |
| 160 |
- $action: the current action |
| 161 |
|
| 162 |
EndLoginGroupNav: After showing the login and register navigation menu |
| 163 |
- $action: the current action |
| 164 |
|
| 165 |
StartAccountSettingsNav: Before showing the account settings menu |
| 166 |
- $action: the current action |
| 167 |
|
| 168 |
EndAccountSettingsNav: After showing the account settings menu |
| 169 |
- $action: the current action |
| 170 |
|
| 171 |
StartAccountSettingsProfileMenuItem: Before showing the Profile menu item |
| 172 |
- $widget: AccountSettingsNav instance being shown |
| 173 |
|
| 174 |
EndAccountSettingsProfileMenuItem: After showing the Profile menu item |
| 175 |
- $widget: AccountSettingsNav instance being shown |
| 176 |
|
| 177 |
StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item |
| 178 |
- $widget: AccountSettingsNav instance being shown |
| 179 |
|
| 180 |
EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item |
| 181 |
- $widget: AccountSettingsNav instance being shown |
| 182 |
|
| 183 |
StartAccountSettingsPasswordMenuItem: Before showing the Password menu item |
| 184 |
- $widget: AccountSettingsNav instance being shown |
| 185 |
|
| 186 |
EndAccountSettingsPasswordMenuItem: After showing the Password menu item |
| 187 |
- $widget: AccountSettingsNav instance being shown |
| 188 |
|
| 189 |
StartAccountSettingsEmailMenuItem: Before showing the Email menu item |
| 190 |
- $widget: AccountSettingsNav instance being shown |
| 191 |
|
| 192 |
EndAccountSettingsEmailMenuItem: After showing the Email menu item |
| 193 |
- $widget: AccountSettingsNav instance being shown |
| 194 |
|
| 195 |
StartAccountSettingsDesignMenuItem: Before showing the Design menu item |
| 196 |
- $widget: AccountSettingsNav instance being shown |
| 197 |
|
| 198 |
EndAccountSettingsDesignMenuItem: After showing the Design menu item |
| 199 |
- $widget: AccountSettingsNav instance being shown |
| 200 |
|
| 201 |
StartAccountSettingsOtherMenuItem: Before showing the Other menu item |
| 202 |
- $widget: AccountSettingsNav instance being shown |
| 203 |
|
| 204 |
EndAccountSettingsOtherMenuItem: After showing the Other menu item |
| 205 |
- $widget: AccountSettingsNav instance being shown |
| 206 |
|
| 207 |
Autoload: When trying to autoload a class |
| 208 |
- $cls: the class being sought. A plugin might require_once the file for the class. |
| 209 |
|
| 210 |
SensitiveAction: determines if an action is 'sensitive' and should use SSL |
| 211 |
- $action: name of the action, like 'login' |
| 212 |
- $sensitive: flag for whether this is a sensitive action |
| 213 |
|
| 214 |
LoginAction: determines if an action is a 'login' action (OK for public view in private mode) |
| 215 |
- $action: name of the action, like 'register' |
| 216 |
- $login: flag for whether this is a login action |
| 217 |
|
| 218 |
StartShowHead: called before showing the <head> element and children |
| 219 |
- $action: action object being show |
| 220 |
|
| 221 |
EndShowHead: called after showing the <head> element (and </head>) |
| 222 |
- $action: action object being shown |
| 223 |
|
| 224 |
StartShowBody: called before showing the <body> element and children |
| 225 |
- $action: action object being shown |
| 226 |
|
| 227 |
EndShowBody: called after showing the <body> element (and </body>) |
| 228 |
- $action: action object being shown |
| 229 |
|
| 230 |
StartPersonalGroupNav: beginning of personal group nav menu |
| 231 |
- $action: action object being shown |
| 232 |
|
| 233 |
EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item) |
| 234 |
- $action: action object being shown |
| 235 |
|
| 236 |
StartGroupGroupNav: Showing the group nav menu |
| 237 |
- $action: the current action |
| 238 |
|
| 239 |
EndGroupGroupNav: At the end of the group nav menu |
| 240 |
- $action: the current action |
| 241 |
|
| 242 |
StartEndHTML: just before the </html> tag |
| 243 |
- $action: action object being shown |
| 244 |
|
| 245 |
EndEndHTML: just after the </html> tag |
| 246 |
- $action: action object being shown |
| 247 |
|
| 248 |
StartShowDesign: just before showing a site, user, or group design |
| 249 |
- $action: action object being shown |
| 250 |
|
| 251 |
EndShowDesign: just after showing a site, user, or group design |
| 252 |
- $action: action object being shown |
| 253 |
|
| 254 |
StartShowExportData: just before showing the <div> with export data (feeds) |
| 255 |
- $action: action object being shown |
| 256 |
|
| 257 |
EndShowExportData: just after showing the <div> with export data (feeds) |
| 258 |
- $action: action object being shown |
| 259 |
|
| 260 |
StartShowNoticeItem: just before showing the notice item |
| 261 |
- $action: action object being shown |
| 262 |
|
| 263 |
EndShowNoticeItem: just after showing the notice item |
| 264 |
- $action: action object being shown |
| 265 |
|
| 266 |
StartShowPageNotice: just before showing the page notice (instructions or error) |
| 267 |
- $action: action object being shown |
| 268 |
|
| 269 |
EndShowPageNotice: just after showing the page notice (instructions or error) |
| 270 |
- $action: action object being shown |
| 271 |
|
| 272 |
StartShowPageTitle: just before showing the main h1 title of a page (only for registration) |
| 273 |
- $action: action object being shown |
| 274 |
|
| 275 |
StartProfileFormData: just before showing text entry fields on profile settings page |
| 276 |
- $action: action object being shown |
| 277 |
|
| 278 |
EndProfileFormData: just after showing text entry fields on profile settings page |
| 279 |
- $action: action object being shown |
| 280 |
|
| 281 |
StartProfileSaveForm: before starting to save a profile settings form |
| 282 |
- $action: action object being shown |
| 283 |
|
| 284 |
EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!) |
| 285 |
- $action: action object being shown |
| 286 |
|
| 287 |
StartRegistrationFormData: just before showing text entry fields on registration page |
| 288 |
- $action: action object being shown |
| 289 |
|
| 290 |
EndRegistrationFormData: just after showing text entry fields on registration page |
| 291 |
- $action: action object being shown |
| 292 |
|
| 293 |
StartRegistrationTry: before validating and saving a new user |
| 294 |
- $action: action object being shown |
| 295 |
|
| 296 |
EndRegistrationTry: after saving a new user (note: no profile or user object!) |
| 297 |
- $action: action object being shown |
| 298 |
|
| 299 |
StartAvatarFormData: before displaying avatar form |
| 300 |
- $action: action object being shown |
| 301 |
|
| 302 |
EndAvatarFormData: after displaying avatar form |
| 303 |
- $action: action object being shown |
| 304 |
|
| 305 |
StartAvatarSaveForm: before saving the avatar |
| 306 |
- $action: action object being shown |
| 307 |
|
| 308 |
EndAvatarSaveForm: after saving the avatar |
| 309 |
- $action: action object being shown |
| 310 |
|
| 311 |
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes |
| 312 |
- $qm: empty queue manager to set |
| 313 |
|
| 314 |
RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login) |
| 315 |
- $action: action object being shown |
| 316 |
- $user: current user |
| 317 |
|
| 318 |
StartLoadDoc: before loading a help doc (hook this to show your own documentation) |
| 319 |
- $title: title of the document |
| 320 |
- $output: HTML output to show |
| 321 |
|
| 322 |
EndLoadDoc: after loading a help doc (hook this to modify other documentation) |
| 323 |
- $title: title of the document |
| 324 |
- $output: HTML output to show |
| 325 |
|
| 326 |
StartApiRss: after the rss <channel> element is started |
| 327 |
- $action: action object being shown |
| 328 |
|
| 329 |
StartApiAtom: after the <feed> element is started |
| 330 |
- $action: action object being shown |
| 331 |
|
| 332 |
StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport) |
| 333 |
- $notice: the notice being added |
| 334 |
- &$transports: modifiable list of transports (as strings) to queue for |
| 335 |
|
| 336 |
EndEnqueueNotice: after adding a notice to the queues |
| 337 |
- $notice: the notice being added |
| 338 |
- $transports: modifiable list of transports to use |
| 339 |
|
| 340 |
UnqueueHandleNotice: Handle a notice when no queue manager is available |
| 341 |
- $notice: the notice to handle |
| 342 |
- $queue: the "queue" that is being executed |
| 343 |
|
| 344 |
GetValidDaemons: Just before determining which daemons to run |
| 345 |
- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/ |
| 346 |
|
| 347 |
HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue) |
| 348 |
- &$notice: notice to handle |
| 349 |
|
| 350 |
StartShowHeadElements: Right after the <head> tag |
| 351 |
- $action: the current action |
| 352 |
|
| 353 |
EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head> |
| 354 |
- $action: the current action |
| 355 |
|
| 356 |
CheckSchema: chance to check the schema |
| 357 |
|
| 358 |
StartProfileRemoteSubscribe: Before showing the link to remote subscription |
| 359 |
- $userprofile: UserProfile widget |
| 360 |
- &$profile: the profile being shown |
| 361 |
|
| 362 |
EndProfileRemoteSubscribe: After showing the link to remote subscription |
| 363 |
- $userprofile: UserProfile widget |
| 364 |
- &$profile: the profile being shown |
| 365 |
|
| 366 |
StartGroupSubscribe: Before showing the link to remote subscription |
| 367 |
- $action: the current action |
| 368 |
- $group: the group being shown |
| 369 |
|
| 370 |
EndGroupSubscribe: After showing the link to remote subscription |
| 371 |
- $action: the current action |
| 372 |
- $group: the group being shown |
| 373 |
|
| 374 |
StartProfilePageProfileSection: Starting to show the section of the |
| 375 |
profile page with the actual profile data; |
| 376 |
hook to prevent showing the profile (e.g.) |
| 377 |
- $userprofile: UserProfile widget |
| 378 |
- &$profile: the profile being shown |
| 379 |
|
| 380 |
StartProfilePageProfileElements: inside the section, before the first |
| 381 |
element; prepend elements here |
| 382 |
- $userprofile: UserProfile widget |
| 383 |
- &$profile: the profile being shown |
| 384 |
|
| 385 |
EndProfilePageProfileElements: inside the section, after the last element; |
| 386 |
append elements here |
| 387 |
- $userprofile: UserProfile widget |
| 388 |
- &$profile: the profile being shown |
| 389 |
|
| 390 |
EndProfilePageProfileSection: After showing the section of the profile |
| 391 |
page with the profile elements |
| 392 |
- $userprofile: UserProfile widget |
| 393 |
- &$profile: the profile being shown |
| 394 |
|
| 395 |
StartProfilePageActionsSection: Starting to show the section of the |
| 396 |
profile page with action links; hook |
| 397 |
to hide them (for example) |
| 398 |
- $userprofile: UserProfile widget |
| 399 |
- &$profile: the profile being shown |
| 400 |
|
| 401 |
StartProfilePageActionsElements: inside the list, before the first |
| 402 |
element; prepend elements here |
| 403 |
- $userprofile: UserProfile widget |
| 404 |
- &$profile: the profile being shown |
| 405 |
|
| 406 |
EndProfilePageActionsElements: inside the list, after the last element; |
| 407 |
append elements here |
| 408 |
- $userprofile: UserProfile widget |
| 409 |
- &$profile: the profile being shown |
| 410 |
|
| 411 |
EndProfilePageActionsSection: After showing the section of the profile |
| 412 |
page with the entity actions |
| 413 |
- $userprofile: UserProfile widget |
| 414 |
- &$profile: the profile being shown |
| 415 |
|
| 416 |
StartProfilePageAvatar: before showing the avatar on the profile page |
| 417 |
- $userprofile: UserProfile widget |
| 418 |
- &$profile: the profile being shown |
| 419 |
|
| 420 |
EndProfilePageAvatar: after showing the avatar on the profile page |
| 421 |
- $userprofile: UserProfile widget |
| 422 |
- &$profile: the profile being shown |
| 423 |
|
| 424 |
StartProfilePageNickname: before showing the nickname on the profile page |
| 425 |
- $userprofile: UserProfile widget |
| 426 |
- &$profile: the profile being shown |
| 427 |
|
| 428 |
EndProfilePageNickname: after showing the nickname on the profile page |
| 429 |
- $userprofile: UserProfile widget |
| 430 |
- &$profile: the profile being shown |
| 431 |
|
| 432 |
StartProfilePageFullName: before showing the fullname on the profile page |
| 433 |
- $userprofile: UserProfile widget |
| 434 |
- &$profile: the profile being shown |
| 435 |
|
| 436 |
EndProfilePageFullName: after showing the fullname on the profile page |
| 437 |
- $userprofile: UserProfile widget |
| 438 |
- &$profile: the profile being shown |
| 439 |
|
| 440 |
StartProfilePageLocation: before showing the location on the profile page |
| 441 |
- $userprofile: UserProfile widget |
| 442 |
- &$profile: the profile being shown |
| 443 |
|
| 444 |
EndProfilePageLocation: after showing the location on the profile page |
| 445 |
- $userprofile: UserProfile widget |
| 446 |
- &$profile: the profile being shown |
| 447 |
|
| 448 |
StartProfilePageHomepage: before showing the homepage link on the profile page |
| 449 |
- $userprofile: UserProfile widget |
| 450 |
- &$profile: the profile being shown |
| 451 |
|
| 452 |
EndProfilePageHomepage: after showing the homepage on the profile page |
| 453 |
- $userprofile: UserProfile widget |
| 454 |
- &$profile: the profile being shown |
| 455 |
|
| 456 |
StartProfilePageBio: before showing the bio on the profile page |
| 457 |
- $userprofile: UserProfile widget |
| 458 |
- &$profile: the profile being shown |
| 459 |
|
| 460 |
EndProfilePageBio: after showing the bio on the profile page |
| 461 |
- $userprofile: UserProfile widget |
| 462 |
- &$profile: the profile being shown |
| 463 |
|
| 464 |
StartProfilePageProfileTags: before showing the tags on the profile page |
| 465 |
- $userprofile: UserProfile widget |
| 466 |
- &$profile: the profile being shown |
| 467 |
|
| 468 |
EndProfilePageProfileTags: after showing the tags on the profile page |
| 469 |
- $userprofile: UserProfile widget |
| 470 |
- &$profile: the profile being shown |
| 471 |
|
| 472 |
StartProfileList: when starting a list of profiles (before <ul>) |
| 473 |
- $profilelist: ProfileList widget, with $profile, $action, and $out |
| 474 |
|
| 475 |
EndProfileList: when ending a list of profiles (after </ul>) |
| 476 |
- $profilelist: ProfileList widget |
| 477 |
|
| 478 |
StartProfileListItem: when starting to show a profile list item |
| 479 |
- $item: ProfileListItem widget |
| 480 |
|
| 481 |
EndProfileListItem: after showing a profile list item |
| 482 |
- $item: ProfileListItem widget |
| 483 |
|
| 484 |
StartProfileListItemProfile: the profile data part of the item |
| 485 |
- $item: ProfileListItem widget |
| 486 |
|
| 487 |
EndProfileListItemProfile: the profile data part of the item |
| 488 |
- $item: ProfileListItem widget |
| 489 |
|
| 490 |
StartProfileListItemActions: the actions (buttons) for an item |
| 491 |
- $item: ProfileListItem widget |
| 492 |
|
| 493 |
EndProfileListItemActions: the actions (buttons) for an item |
| 494 |
- $item: ProfileListItem widget |
| 495 |
|
| 496 |
StartProfileListItemProfileElements: inside the <div> |
| 497 |
- $item: ProfileListItem widget |
| 498 |
|
| 499 |
EndProfileListItemProfileElements: inside the <div> |
| 500 |
- $item: ProfileListItem widget |
| 501 |
|
| 502 |
StartProfileListItemAvatar: Showing a profile list avatar |
| 503 |
- $item: ProfileListItem widget |
| 504 |
|
| 505 |
EndProfileListItemAvatar: Showing a profile list avatar |
| 506 |
- $item: ProfileListItem widget |
| 507 |
|
| 508 |
StartProfileListItemFullName: Showing the profile list full name |
| 509 |
- $item: ProfileListItem widget |
| 510 |
|
| 511 |
EndProfileListItemFullName: Showing the profile list full name |
| 512 |
- $item: ProfileListItem widget |
| 513 |
|
| 514 |
StartProfileListItemLocation: Showing the profile list location |
| 515 |
- $item: ProfileListItem widget |
| 516 |
|
| 517 |
EndProfileListItemLocation: Showing the profile list location |
| 518 |
- $item: ProfileListItem widget |
| 519 |
|
| 520 |
StartProfileListItemHomepage: Showing the profile list homepage |
| 521 |
- $item: ProfileListItem widget |
| 522 |
|
| 523 |
EndProfileListItemHomepage: Showing the profile list homepage |
| 524 |
- $item: ProfileListItem widget |
| 525 |
|
| 526 |
StartProfileListItemBio: Showing the profile list bio |
| 527 |
- $item: ProfileListItem widget |
| 528 |
|
| 529 |
EndProfileListItemBio: Showing the profile list bio |
| 530 |
- $item: ProfileListItem widget |
| 531 |
|
| 532 |
StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons) |
| 533 |
- $item: ProfileListItem widget |
| 534 |
|
| 535 |
EndProfileListItemActionElements: Showing profile list actions (append a button here) |
| 536 |
- $item: ProfileListItem widget |
| 537 |
|
| 538 |
StartUserXRDS: Start XRDS output (right after the opening XRDS tag) |
| 539 |
- $action: the current action |
| 540 |
- &$xrdsoutputter - XRDSOutputter object to write to |
| 541 |
|
| 542 |
EndUserXRDS: End XRDS output (right before the closing XRDS tag) |
| 543 |
- $action: the current action |
| 544 |
- &$xrdsoutputter - XRDSOutputter object to write to |
| 545 |
|
| 546 |
StartPublicXRDS: Start XRDS output (right after the opening XRDS tag) |
| 547 |
- $action: the current action |
| 548 |
- &$xrdsoutputter - XRDSOutputter object to write to |
| 549 |
|
| 550 |
EndPublicXRDS: End XRDS output (right before the closing XRDS tag) |
| 551 |
- $action: the current action |
| 552 |
- &$xrdsoutputter - XRDSOutputter object to write to |
| 553 |
|
| 554 |
StartCheckPassword: Check a username/password |
| 555 |
- $nickname: The nickname to check |
| 556 |
- $password: The password to check |
| 557 |
- &$authenticatedUser: set to User object if credentials match a user. |
| 558 |
|
| 559 |
EndCheckPassword: After checking a username/password pair |
| 560 |
- $nickname: The nickname that was checked |
| 561 |
- $password: The password that was checked |
| 562 |
- $authenticatedUser: User object if credentials match a user, else null. |
| 563 |
|
| 564 |
StartChangePassword: Before changing a password |
| 565 |
- $user: user |
| 566 |
- $oldpassword: the user's old password |
| 567 |
- $newpassword: the desired new password |
| 568 |
|
| 569 |
EndChangePassword: After changing a password |
| 570 |
- $user: user |
| 571 |
|
| 572 |
StartSetUser: Before setting the currently logged in user |
| 573 |
- $user: user |
| 574 |
|
| 575 |
EndSetUser: After setting the currently logged in user |
| 576 |
- $user: user |
| 577 |
|
| 578 |
StartSetApiUser: Before setting the current API user |
| 579 |
- $user: user |
| 580 |
|
| 581 |
EndSetApiUser: After setting the current API user |
| 582 |
- $user: user |
| 583 |
|
| 584 |
StartHasRole: Before determing if the a profile has a given role |
| 585 |
- $profile: profile in question |
| 586 |
- $name: name of the role in question |
| 587 |
- &$has_role: does this profile have the named role? |
| 588 |
|
| 589 |
EndHasRole: Before determing if the a profile has a given role |
| 590 |
- $profile: profile in question |
| 591 |
- $name: name of the role in question |
| 592 |
- $has_role: does this profile have the named role? |
| 593 |
|
| 594 |
UserDeleteRelated: Specify additional tables to delete entries from when deleting users |
| 595 |
- $user: User object |
| 596 |
- &$related: array of DB_DataObject class names to delete entries on matching user_id. |
| 597 |
|
| 598 |
GetUrlShorteners: Specify URL shorteners that are available for use |
| 599 |
- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean) |
| 600 |
|
| 601 |
StartShortenUrl: About to shorten a URL |
| 602 |
- $url: url to be shortened |
| 603 |
- $shortenerName: name of the requested shortener |
| 604 |
- &$shortenedUrl: short version of the url |
| 605 |
|
| 606 |
EndShortenUrl: After a URL has been shortened |
| 607 |
- $url: url to be shortened |
| 608 |
- $shortenerName: name of the requested shortener |
| 609 |
- $shortenedUrl: short version of the url |
| 610 |
|
| 611 |
StartCssLinkElement: Before a <link rel="stylesheet"..> element is written |
| 612 |
- $action |
| 613 |
- &$src |
| 614 |
- &$theme |
| 615 |
- &$media |
| 616 |
|
| 617 |
EndCssLinkElement: After a <link rel="stylesheet"..> element is written |
| 618 |
- $action |
| 619 |
- $src |
| 620 |
- $theme |
| 621 |
- $media |
| 622 |
|
| 623 |
StartStyleElement: Before a <style...> element is written |
| 624 |
- $action |
| 625 |
- &$code |
| 626 |
- &$type |
| 627 |
- &$media |
| 628 |
|
| 629 |
EndStyleElement: After a <style...> element is written |
| 630 |
- $action |
| 631 |
- $code |
| 632 |
- $type |
| 633 |
- $media |
| 634 |
|
| 635 |
StartScriptElement: Before a <script...> element is written |
| 636 |
- $action |
| 637 |
- &$src |
| 638 |
- &$type |
| 639 |
|
| 640 |
EndScriptElement: After a <script...> element is written |
| 641 |
- $action |
| 642 |
- $src |
| 643 |
- $type |
| 644 |
|
| 645 |
StartInlineScriptElement: Before a <script...> element is written |
| 646 |
- $action |
| 647 |
- &$code |
| 648 |
- &$type |
| 649 |
|
| 650 |
EndInlineScriptElement: After a <script...> element is written |
| 651 |
- $action |
| 652 |
- $code |
| 653 |
- $type |
| 654 |
|
| 655 |
StartLog: Before writing to the logs |
| 656 |
- &$priority |
| 657 |
- &$msg |
| 658 |
- &$filename |
| 659 |
|
| 660 |
EndLog: After writing to the logs |
| 661 |
- $priority |
| 662 |
- $msg |
| 663 |
- $filename |
| 664 |
|
| 665 |
StartBlockProfile: when we're about to block |
| 666 |
- $user: the person doing the block |
| 667 |
- $profile: the person getting blocked, can be remote |
| 668 |
|
| 669 |
EndBlockProfile: when a block has succeeded |
| 670 |
- $user: the person doing the block |
| 671 |
- $profile: the person blocked, can be remote |
| 672 |
|
| 673 |
StartUnblockProfile: when we're about to unblock |
| 674 |
- $user: the person doing the unblock |
| 675 |
- $profile: the person getting unblocked, can be remote |
| 676 |
|
| 677 |
EndUnblockProfile: when an unblock has succeeded |
| 678 |
- $user: the person doing the unblock |
| 679 |
- $profile: the person unblocked, can be remote |
| 680 |
|
| 681 |
StartSubscribe: when a subscription is starting |
| 682 |
- $user: the person subscribing |
| 683 |
- $other: the person being subscribed to |
| 684 |
|
| 685 |
EndSubscribe: when a subscription is finished |
| 686 |
- $user: the person subscribing |
| 687 |
- $other: the person being subscribed to |
| 688 |
|
| 689 |
StartUnsubscribe: when an unsubscribe is starting |
| 690 |
- $user: the person unsubscribing |
| 691 |
- $other: the person being unsubscribed from |
| 692 |
|
| 693 |
EndUnsubscribe: when an unsubscribe is done |
| 694 |
- $user: the person unsubscribing |
| 695 |
- $other: the person being unsubscribed to |
| 696 |
|
| 697 |
StartJoinGroup: when a user is joining a group |
| 698 |
- $group: the group being joined |
| 699 |
- $user: the user joining |
| 700 |
|
| 701 |
EndJoinGroup: when a user finishes joining a group |
| 702 |
- $group: the group being joined |
| 703 |
- $user: the user joining |
| 704 |
|
| 705 |
StartLeaveGroup: when a user is leaving a group |
| 706 |
- $group: the group being left |
| 707 |
- $user: the user leaving |
| 708 |
|
| 709 |
EndLeaveGroup: when a user has left a group |
| 710 |
- $group: the group being left |
| 711 |
- $user: the user leaving |
| 712 |
|
| 713 |
StartShowContentLicense: Showing the default license for content |
| 714 |
- $action: the current action |
| 715 |
|
| 716 |
EndShowContentLicense: Showing the default license for content |
| 717 |
- $action: the current action |
| 718 |
|
| 719 |
StartUserRegister: When a new user is being registered |
| 720 |
- &$profile: new profile data (no ID) |
| 721 |
- &$user: new user account (no ID or URI) |
| 722 |
|
| 723 |
EndUserRegister: When a new user has been registered |
| 724 |
- &$profile: new profile data |
| 725 |
- &$user: new user account |
| 726 |
|
| 727 |
StartRobotsTxt: Before outputting the robots.txt page |
| 728 |
- &$action: RobotstxtAction being shown |
| 729 |
|
| 730 |
EndRobotsTxt: After the default robots.txt page (good place for customization) |
| 731 |
- &$action: RobotstxtAction being shown |
| 732 |
|
| 733 |
StartGetProfileUri: When determining the canonical URI for a given profile |
| 734 |
- $profile: the current profile |
| 735 |
- &$uri: the URI |
| 736 |
|
| 737 |
EndGetProfileUri: After determining the canonical URI for a given profile |
| 738 |
- $profile: the current profile |
| 739 |
- &$uri: the URI |
| 740 |
|
| 741 |
StartFavorNotice: Saving a notice as a favorite |
| 742 |
- $profile: profile of the person faving (can be remote!) |
| 743 |
- $notice: notice being faved |
| 744 |
- &$fave: Favor object; null to start off with, but feel free to override. |
| 745 |
|
| 746 |
EndFavorNotice: After saving a notice as a favorite |
| 747 |
- $profile: profile of the person faving (can be remote!) |
| 748 |
- $notice: notice being faved |
| 749 |
|
| 750 |
StartDisfavorNotice: Saving a notice as a favorite |
| 751 |
- $profile: profile of the person faving (can be remote!) |
| 752 |
- $notice: notice being faved |
| 753 |
- &$result: result of the disfavoring (if you override) |
| 754 |
|
| 755 |
EndDisfavorNotice: After saving a notice as a favorite |
| 756 |
- $profile: profile of the person faving (can be remote!) |
| 757 |
- $notice: notice being faved |
| 758 |
|
| 759 |
StartFindMentions: start finding mentions in a block of text |
| 760 |
- $sender: sender profile |
| 761 |
- $text: plain text version of the notice |
| 762 |
- &$mentions: mentions found so far. Array of arrays; each array |
| 763 |
has 'mentioned' (array of mentioned profiles), 'url' (url to link as), |
| 764 |
'title' (title of the link), 'position' (position of the text to |
| 765 |
replace), 'text' (text to replace) |
| 766 |
|
| 767 |
EndFindMentions: end finding mentions in a block of text |
| 768 |
- $sender: sender profile |
| 769 |
- $text: plain text version of the notice |
| 770 |
- &$mentions: mentions found so far. Array of arrays; each array |
| 771 |
has 'mentioned' (array of mentioned profiles), 'url' (url to link as), |
| 772 |
'title' (title of the link), 'position' (position of the text to |
| 773 |
replace), 'text' (text to replace) |
| 774 |
|
| 775 |
StartShowSubscriptionsContent: before showing the subscriptions content |
| 776 |
- $action: the current action |
| 777 |
|
| 778 |
EndShowSubscriptionsContent: after showing the subscriptions content |
| 779 |
- $action: the current action |
| 780 |
|
| 781 |
StartShowUserGroupsContent: before showing the user groups content |
| 782 |
- $action: the current action |
| 783 |
|
| 784 |
EndShowUserGroupsContent: after showing the user groups content |
| 785 |
- $action: the current action |
| 786 |
|
| 787 |
StartShowAllContent: before showing the all (you and friends) content |
| 788 |
- $action: the current action |
| 789 |
|
| 790 |
EndShowAllContent: after showing the all (you and friends) content |
| 791 |
- $action: the current action |
| 792 |
|
| 793 |
StartShowSubscriptionsMiniList: at the start of subscriptions mini list |
| 794 |
- $action: the current action |
| 795 |
|
| 796 |
EndShowSubscriptionsMiniList: at the end of subscriptions mini list |
| 797 |
- $action: the current action |
| 798 |
|
| 799 |
StartShowGroupsMiniList: at the start of groups mini list |
| 800 |
- $action: the current action |
| 801 |
|
| 802 |
EndShowGroupsMiniList: at the end of groups mini list |
| 803 |
- $action: the current action |
| 804 |
|
| 805 |
StartDeleteUserForm: starting the data in the form for deleting a user |
| 806 |
- $action: action being shown |
| 807 |
- $user: user being deleted |
| 808 |
|
| 809 |
EndDeleteUserForm: Ending the data in the form for deleting a user |
| 810 |
- $action: action being shown |
| 811 |
- $user: user being deleted |
| 812 |
|
| 813 |
StartDeleteUser: handling the post for deleting a user |
| 814 |
- $action: action being shown |
| 815 |
- $user: user being deleted |
| 816 |
|
| 817 |
EndDeleteUser: handling the post for deleting a user |
| 818 |
- $action: action being shown |
| 819 |
- $user: user being deleted |