ab7ccdc8997c53346b655d481f83975312bcbf50
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
3 This document describes how event hooks work in MediaWiki; how to add
4 hooks for an event; and how to run hooks for an event.
5
6 ==Glossary==
7
8 event
9 Something that happens with the wiki. For example: a user logs
10 in. A wiki page is saved. A wiki page is deleted. Often there are
11 two events associated with a single action: one before the code
12 is run to make the event happen, and one after. Each event has a
13 name, preferably in CamelCase. For example, 'UserLogin',
14 'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'.
15
16 hook
17 A clump of code and data that should be run when an event
18 happens. This can be either a function and a chunk of data, or an
19 object and a method.
20
21 hook function
22 The function part of a hook.
23
24 ==Rationale==
25
26 Hooks allow us to decouple optionally-run code from code that is run
27 for everyone. It allows MediaWiki hackers, third-party developers and
28 local administrators to define code that will be run at certain points
29 in the mainline code, and to modify the data run by that mainline
30 code. Hooks can keep mainline code simple, and make it easier to
31 write extensions. Hooks are a principled alternative to local patches.
32
33 Consider, for example, two options in MediaWiki. One reverses the
34 order of a title before displaying the article; the other converts the
35 title to all uppercase letters. Currently, in MediaWiki code, we
36 would handle this as follows (note: not real code, here):
37
38 function showAnArticle($article) {
39 global $wgReverseTitle, $wgCapitalizeTitle;
40
41 if ($wgReverseTitle) {
42 wfReverseTitle($article);
43 }
44
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
47 }
48
49 # code to actually show the article goes here
50 }
51
52 An extension writer, or a local admin, will often add custom code to
53 the function -- with or without a global variable. For example,
54 someone wanting email notification when an article is shown may add:
55
56 function showAnArticle($article) {
57 global $wgReverseTitle, $wgCapitalizeTitle;
58
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
61 }
62
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
65 }
66
67 # code to actually show the article goes here
68
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
71 }
72 }
73
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
76 becomes:
77
78 function showAnArticle($article) {
79
80 if (wfRunHooks('ArticleShow', array(&$article))) {
81
82 # code to actually show the article goes here
83
84 wfRunHooks('ArticleShowComplete', array(&$article));
85 }
86 }
87
88 We've cleaned up the code here by removing clumps of weird,
89 infrequently used code and moving them off somewhere else. It's much
90 easier for someone working with this code to see what's _really_ going
91 on, and make changes or fix bugs.
92
93 In addition, we can take all the code that deals with the little-used
94 title-reversing options (say) and put it in one place. Instead of
95 having little title-reversing if-blocks spread all over the codebase
96 in showAnArticle, deleteAnArticle, exportArticle, etc., we can
97 concentrate it all in an extension file:
98
99 function reverseArticleTitle($article) {
100 # ...
101 }
102
103 function reverseForExport($article) {
104 # ...
105 }
106
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
109
110 setupTitleReversingExtension() {
111 global $wgHooks;
112
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
116 }
117
118 Having all this code related to the title-reversion option in one
119 place means that it's easier to read and understand; you don't have to
120 do a grep-find to see where the $wgReverseTitle variable is used, say.
121
122 If the code is well enough isolated, it can even be excluded when not
123 used -- making for some slight savings in memory and load-up
124 performance at runtime. Admins who want to have all the reversed
125 titles can add:
126
127 require_once('extensions/ReverseTitle.php');
128
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
131
132 The extensions don't even have to be shipped with MediaWiki; they
133 could be provided by a third-party developer or written by the admin
134 him/herself.
135
136 ==Writing hooks==
137
138 A hook is a chunk of code run at some particular event. It consists of:
139
140 * a function with some optional accompanying data, or
141 * an object with a method and some optional accompanying data.
142
143 Hooks are registered by adding them to the global $wgHooks array for a
144 given event. All the following are valid ways to define hooks:
145
146 $wgHooks['EventName'][] = 'someFunction'; # function, no data
147 $wgHooks['EventName'][] = array('someFunction', $someData);
148 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
149
150 $wgHooks['EventName'][] = $object; # object only
151 $wgHooks['EventName'][] = array($object, 'someMethod');
152 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
153 $wgHooks['EventName'][] = array($object); # weird but OK
154
155 When an event occurs, the function (or object method) will be called
156 with the optional data provided as well as event-specific parameters.
157 The above examples would result in the following code being executed
158 when 'EventName' happened:
159
160 # function, no data
161 someFunction($param1, $param2)
162 # function with data
163 someFunction($someData, $param1, $param2)
164
165 # object only
166 $object->onEventName($param1, $param2)
167 # object with method
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
171
172 Note that when an object is the hook, and there's no specified method,
173 the default method called is 'onEventName'. For different events this
174 would be different: 'onArticleSave', 'onUserLogin', etc.
175
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
178
179 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
181
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
184
185 Hooks can return three possible values:
186
187 * true: the hook has operated successfully
188 * "some string": an error occurred; processing should
189 stop and the error should be shown to the user
190 * false: the hook has successfully done the work
191 necessary and the calling function should skip
192
193 The last result would be for cases where the hook function replaces
194 the main functionality. For example, if you wanted to authenticate
195 users to a custom system (LDAP, another PHP program, whatever), you
196 could do:
197
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
199
200 function ldapLogin($username, $password) {
201 # log user into LDAP
202 return false;
203 }
204
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
207
208 ==Using hooks==
209
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
212
213 class Article {
214 # ...
215 function protect() {
216 global $wgUser;
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
220 }
221 }
222 }
223
224 wfRunHooks() returns true if the calling function should continue
225 processing (the hooks ran OK, or there are no hooks to run), or false
226 if it shouldn't (an error occurred, or one of the hooks handled the
227 action already). Checking the return value matters more for "before"
228 hooks than for "complete" hooks.
229
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can
232 be changed) into the hook code. Also note that earlier versions of
233 wfRunHooks took a variable number of arguments; the array() calling
234 protocol came about after MediaWiki 1.4rc1.
235
236 ==Events and parameters==
237
238 This is a list of known events and parameters; please add to it if
239 you're going to add events to the MediaWiki code.
240
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
244
245 'AbortLogin': Return false to cancel account login.
246 $user: the User object being authenticated against
247 $password: the password being submitted, not yet checked for validity
248 &$retval: a LoginForm class constant to return from authenticateUserData();
249 default is LoginForm::ABORTED. Note that the client may be using
250 a machine API rather than the HTML user interface.
251
252 'AbortMove': allows to abort moving an article (title)
253 $old: old title
254 $nt: new title
255 $user: user who is doing the move
256 $err: error message
257 $reason: the reason for the move (added in 1.13)
258
259 'AbortNewAccount': Return false to cancel account creation.
260 $user: the User object about to be created (read-only, incomplete)
261 $message: out parameter: error message to display on abort
262
263 'AddNewAccount': after a user account is created
264 $user: the User object that was created. (Parameter added in 1.7)
265 $byEmail: true when account was created "by email" (added in 1.12)
266
267 'AjaxAddScript': Called in output page just before the initialisation
268 of the javascript ajax engine. The hook is only called when ajax
269 is enabled ( $wgUseAjax = true; ).
270
271 'AlternateEdit': before checking if an user can edit a page and
272 before showing the edit form ( EditPage::edit() ). This is triggered
273 on &action=edit.
274 $EditPage : the EditPage object
275
276 'APIEditBeforeSave': before saving a page with api.php?action=edit,
277 after processing request parameters. Return false to let the request
278 fail, returning an error message or an <edit result="Failure"> tag
279 if $resultArr was filled.
280 $EditPage : the EditPage object
281 $text : the new text of the article (has yet to be saved)
282 $resultArr : data in this array will be added to the API result
283
284 'ArticleAfterFetchContent': after fetching content of an article from the database
285 $article: the article (object) being loaded from the database
286 $content: the content (string) of the article
287
288 'ArticleDelete': before an article is deleted
289 $article: the article (object) being deleted
290 $user: the user (object) deleting the article
291 $reason: the reason (string) the article is being deleted
292 $error: if the deletion was prohibited, the (raw HTML) error message to display
293 (added in 1.13)
294
295 'ArticleDeleteComplete': after an article is deleted
296 $article: the article that was deleted
297 $user: the user that deleted the article
298 $reason: the reason the article was deleted
299 $id: id of the article that was deleted
300
301 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
302 $article: article (object) of the user talk page
303
304 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
305 $article: article (object) being modified
306
307 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
308 $title: title (object) used to create the article object
309 $article: article (object) that will be returned
310
311 'ArticleInsertComplete': After a new article is created
312 $article: Article created
313 $user: User creating the article
314 $text: New content
315 $summary: Edit summary/comment
316 $isMinor: Whether or not the edit was marked as minor
317 $isWatch: (No longer used)
318 $section: (No longer used)
319 $flags: Flags passed to Article::doEdit()
320 $revision: New Revision of the article
321
322 'ArticleMergeComplete': after merging to article using Special:Mergehistory
323 $targetTitle: target title (object)
324 $destTitle: destination title (object)
325
326 'ArticlePageDataAfter': after loading data of an article from the database
327 $article: article (object) whose data were loaded
328 $row: row (object) returned from the database server
329
330 'ArticlePageDataBefore': before loading data of an article from the database
331 $article: article (object) that data will be loaded
332 $fields: fileds (array) to load from the database
333
334 'ArticleProtect': before an article is protected
335 $article: the article being protected
336 $user: the user doing the protection
337 $protect: boolean whether this is a protect or an unprotect
338 $reason: Reason for protect
339 $moveonly: boolean whether this is for move only or not
340
341 'ArticleProtectComplete': after an article is protected
342 $article: the article that was protected
343 $user: the user who did the protection
344 $protect: boolean whether it was a protect or an unprotect
345 $reason: Reason for protect
346 $moveonly: boolean whether it was for move only or not
347
348 'ArticlePurge': before executing "&action=purge"
349 $article: article (object) to purge
350
351 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
352 revision of an article
353 &$title: title object of the article
354
355 'ArticleRevisionUndeleted': after an article revision is restored
356 $title: the article title
357 $revision: the revision
358 $oldPageID: the page ID of the revision when archived (may be null)
359
360 'ArticleRollbackComplete': after an article rollback is completed
361 $article: the article that was edited
362 $user: the user who did the rollback
363 $revision: the revision the page was reverted back to
364
365 'ArticleSave': before an article is saved
366 $article: the article (object) being saved
367 $user: the user (object) saving the article
368 $text: the new article text
369 $summary: the article summary (comment)
370 $isminor: minor flag
371 $iswatch: watch flag
372 $section: section #
373
374 'ArticleSaveComplete': After an article has been updated
375 $article: Article modified
376 $user: User performing the modification
377 $text: New content
378 $summary: Edit summary/comment
379 $isMinor: Whether or not the edit was marked as minor
380 $isWatch: (No longer used)
381 $section: (No longer used)
382 $flags: Flags passed to Article::doEdit()
383 $revision: New Revision of the article
384
385 'ArticleSaveComplete': after an article is saved
386 $article: the article (object) saved
387 $user: the user (object) who saved the article
388 $text: the new article text
389 $summary: the article summary (comment)
390 $isminor: minor flag
391 $iswatch: watch flag
392 $section: section #
393
394 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
395
396 'ArticleUndelete': When one or more revisions of an article are restored
397 $title: Title corresponding to the article restored
398 $create: Whether or not the restoration caused the page to be created
399 (i.e. it didn't exist before)
400
401 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
402 &$article: the article
403 &$sectionanchor: The section anchor link (e.g. "#overview" )
404 &$extraq: Extra query parameters which can be added via hooked functions
405
406 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
407 &$article: the article
408 &$pcache: whether to try the parser cache or not
409 &$outputDone: whether the output for this page finished or not
410
411 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
412 $article: target article (object)
413
414 'AuthPluginAutoCreate': Called when creating a local account for an user logged
415 in from an external authentication method
416 $user: User object created locally
417
418 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
419 Gives a chance for an extension to set it programattically to a variable class.
420 &$auth: the $wgAuth object, probably a stub
421
422 'AutopromoteCondition': check autopromote condition for user.
423 $type: condition type
424 $args: arguments
425 $user: user
426 $result: result of checking autopromote condition
427
428 'BadImage': When checking against the bad image list
429 $name: Image name being checked
430 &$bad: Whether or not the image is "bad"
431
432 Change $bad and return false to override. If an image is "bad", it is not
433 rendered inline in wiki pages or galleries in category pages.
434
435 'BeforeGalleryFindFile': before an image is fetched for a gallery
436 &$gallery,: the gallery object
437 &$nt: the image title
438 &$time: image timestamp
439
440 'BeforePageDisplay': Prior to outputting a page
441 &$out: OutputPage object
442 &$skin: Skin object
443
444 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
445 &$parser: Parser object
446 &$title: title of the template
447 &$skip: skip this template and link it?
448 &$id: the id of the revision being parsed
449
450 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
451 &$parser: Parser object
452 &$nt: the image title
453 &$skip: skip this image and link it?
454 &$time: the image timestamp
455
456 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
457 &$parser: Parser object
458 &$ig: ImageGallery object
459
460 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
461 $nondefaults: Assoc array with the following keys:
462 days, hideOwn, hideBots, hideMinor, namespace
463 $wgUser: wgUser.
464 &$hookSql: a string which will be inserted without sanitation into the SQL query
465 used to get the watchlist, at the end of the WHERE part.
466
467 'BlockIp': before an IP address or user is blocked
468 $block: the Block object about to be saved
469 $user: the user _doing_ the block (not the one being blocked)
470
471 'BlockIpComplete': after an IP address or user is blocked
472 $block: the Block object that was saved
473 $user: the user who did the block (not the one being blocked)
474
475 'BookInformation': Before information output on Special:Booksources
476 $isbn: ISBN to show information for
477 $output: OutputPage object in use
478
479 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
480 &$linker: Linker instance
481 $nt: the page title
482 $query: the URL query string passed in
483 &$u: the URL of this link
484 &$style: the inline CSS style
485 &$prefix: a prefix prepended to the linked text
486 &$text: the text placed by the user in the wiki-link
487 &$inside: any additional alphanumeric characters placed after the wiki-link,
488 that are made part of the link text
489 &$trail: text placed immediately after the HTML link
490
491 'CategoryPageView': before viewing a categorypage in CategoryPage::view
492 $catpage: CategoryPage instance
493
494 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
495 &$this: ChangesList instance.
496 &$articlelink: HTML of link to article (already filled-in).
497 &$s: HTML of row that is being constructed.
498 &$rc: RecentChange instance.
499 $unpatrolled: Whether or not we are showing unpatrolled changes.
500 $watched: Whether or not the change is watched by the user.
501
502 'ContributionsToolLinks': Change tool links above Special:Contributions
503 $id: User identifier
504 $title: User page title
505 &$tools: Array of tool links
506
507 'CustomEditor': When invoking the page editor
508 $article: Article being edited
509 $user: User performing the edit
510
511 Return true to allow the normal editor to be used, or false
512 if implementing a custom editor, e.g. for a special namespace,
513 etc.
514
515 'DiffViewHeader': called before diff display
516 $diff: DifferenceEngine object that's calling
517 $oldRev: Revision object of the "old" revision (may be null/invalid)
518 $newRev: Revision object of the "new" revision
519
520 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
521 $article: article (object) being viewed
522 $oldid: oldid (int) being viewed
523
524 'EditFilter': Perform checks on an edit
525 $editor: Edit form (see includes/EditPage.php)
526 $text: Contents of the edit box
527 $section: Section being edited
528 &$error: Error message to return
529 $summary: Edit summary for page
530
531 'EditFilterMerged': Post-section-merge edit filter
532 $editor: EditPage instance (object)
533 $text: content of the edit box
534 $error: error message to return
535 $summary: Edit summary for page
536
537 'EditFormPreloadText': Allows population of the edit form when creating new pages
538 &$text: Text to preload with
539 &$title: Title object representing the page being created
540
541 'EditPage::attemptSave': called before an article is
542 saved, that is before insertNewArticle() is called
543 &$editpage_Obj: the current EditPage object
544
545 'EditPage::showEditForm:fields': allows injection of form field into edit form
546 &$editor: the EditPage instance for reference
547 &$out: an OutputPage instance to write to
548 return value is ignored (should always return true)
549
550 'EditPage::showEditForm:initial': before showing the edit form
551 $editor: EditPage instance (object)
552
553 Return false to halt editing; you'll need to handle error messages, etc. yourself.
554 Alternatively, modifying $error and returning true will cause the contents of $error
555 to be echoed at the top of the edit form as wikitext. Return true without altering
556 $error to allow the edit to proceed.
557
558 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
559 when there's an edit conflict. Return false to halt normal diff output; in
560 this case you're responsible for computing and outputting the entire "conflict"
561 part, i.e., the "difference between revisions" and "your text" headers and
562 sections.
563 &$editor: EditPage instance
564 &$out: OutputPage instance
565
566 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
567 &$editpage: The current EditPage object
568 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
569
570 'EditSectionLink': Override the return value of Linker::editSectionLink()
571 $skin: Skin rendering the UI
572 $title: Title being linked to
573 $section: Section to link to
574 $link: Default link
575 $result: Result (alter this to override the generated links)
576
577 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
578 $skin: Skin rendering the UI
579 $title: Title being linked to
580 $section: Section to link to
581 $hint: Anchor title/tooltip attributes
582 $link: Default link
583 $result: Result (alter this to override the generated links)
584
585 'EmailConfirmed': When checking that the user's email address is "confirmed"
586 $user: User being checked
587 $confirmed: Whether or not the email address is confirmed
588 This runs before the other checks, such as anonymity and the real check; return
589 true to allow those checks to occur, and false if checking is done.
590
591 'EmailUser': before sending email from one user to another
592 $to: address of receiving user
593 $from: address of sending user
594 $subject: subject of the mail
595 $text: text of the mail
596
597 'EmailUserComplete': after sending email from one user to another
598 $to: address of receiving user
599 $from: address of sending user
600 $subject: subject of the mail
601 $text: text of the mail
602
603 'FetchChangesList': When fetching the ChangesList derivative for a particular user
604 &$user: User the list is being fetched for
605 &$skin: Skin object to be used with the list
606 &$list: List object (defaults to NULL, change it to an object instance and return
607 false override the list derivative used)
608
609 'FileDeleteComplete': When a file is deleted
610 $file: reference to the deleted file
611 $oldimage: in case of the deletion of an old image, the name of the old file
612 $article: in case all revisions of the file are deleted a reference to the article
613 associated with the file.
614 $user: user who performed the deletion
615 $reason: reason
616
617 'FileUpload': When a file upload occurs
618 $file : Image object representing the file that was uploaded
619
620 'FileUndeleteComplete': When a file is undeleted
621 $title: title object to the file
622 $fileVersions: array of undeleted versions. Empty if all versions were restored
623 $user: user who performed the undeletion
624 $reason: reason
625
626 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
627 &$user: user to promote.
628 &$promote: groups that will be added.
629
630 'GetBlockedStatus': after loading blocking status of an user from the database
631 $user: user (object) being checked
632
633 'GetCacheVaryCookies': get cookies that should vary cache options
634 $out: OutputPage object
635 &$cookies: array of cookies name, add a value to it if you want to add a cookie
636 that have to vary cache options
637
638 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
639 $title: Title object of page
640 $url: string value as output (out parameter, can modify)
641 $query: query options passed to Title::getFullURL()
642
643 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
644 $title: Title object of page
645 $url: string value as output (out parameter, can modify)
646 $query: query options passed to Title::getInternalURL()
647
648 'GetLinkColours': modify the CSS class of an array of page links
649 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
650 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
651
652 'GetLocalURL': modify local URLs as output into page links
653 $title: Title object of page
654 $url: string value as output (out parameter, can modify)
655 $query: query options passed to Title::getLocalURL()
656
657 'getUserPermissionsErrors': Add a permissions error when permissions errors are
658 checked for. Use instead of userCan for most cases. Return false if the
659 user can't do it, and populate $result with the reason in the form of
660 array( messagename, param1, param2, ... ). For consistency, error messages
661 should be plain text with no special coloring, bolding, etc. to show that
662 they're errors; presenting them properly to the user as errors is done by
663 the caller.
664 $title: Title object being checked against
665 $user : Current user object
666 $action: Action being checked
667 $result: User permissions error to add. If none, return true.
668
669 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
670 if expensive checks are enabled.
671
672 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
673 image insertion. You can skip the default logic entirely by returning
674 false, or just modify a few things using call-by-reference.
675 &$this: Skin object
676 &$title: Title object of the image
677 &$file: File object, or false if it doesn't exist
678 &$frameParams: Various parameters with special meanings; see documentation in
679 includes/Linker.php for Linker::makeImageLink2
680 &$handlerParams: Various parameters with special meanings; see documentation in
681 includes/Linker.php for Linker::makeImageLink2
682 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
683 &$res: Final HTML output, used if you return false
684
685
686 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
687 the image on an image page
688 $imagePage: ImagePage object ($this)
689 $output: $wgOut
690
691 'ImagePageFileHistoryLine': called when a file history line is contructed
692 $file: the file
693 $line: the HTML of the history line
694 $css: the line CSS class
695
696 'ImagePageFindFile': called when fetching the file associated with an image page
697 $page: ImagePage object
698 &$file: File object
699 &$displayFile: displayed File object
700
701 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
702 $title: Title object ($wgTitle)
703 $request: WebRequest
704 $ignoreRedirect: boolean to skip redirect check
705 $target: Title/string of redirect target
706
707 'InitPreferencesForm': called at the end of PreferencesForm's constructor
708 $form: the PreferencesForm
709 $request: the web request to initialized from
710
711 'InternalParseBeforeLinks': during Parser's internalParse method before links but
712 after noinclude/includeonly/onlyinclude and other processing.
713 &$this: Parser object
714 &$text: string containing partially parsed text
715 &$this->mStripState: Parser's internal StripState object
716
717 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
718 $article: article (object) being checked
719
720 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
721 $ip: IP being check
722 $result: Change this value to override the result of wfIsTrustedProxy()
723
724 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
725 tance to return false if the domain name doesn't match your organization
726 $addr: The e-mail address entered by the user
727 &$result: Set this and return false to override the internal checks
728
729 'isValidPassword': Override the result of User::isValidPassword()
730 $password: The password entered by the user
731 &$result: Set this and return false to override the internal checks
732 $user: User the password is being validated for
733
734 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
735 $magicExtensions: associative array of magic words synonyms
736 $lang: laguage code (string)
737
738 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
739 $specialPageAliases: associative array of magic words synonyms
740 $lang: laguage code (string)
741
742 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
743 &$url: the image url
744 &$alt: the image's alt text
745 &$img: the new image HTML (if returning false)
746
747 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
748 &$url: the link url
749 &$text: the link text
750 &$link: the new link HTML (if returning false)
751
752 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
753 &$linksUpdate: the LinkUpdate object
754
755 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
756 &$linksUpdate: the LinkUpdate object
757
758 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
759 &$linksUpdate: the LinkUpdate object
760
761 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
762
763 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
764
765 'LocalFile::getHistory': called before file history query performed
766 $file: the file
767 $tables: tables
768 $fields: select fields
769 $conds: conditions
770 $opts: query options
771 $join_conds: JOIN conditions
772
773 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
774 No return data is accepted; this hook is for auditing only.
775 $user: the User object being authenticated against
776 $password: the password being submitted and found wanting
777 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
778
779 'LogLine': Processes a single log entry on Special:Log
780 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
781 database field.
782 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
783 to logging.log_action database field.
784 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
785 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
786 appears to contain anything.
787 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
788 &$revert: string that is displayed in the UI, similar to $comment.
789 $time: timestamp of the log entry (added in 1.12)
790
791 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
792 &$type: array of strings
793
794 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
795 &$typeText: array of strings
796
797 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
798 &$headerText: array of strings
799
800 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
801 &$actionText: array of strings
802
803 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
804 $magicWords: array of strings
805
806 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
807 $variableIDs: array of strings
808
809 'MarkPatrolled': before an edit is marked patrolled
810 $rcid: ID of the revision to be marked patrolled
811 $user: the user (object) marking the revision as patrolled
812 $wcOnlySysopsCanPatrol: config setting indicating whether the user
813 needs to be a sysop in order to mark an edit patrolled
814
815 'MarkPatrolledComplete': after an edit is marked patrolled
816 $rcid: ID of the revision marked as patrolled
817 $user: user (object) who marked the edit patrolled
818 $wcOnlySysopsCanPatrol: config setting indicating whether the user
819 must be a sysop to patrol the edit
820
821 'MathAfterTexvc': after texvc is executed when rendering mathematics
822 $mathRenderer: instance of MathRenderer
823 $errmsg: error message, in HTML (string). Nonempty indicates failure
824 of rendering the formula
825
826 'MediaWikiPerformAction': Override MediaWiki::performAction().
827 Use this to do something completely different, after the basic
828 globals have been set up, but before ordinary actions take place.
829 $output: $wgOut
830 $article: $wgArticle
831 $title: $wgTitle
832 $user: $wgUser
833 $request: $wgRequest
834 $this: The $mediawiki object
835
836 'MessagesPreLoad': When loading a message from the database
837 $title: title of the message (string)
838 $message: value (string), change it to the message you want to define
839
840 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
841 Note: this is only run for the Monobook skin. To add items to the toolbox
842 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
843 instead.
844 $tools: array of tools
845
846 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
847 $article: the article edited
848 $rev: the new revision
849 $baseID: the revision ID this was based off, if any
850
851 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
852 Hooks can alter or append to the array of URLs for search & suggestion formats.
853 &$urls: array of associative arrays with Url element attributes
854
855 'OutputPageBeforeHTML': a page has been processed by the parser and
856 the resulting HTML is about to be displayed.
857 $parserOutput: the parserOutput (object) that corresponds to the page
858 $text: the text that will be displayed, in HTML (string)
859
860 'OutputPageParserOutput': after adding a parserOutput to $wgOut
861 $out: OutputPage instance (object)
862 $parserOutput: parserOutput instance being added in $out
863
864 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
865 Implementations should return false if they generate the category links, so the default link generation is skipped.
866 $out: OutputPage instance (object)
867 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
868 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
869
870 'PageHistoryBeforeList': When a history page list is about to be constructed.
871 $article: the article that the history is loading for
872
873 'PageHistoryLineEnding' : right before the end <li> is added to a history line
874 $row: the revision row for this line
875 $s: the string representing this parsed line
876
877 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
878 $pager: the pager
879 $queryInfo: the query parameters
880
881 'PageRenderingHash': alter the parser cache option hash key
882 A parser extension which depends on user options should install
883 this hook and append its values to the key.
884 $hash: reference to a hash key string which can be modified
885
886 'ParserAfterStrip': Same as ParserBeforeStrip
887
888 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
889 $parser: Parser object being used
890 $text: text that'll be returned
891
892 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
893 $parser: Parser object
894 $text: text to parse
895 $stripState: StripState instance being used
896
897 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
898 $parser: parser object
899 $text: text being parsed
900 $stripState: stripState used (object)
901
902 'ParserBeforeTidy': called before tidy and custom tags replacements
903 $parser: Parser object being used
904 $text: actual text
905
906 'ParserClearState': called at the end of Parser::clearState()
907 $parser: Parser object being cleared
908
909 'ParserFirstCallInit': called when the parser initialises for the first time
910 &$parser: Parser object being cleared
911
912 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
913 $parser: Parser object
914 $varCache: array to store the value in case of multiples calls of the same magic word
915 $index: index (string) of the magic
916 $ret: value of the magic word (the hook should set it)
917
918 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
919 $parser: Parser object
920 $time: actual time (timestamp)
921
922 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
923 $parser: Parser object
924 $varCache: varaiable cache (array)
925
926 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
927 $parser: Parser object
928 $limitReport: text that will be included (without comment tags)
929
930 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
931 $title: title object representing the file
932 $file: file object that will be used to create the image
933 &$params: 2-D array of parameters
934
935 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
936 $parser: Parser object created
937
938 'ParserTestTables': alter the list of tables to duplicate when parser tests
939 are run. Use when page save hooks require the presence of custom tables
940 to ensure that tests continue to run properly.
941 &$tables: array of table names
942
943 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
944 my talk page, my contributions" etc).
945
946 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
947 &$title: Title object representing the current page
948
949 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
950 &$user : User performing the action
951 $action : Action being performed
952 &$result : Whether or not the action should be prevented
953 Change $result and return false to give a definitive answer, otherwise
954 the built-in rate limiting checks are used, if enabled.
955
956 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
957 $form : PreferencesForm object
958 &$html : HTML to append to
959
960 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
961 AJAX search suggestions. Put results into &$results outparam and return false.
962 $ns : array of int namespace keys to search in
963 $search : search term (not guaranteed to be conveniently normalized)
964 $limit : maximum number of results to return
965 &$results : out param: array of page names (strings)
966
967 'PrefsEmailAudit': called when user changes his email address
968 $user: User (object) changing his email address
969 $oldaddr: old email address (string)
970 $newaddr: new email address (string)
971
972 'PrefsPasswordAudit': called when user changes his password
973 $user: User (object) changing his passoword
974 $newPass: new password
975 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
976
977 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
978 &$obj: RawPage object
979 &$text: The text that's going to be the output
980
981 'RecentChange_save': called at the end of RecenChange::save()
982 $recentChange: RecentChange object
983
984 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
985 $form: the PreferencesForm
986 $out: output page to render to, probably $wgOut
987
988 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
989 $form: the PreferencesForm
990 $user: the User object to load preferences from
991
992 'RevisionInsertComplete': called after a revision is inserted into the DB
993 $revision: the Revision
994
995 'SavePreferences': called at the end of PreferencesForm::savePreferences;
996 returning false prevents the preferences from being saved.
997 $form: the PreferencesForm
998 $user: the User object to save preferences to
999 $message: change this to set an error message (ignored if the hook does not return false)
1000 $old: old preferences of the user
1001
1002 'SearchUpdate': Prior to search update completion
1003 $id : Page id
1004 $namespace : Page namespace
1005 $title : Page title
1006 $text : Current text being indexed
1007
1008 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1009 $term : Search term string
1010 &$title : Outparam; set to $title object and return false for a match
1011
1012 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1013 $text: Text being shown
1014 $title: Title of the custom script/stylesheet page
1015 $output: Current OutputPage object
1016
1017 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1018 &$siteNotice: HTML returned as the sitenotice
1019 Return true to allow the normal method of notice selection/rendering to work,
1020 or change the value of $siteNotice and return false to alter it.
1021
1022 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1023 &$siteNotice: HTML sitenotice
1024 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1025
1026 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1027 $skin: Skin object
1028 &$text: bottomScripts Text
1029 Append to $text to add additional text/scripts after the stock bottom scripts.
1030
1031 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1032 $skin: Skin object
1033 &$subpages: Subpage links HTML
1034 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1035 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1036
1037 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1038 $sktemplate: SkinTemplate object
1039 $content_actions: array of tabs
1040
1041 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1042 $sktemplate: SkinTemplate object
1043 $nav_urls: array of tabs
1044
1045 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1046 &$content_actions: Content actions
1047 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1048 for an example]
1049
1050 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1051 &$sktemplate: SkinTemplate object
1052 &$tpl: Template engine object
1053
1054 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1055 $sktemplate: SkinTemplate object
1056 $res: set to true to prevent active tabs
1057
1058 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1059 $out: Css to return
1060
1061 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1062 You can either create your own array, or alter the parameters for the normal one.
1063 &$this: The SkinTemplate instance.
1064 $title: Title instance for the page.
1065 $message: Visible label of tab.
1066 $selected: Whether this is a selected tab.
1067 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1068 &$classes: Array of CSS classes to apply.
1069 &$query: Query string to add to link.
1070 &$text: Link text.
1071 &$result: Complete assoc. array if you want to return true.
1072
1073 'SkinTemplateTabs': called when finished to build the actions tabs
1074 $sktemplate: SkinTemplate object
1075 $content_actions: array of tabs
1076
1077 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1078 $tools: array of tools
1079
1080 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1081 $id: User identifier
1082
1083 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1084 $pager: The UsersPager instance
1085 $query: The query array to be returned
1086
1087 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1088 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1089 $row: Database row object
1090
1091 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1092 $pager: The UsersPager instance
1093 $out: The header HTML
1094
1095 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1096 $pager: The UsersPager instance
1097 $out: The header HTML
1098
1099 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1100 $pager: The UsersPager instance
1101 $query: The query array to be returned
1102
1103 'SpecialMovepageAfterMove': called after moving a page
1104 $movePage: MovePageForm object
1105 $oldTitle: old title (object)
1106 $newTitle: new title (object)
1107
1108 'SpecialPageExecuteAfterPage': called after executing a special page
1109 Warning: Not all the special pages call this hook
1110 $specialPage: SpecialPage object
1111 $par: paramter passed to the special page (string)
1112 $funct: function called to execute the special page
1113
1114 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1115 Warning: Not all the special pages call this hook
1116 $specialPage: SpecialPage object
1117 $par: paramter passed to the special page (string)
1118 $funct: function called to execute the special page
1119
1120 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1121 Warning: Not all the special pages call this hook
1122 $specialPage: SpecialPage object
1123 $par: paramter passed to the special page (string)
1124 $funct: function called to execute the special page
1125
1126 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1127 $list: list (array) of core special pages
1128
1129 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1130 &$extraOpts: array of added items, to which can be added
1131 $opts: FormOptions for this request
1132
1133 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1134 &$conds: array of where conditionals for query
1135 &$tables: array of tables to be queried
1136 &$join_conds: join conditions for the tables
1137 $opts: FormOptions for this request
1138
1139 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1140 $title: title object generated from the text entred by the user
1141
1142 'SpecialSearchResults': called before search result display when there are matches
1143 $term: string of search term
1144 &$titleMatches: empty or SearchResultSet object
1145 &$textMatches: empty or SearchResultSet object
1146
1147 'SpecialSearchNoResults': called before search result display when there are no matches
1148 $term: string of search term
1149
1150 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1151 $extTypes: associative array of extensions types
1152
1153 'TitleMoveComplete': after moving an article (title)
1154 $old: old title
1155 $nt: new title
1156 $user: user who did the move
1157 $pageid: database ID of the page that's been moved
1158 $redirid: database ID of the created redirect
1159
1160 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1161 $title: title object related to the revision
1162 $rev: revision (object) that will be viewed
1163
1164 'UnknownAction': An unknown "action" has occured (useful for defining
1165 your own actions)
1166 $action: action name
1167 $article: article "acted on"
1168
1169 'UnwatchArticle': before a watch is removed from an article
1170 $user: user watching
1171 $article: article object to be removed
1172
1173 'UnwatchArticle': after a watch is removed from an article
1174 $user: user that was watching
1175 $article: article object removed
1176
1177 'UnwatchArticleComplete': after a watch is removed from an article
1178 $user: user that watched
1179 $article: article object that was watched
1180
1181 'UploadForm:initial': before the upload form is generated
1182 $form: UploadForm object
1183 You might set the member-variables $uploadFormTextTop and
1184 $uploadFormTextAfterSummary to inject text (HTML) either before
1185 or after the editform.
1186
1187 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1188 $form: UploadForm object
1189 Lets you poke at member variables like $mUploadDescription before the
1190 file is saved.
1191
1192 'UploadVerification': additional chances to reject an uploaded file
1193 string $saveName: destination file name
1194 string $tempName: filesystem path to the temporary file for checks
1195 string &$error: output: HTML error to show if upload canceled by returning false
1196
1197 'UploadComplete': Upon completion of a file upload
1198 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1199
1200 'UserArrayFromResult': called when creating an UserArray object from a database result
1201 &$userArray: set this to an object to override the default object returned
1202 $res: database result used to create the object
1203
1204 'userCan': To interrupt/advise the "user can do X to Y article" check.
1205 If you want to display an error message, try getUserPermissionsErrors.
1206 $title: Title object being checked against
1207 $user : Current user object
1208 $action: Action being checked
1209 $result: Pointer to result returned if hook returns false. If null is returned,
1210 userCan checks are continued by internal code.
1211
1212 'UserCanSendEmail': To override User::canSendEmail() permission check
1213 $user: User (object) whose permission is being checked
1214 &$canSend: bool set on input, can override on output
1215
1216
1217 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1218 $user: User (object) that'll clear the message
1219
1220 'UserCreateForm': change to manipulate the login form
1221 $template: SimpleTemplate instance for the form
1222
1223 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1224 $user: User to get groups for
1225 &$groups: Current effective groups
1226
1227 'UserGetAllRights': after calculating a list of all available rights
1228 &$rights: Array of rights, which may be added to.
1229
1230 'UserGetEmail': called when getting an user email address
1231 $user: User object
1232 &$email: email, change this to override local email
1233
1234 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1235 $user: User object
1236 &$timestamp: timestamp, change this to override local email authentification timestamp
1237
1238 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1239 &$groups: List of implicit (automatically-assigned) groups
1240
1241 'UserGetRights': Called in User::getRights()
1242 $user: User to get rights for
1243 &$rights: Current rights
1244
1245 'UserLoadDefaults': called when loading a default user
1246 $user: user object
1247 $name: user name
1248
1249 'UserLoadFromSession': called to authenticate users on external/environmental means
1250 $user: user object being loaded
1251 &$result: set this to a boolean value to abort the normal authentification process
1252
1253 'UserLoginComplete': after a user has logged in
1254 $user: the user object that was created on login
1255 $inject_html: Any HTML to inject after the "logged in" message.
1256
1257 'UserLoginForm': change to manipulate the login form
1258 $template: SimpleTemplate instance for the form
1259
1260 'UserLogout': before a user logs out
1261 $user: the user object that is about to be logged out
1262
1263 'UserLogoutComplete': after a user has logged out
1264 $user: the user object _after_ logout (won't have name, ID, etc.)
1265 $inject_html: Any HTML to inject after the "logged out" message.
1266 $oldName: name of the user before logout (string)
1267
1268 'UserRights': After a user's group memberships are changed
1269 $user : User object that was changed
1270 $add : Array of strings corresponding to groups added
1271 $remove: Array of strings corresponding to groups removed
1272
1273 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1274 $user: user retrieving new talks messages
1275 $talks: array of new talks page(s)
1276
1277 'UserSaveSettings': called when saving user settings
1278 $user: User object
1279
1280 'UserSetCookies': called when setting user cookies
1281 $user: User object
1282 &$session: session array, will be added to $_SESSION
1283 &$cookies: cookies array mapping cookie name to its value
1284
1285 'UserSetEmail': called when changing user email address
1286 $user: User object
1287 &$email: new email, change this to override new email address
1288
1289 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1290 $user: User object
1291 &$timestamp: new timestamp, change this to override local email authentification timestamp
1292
1293 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1294 $toggles: array of toggles to add
1295
1296 'WatchArticle': before a watch is added to an article
1297 $user: user that will watch
1298 $article: article object to be watched
1299
1300 'WatchArticleComplete': after a watch is added to an article
1301 $user: user that watched
1302 $article: article object watched
1303
1304 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1305 $query: $wgQueryPages itself
1306
1307 More hooks might be available but undocumented, you can execute
1308 ./maintenance/findhooks.php to find hidden one.