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
StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
166
- $widget: AccountSettingsNav instance being shown
167
168
EndAccountSettingsProfileMenuItem: After showing the Profile menu item
169
- $widget: AccountSettingsNav instance being shown
170
171
StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
172
- $widget: AccountSettingsNav instance being shown
173
174
EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
175
- $widget: AccountSettingsNav instance being shown
176
177
StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
178
- $widget: AccountSettingsNav instance being shown
179
180
EndAccountSettingsPasswordMenuItem: After showing the Password menu item
181
- $widget: AccountSettingsNav instance being shown
182
183
StartAccountSettingsEmailMenuItem: Before showing the Email menu item
184
- $widget: AccountSettingsNav instance being shown
185
186
EndAccountSettingsEmailMenuItem: After showing the Email menu item
187
- $widget: AccountSettingsNav instance being shown
188
189
StartAccountSettingsDesignMenuItem: Before showing the Design menu item
190
- $widget: AccountSettingsNav instance being shown
191
192
EndAccountSettingsDesignMenuItem: After showing the Design menu item
193
- $widget: AccountSettingsNav instance being shown
194
195
StartAccountSettingsOtherMenuItem: Before showing the Other menu item
196
- $widget: AccountSettingsNav instance being shown
197
198
EndAccountSettingsOtherMenuItem: After showing the Other menu item
199
- $widget: AccountSettingsNav instance being shown
200
201
Autoload: When trying to autoload a class
202
- $cls: the class being sought. A plugin might require_once the file for the class.
203
204
SensitiveAction: determines if an action is 'sensitive' and should use SSL
205
- $action: name of the action, like 'login'
206
- $sensitive: flag for whether this is a sensitive action
207
208
LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
209
- $action: name of the action, like 'register'
210
- $login: flag for whether this is a login action
211
212
StartShowHead: called before showing the <head> element and children
213
- $action: action object being show
214
215
EndShowHead: called after showing the <head> element (and </head>)
216
- $action: action object being shown
217
218
StartShowBody: called before showing the <body> element and children
219
- $action: action object being shown
220
221
EndShowBody: called after showing the <body> element (and </body>)
222
- $action: action object being shown
223
224
StartPersonalGroupNav: beginning of personal group nav menu
225
- $action: action object being shown
226
227
EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
228
- $action: action object being shown
229
230
StartGroupGroupNav: Showing the group nav menu
231
- $action: the current action
232
233
EndGroupGroupNav: At the end of the group nav menu
234
- $action: the current action
235
236
StartEndHTML: just before the </html> tag
237
- $action: action object being shown
238
239
EndEndHTML: just after the </html> tag
240
- $action: action object being shown
241
242
StartShowDesign: just before showing a site, user, or group design
243
- $action: action object being shown
244
245
EndShowDesign: just after showing a site, user, or group design
246
- $action: action object being shown
247
248
StartShowExportData: just before showing the <div> with export data (feeds)
249
- $action: action object being shown
250
251
EndShowExportData: just after showing the <div> with export data (feeds)
252
- $action: action object being shown
253
254
StartShowNoticeItem: just before showing the notice item
255
- $action: action object being shown
256
257
EndShowNoticeItem: just after showing the notice item
258
- $action: action object being shown
259
260
StartShowPageNotice: just before showing the page notice (instructions or error)
261
- $action: action object being shown
262
263
EndShowPageNotice: just after showing the page notice (instructions or error)
264
- $action: action object being shown
265
266
StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
267
- $action: action object being shown
268
269
StartProfileFormData: just before showing text entry fields on profile settings page
270
- $action: action object being shown
271
272
EndProfileFormData: just after showing text entry fields on profile settings page
273
- $action: action object being shown
274
275
StartProfileSaveForm: before starting to save a profile settings form
276
- $action: action object being shown
277
278
EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
279
- $action: action object being shown
280
281
StartRegistrationFormData: just before showing text entry fields on registration page
282
- $action: action object being shown
283
284
EndRegistrationFormData: just after showing text entry fields on registration page
285
- $action: action object being shown
286
287
StartRegistrationTry: before validating and saving a new user
288
- $action: action object being shown
289
290
EndRegistrationTry: after saving a new user (note: no profile or user object!)
291
- $action: action object being shown
292
293
StartAvatarFormData: before displaying avatar form
294
- $action: action object being shown
295
296
EndAvatarFormData: after displaying avatar form
297
- $action: action object being shown
298
299
StartAvatarSaveForm: before saving the avatar
300
- $action: action object being shown
301
302
EndAvatarSaveForm: after saving the avatar
303
- $action: action object being shown
304
305
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
306
- $qm: empty queue manager to set
307
308
RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
309
- $action: action object being shown
310
- $user: current user
311
312
StartLoadDoc: before loading a help doc (hook this to show your own documentation)
313
- $title: title of the document
314
- $output: HTML output to show
315
316
EndLoadDoc: after loading a help doc (hook this to modify other documentation)
317
- $title: title of the document
318
- $output: HTML output to show
319
320
StartApiRss: after the rss <channel> element is started
321
- $action: action object being shown
322
323
StartApiAtom: after the <feed> element is started
324
- $action: action object being shown
325
326
StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
327
- $notice: the notice being added
328
- &$transports: modifiable list of transports (as strings) to queue for
329
330
EndEnqueueNotice: after adding a notice to the queues
331
- $notice: the notice being added
332
- $transports: modifiable list of transports to use
333
334
UnqueueHandleNotice: Handle a notice when no queue manager is available
335
- $notice: the notice to handle
336
- $queue: the "queue" that is being executed
337
338
GetValidDaemons: Just before determining which daemons to run
339
- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
340
341
HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
342
- &$notice: notice to handle
343
344
StartShowHeadElements: Right after the <head> tag
345
- $action: the current action
346
347
EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
348
- $action: the current action
349
350
CheckSchema: chance to check the schema
351
352
StartProfilePageProfileSection: Starting to show the section of the
353
                              profile page with the actual profile data;
