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