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