354
                              hook to prevent showing the profile (e.g.)
355
- $userprofile: UserProfile widget
356
- &$profile: the profile being shown
357
358
StartProfilePageProfileElements: inside the section, before the first
359
                               element; prepend elements here
360
- $userprofile: UserProfile widget
361
- &$profile: the profile being shown
362
363
EndProfilePageProfileElements: inside the section, after the last element;
364
                             append elements here
365
- $userprofile: UserProfile widget
366
- &$profile: the profile being shown
367
368
EndProfilePageProfileSection: After showing the section of the profile
369
                            page with the profile elements
370
- $userprofile: UserProfile widget
371
- &$profile: the profile being shown
372
373
StartProfilePageActionsSection: Starting to show the section of the
374
                                    profile page with action links; hook
375
                                    to hide them (for example)
376
- $userprofile: UserProfile widget
377
- &$profile: the profile being shown
378
379
StartProfilePageActionsElements: inside the list, before the first
380
                                     element; prepend elements here
381
- $userprofile: UserProfile widget
382
- &$profile: the profile being shown
383
384
EndProfilePageActionsElements: inside the list, after the last element;
385
                                   append elements here
386
- $userprofile: UserProfile widget
387
- &$profile: the profile being shown
388
389
EndProfilePageActionsSection: After showing the section of the profile
390
                                  page with the entity actions
391
- $userprofile: UserProfile widget
392
- &$profile: the profile being shown
393
394
StartProfilePageAvatar: before showing the avatar on the profile page
395
- $userprofile: UserProfile widget
396
- &$profile: the profile being shown
397
398
EndProfilePageAvatar: after showing the avatar on the profile page
399
- $userprofile: UserProfile widget
400
- &$profile: the profile being shown
401
402
StartProfilePageNickname: before showing the nickname on the profile page
403
- $userprofile: UserProfile widget
404
- &$profile: the profile being shown
405
406
EndProfilePageNickname: after showing the nickname on the profile page
407
- $userprofile: UserProfile widget
408
- &$profile: the profile being shown
409
410
StartProfilePageFullName: before showing the fullname on the profile page
411
- $userprofile: UserProfile widget
412
- &$profile: the profile being shown
413
414
EndProfilePageFullName: after showing the fullname on the profile page
415
- $userprofile: UserProfile widget
416
- &$profile: the profile being shown
417
418
StartProfilePageLocation: before showing the location on the profile page
419
- $userprofile: UserProfile widget
420
- &$profile: the profile being shown
421
422
EndProfilePageLocation: after showing the location on the profile page
423
- $userprofile: UserProfile widget
424
- &$profile: the profile being shown
425
426
StartProfilePageHomepage: before showing the homepage link on the profile page
427
- $userprofile: UserProfile widget
428
- &$profile: the profile being shown
429
430
EndProfilePageHomepage: after showing the homepage on the profile page
431
- $userprofile: UserProfile widget
432
- &$profile: the profile being shown
433
434
StartProfilePageBio: before showing the bio on the profile page
435
- $userprofile: UserProfile widget
436
- &$profile: the profile being shown
437
438
EndProfilePageBio: after showing the bio on the profile page
439
- $userprofile: UserProfile widget
440
- &$profile: the profile being shown
441
442
StartProfilePageProfileTags: before showing the tags on the profile page
443
- $userprofile: UserProfile widget
444
- &$profile: the profile being shown
445
446
EndProfilePageProfileTags: after showing the tags on the profile page
447
- $userprofile: UserProfile widget
448
- &$profile: the profile being shown
449
450
StartProfileList: when starting a list of profiles (before <ul>)
451
- $profilelist: ProfileList widget, with $profile, $action, and $out
452
453
EndProfileList: when ending a list of profiles (after </ul>)
454
- $profilelist: ProfileList widget
455
456
StartProfileListItem: when starting to show a profile list item
457
- $item: ProfileListItem widget
458
459
EndProfileListItem: after showing a profile list item
460
- $item: ProfileListItem widget
461
462
StartProfileListItemProfile: the profile data part of the item
463
- $item: ProfileListItem widget
464
465
EndProfileListItemProfile: the profile data part of the item
466
- $item: ProfileListItem widget
467
468
StartProfileListItemActions: the actions (buttons) for an item
469
- $item: ProfileListItem widget
470
471
EndProfileListItemActions: the actions (buttons) for an item
472
- $item: ProfileListItem widget
473
474
StartProfileListItemProfileElements: inside the <div>
475
- $item: ProfileListItem widget
476
477
EndProfileListItemProfileElements: inside the <div>
478
- $item: ProfileListItem widget
479
480
StartProfileListItemAvatar: Showing a profile list avatar
481
- $item: ProfileListItem widget
482
483
EndProfileListItemAvatar: Showing a profile list avatar
484
- $item: ProfileListItem widget
485
486
StartProfileListItemFullName: Showing the profile list full name
487
- $item: ProfileListItem widget
488
489
EndProfileListItemFullName: Showing the profile list full name
490
- $item: ProfileListItem widget
491
492
StartProfileListItemLocation: Showing the profile list location
493
- $item: ProfileListItem widget
494
495
EndProfileListItemLocation: Showing the profile list location
496
- $item: ProfileListItem widget
497
498
StartProfileListItemHomepage: Showing the profile list homepage
499
- $item: ProfileListItem widget
500
501
EndProfileListItemHomepage: Showing the profile list homepage
502
- $item: ProfileListItem widget
503
504
StartProfileListItemBio: Showing the profile list bio
505
- $item: ProfileListItem widget
506
507
EndProfileListItemBio: Showing the profile list bio
508
- $item: ProfileListItem widget
509
510
StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
511
- $item: ProfileListItem widget
512
513
EndProfileListItemActionElements: Showing profile list actions (append a button here)
514
- $item: ProfileListItem widget
515
516
StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
517
- $action: the current action
518
- &$xrdsoutputter - XRDSOutputter object to write to
519
520
EndUserXRDS: End XRDS output (right before the closing XRDS tag)
521
- $action: the current action
522
- &$xrdsoutputter - XRDSOutputter object to write to
523
524
StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
525
- $action: the current action
526
- &$xrdsoutputter - XRDSOutputter object to write to
527
528
EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
529
- $action: the current action
530
- &$xrdsoutputter - XRDSOutputter object to write to
531
532
StartCheckPassword: Check a username/password
533
- $nickname: The nickname to check
534
- $password: The password to check
535
- &$authenticatedUser: set to User object if credentials match a user.
536
537
EndCheckPassword: After checking a username/password pair
538
- $nickname: The nickname that was checked
539
- $password: The password that was checked
540
- $authenticatedUser: User object if credentials match a user, else null.
541
542
StartChangePassword: Before changing a password
543
- $user: user
544
- $oldpassword: the user's old password
545
- $newpassword: the desired new password
546
547
EndChangePassword: After changing a password
548
- $user: user
549
550
StartSetUser: Before setting the currently logged in user
551
- $user: user
552
553
EndSetUser: After setting the currently logged in user
554
- $user: user
555
556
StartSetApiUser: Before setting the current API user
557
- $user: user
558
559
EndSetApiUser: After setting the current API user
560
- $user: user
561
562
StartHasRole: Before determing if the a profile has a given role
563
- $profile: profile in question
564
- $name: name of the role in question
565
- &$has_role: does this profile have the named role?
566
567
EndHasRole: Before determing if the a profile has a given role
568
- $profile: profile in question
569
- $name: name of the role in question
570
- $has_role: does this profile have the named role?
571
572
UserDeleteRelated: Specify additional tables to delete entries from when deleting users
573
- $user: User object
574
- &$related: array of DB_DataObject class names to delete entries on matching user_id.
575
576
GetUrlShorteners: Specify URL shorteners that are available for use
577
- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
578
579
StartShortenUrl: About to shorten a URL
580
- $url: url to be shortened
581
- $shortenerName: name of the requested shortener
582
- &$shortenedUrl: short version of the url
583
584
EndShortenUrl: After a URL has been shortened
585
- $url: url to be shortened
586
- $shortenerName: name of the requested shortener
587
- $shortenedUrl: short version of the url
588
589
StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
590
- $action
591
- &$src
592
- &$theme
593
- &$media
594
595
EndCssLinkElement: After a <link rel="stylesheet"..> element is written
596
- $action
597
- $src
598
- $theme
599
- $media
600
601
StartStyleElement: Before a <style...> element is written
602
- $action
603
- &$code
604
- &$type
605
- &$media
606
607
EndStyleElement: After a <style...> element is written
608
- $action
609
- $code
610
- $type
611
- $media
612
613
StartScriptElement: Before a <script...> element is written
614
- $action
615
- &$src
616
- &$type
617
618
EndScriptElement: After a <script...> element is written
619
- $action
620
- $src
621
- $type
622
623
StartInlineScriptElement: Before a <script...> element is written
624
- $action
625
- &$code
626
- &$type
627
628
EndInlineScriptElement: After a <script...> element is written
629
- $action
630
- $code
631
- $type
632
633
StartLog: Before writing to the logs
634
- &$priority
635
- &$msg
636
- &$filename
637
638
EndLog: After writing to the logs
639
- $priority
640
- $msg
641
- $filename
642
643
StartBlockProfile: when we're about to block
644
- $user: the person doing the block
645
- $profile: the person getting blocked, can be remote
646
647
EndBlockProfile: when a block has succeeded
648
- $user: the person doing the block
649
- $profile: the person blocked, can be remote
650
651
StartUnblockProfile: when we're about to unblock
652
- $user: the person doing the unblock
653
- $profile: the person getting unblocked, can be remote
654
655
EndUnblockProfile: when an unblock has succeeded
656
- $user: the person doing the unblock
657
- $profile: the person unblocked, can be remote