Revert r37741 for now "Changed getInternalLinkAttributesInternal parameters: now...
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
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.
5
6 ==Glossary==
7
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'.
15
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==
24
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.
31
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):
36
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
39
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
42 }
43
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
46 }
47
48 # code to actually show the article goes here
49 }
50
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:
54
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 }
65
66 # code to actually show the article goes here
67
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
70 }
71 }
72
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:
75
76 function showAnArticle($article) {
77
78 if (wfRunHooks('ArticleShow', array(&$article))) {
79
80 # code to actually show the article goes here
81
82 wfRunHooks('ArticleShowComplete', array(&$article));
83 }
84 }
85
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.
89
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:
95
96 function reverseArticleTitle($article) {
97 # ...
98 }
99
100 function reverseForExport($article) {
101 # ...
102 }
103
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
106
107 setupTitleReversingExtension() {
108 global $wgHooks;
109
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
113 }
114
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.
118
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:
122
123 require_once('extensions/ReverseTitle.php');
124
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
127
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.
130
131 ==Writing hooks==
132
133 A hook is a chunk of code run at some particular event. It consists of:
134
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
137
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:
140
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
144
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
149
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:
153
154 # function, no data
155 someFunction($param1, $param2)
156 # function with data
157 someFunction($someData, $param1, $param2)
158
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.
169
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
172
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
175
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
178
179 Hooks can return three possible values:
180
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:
190
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
192
193 function ldapLogin($username, $password) {
194 # log user into LDAP
195 return false;
196 }
197
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
200
201 ==Using hooks==
202
203 A calling function or method uses the wfRunHooks() function to run the hooks
204 related to a particular event, like so:
205
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.
221
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.
227
228 ==Events and parameters==
229
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.
232
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.
236
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.
243
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)
250
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
254
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)
258
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; ).
262
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
267
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
275
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)
286
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)
297
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
301
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)
308
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
314
315 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
316 $article: article (object) of the user talk page
317
318 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
319 $article: article (object) being modified
320
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
324
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
335
336 'ArticleMergeComplete': after merging to article using Special:Mergehistory
337 $targetTitle: target title (object)
338 $destTitle: destination title (object)
339
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
343
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
347
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
354
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
361
362 'ArticlePurge': before executing "&action=purge"
363 $article: article (object) to purge
364
365 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
366 revision of an article
367 &$title: title object of the article
368
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)
373
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
378
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 #
387
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
398
399 'ArticleSaveComplete': after an article is saved
400 $article: the article (object) saved
401 $user: the user (object) who saved the article
402 $text: the new article text
403 $summary: the article summary (comment)
404 $isminor: minor flag
405 $iswatch: watch flag
406 $section: section #
407
408 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
409
410 'ArticleUndelete': When one or more revisions of an article are restored
411 $title: Title corresponding to the article restored
412 $create: Whether or not the restoration caused the page to be created
413 (i.e. it didn't exist before)
414
415 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
416 &$article: the article
417 &$sectionanchor: The section anchor link (e.g. "#overview" )
418 &$extraq: Extra query parameters which can be added via hooked functions
419
420 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
421 &$article: the article
422 &$pcache: whether to try the parser cache or not
423 &$outputDone: whether the output for this page finished or not
424
425 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
426 $article: target article (object)
427
428 'AuthPluginAutoCreate': Called when creating a local account for an user logged
429 in from an external authentication method
430 $user: User object created locally
431
432 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
433 Gives a chance for an extension to set it programattically to a variable class.
434 &$auth: the $wgAuth object, probably a stub
435
436 'AutopromoteCondition': check autopromote condition for user.
437 $type: condition type
438 $args: arguments
439 $user: user
440 $result: result of checking autopromote condition
441
442 'BadImage': When checking against the bad image list
443 $name: Image name being checked
444 &$bad: Whether or not the image is "bad"
445
446 Change $bad and return false to override. If an image is "bad", it is not
447 rendered inline in wiki pages or galleries in category pages.
448
449 'BeforeGalleryFindFile': before an image is fetched for a gallery
450 &$gallery,: the gallery object
451 &$nt: the image title
452 &$time: image timestamp
453
454 'BeforePageDisplay': Prior to outputting a page
455 &$out: OutputPage object
456 &$skin: Skin object
457
458 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
459 &$parser: Parser object
460 &$title: title of the template
461 &$skip: skip this template and link it?
462 &$id: the id of the revision being parsed
463
464 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
465 &$parser: Parser object
466 &$nt: the image title
467 &$skip: skip this image and link it?
468 &$time: the image timestamp
469
470 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
471 &$parser: Parser object
472 &$ig: ImageGallery object
473
474 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
475 $nondefaults: Assoc array with the following keys:
476 days, hideOwn, hideBots, hideMinor, namespace
477 $wgUser: wgUser.
478 &$hookSql: a string which will be inserted without sanitation into the SQL query
479 used to get the watchlist, at the end of the WHERE part.
480
481 'BlockIp': before an IP address or user is blocked
482 $block: the Block object about to be saved
483 $user: the user _doing_ the block (not the one being blocked)
484
485 'BlockIpComplete': after an IP address or user is blocked
486 $block: the Block object that was saved
487 $user: the user who did the block (not the one being blocked)
488
489 'BookInformation': Before information output on Special:Booksources
490 $isbn: ISBN to show information for
491 $output: OutputPage object in use
492
493 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
494 &$linker: Linker instance
495 $nt: the page title
496 $query: the URL query string passed in
497 &$u: the URL of this link
498 &$style: the inline CSS style
499 &$prefix: a prefix prepended to the linked text
500 &$text: the text placed by the user in the wiki-link
501 &$inside: any additional alphanumeric characters placed after the wiki-link,
502 that are made part of the link text
503 &$trail: text placed immediately after the HTML link
504
505 'CategoryPageView': before viewing a categorypage in CategoryPage::view
506 $catpage: CategoryPage instance
507
508 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
509 &$this: ChangesList instance.
510 &$articlelink: HTML of link to article (already filled-in).
511 &$s: HTML of row that is being constructed.
512 &$rc: RecentChange instance.
513 $unpatrolled: Whether or not we are showing unpatrolled changes.
514 $watched: Whether or not the change is watched by the user.
515
516 'ContributionsToolLinks': Change tool links above Special:Contributions
517 $id: User identifier
518 $title: User page title
519 &$tools: Array of tool links
520
521 'CustomEditor': When invoking the page editor
522 $article: Article being edited
523 $user: User performing the edit
524
525 Return true to allow the normal editor to be used, or false
526 if implementing a custom editor, e.g. for a special namespace,
527 etc.
528
529 'DiffViewHeader': called before diff display
530 $diff: DifferenceEngine object that's calling
531 $oldRev: Revision object of the "old" revision (may be null/invalid)
532 $newRev: Revision object of the "new" revision
533
534 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
535 $article: article (object) being viewed
536 $oldid: oldid (int) being viewed
537
538 'EditFilter': Perform checks on an edit
539 $editor: Edit form (see includes/EditPage.php)
540 $text: Contents of the edit box
541 $section: Section being edited
542 &$error: Error message to return
543 $summary: Edit summary for page
544
545 'EditFilterMerged': Post-section-merge edit filter
546 $editor: EditPage instance (object)
547 $text: content of the edit box
548 $error: error message to return
549 $summary: Edit summary for page
550
551 'EditFormPreloadText': Allows population of the edit form when creating new pages
552 &$text: Text to preload with
553 &$title: Title object representing the page being created
554
555 'EditPage::attemptSave': called before an article is
556 saved, that is before insertNewArticle() is called
557 &$editpage_Obj: the current EditPage object
558
559 'EditPage::showEditForm:fields': allows injection of form field into edit form
560 &$editor: the EditPage instance for reference
561 &$out: an OutputPage instance to write to
562 return value is ignored (should always return true)
563
564 'EditPage::showEditForm:initial': before showing the edit form
565 $editor: EditPage instance (object)
566
567 Return false to halt editing; you'll need to handle error messages, etc. yourself.
568 Alternatively, modifying $error and returning true will cause the contents of $error
569 to be echoed at the top of the edit form as wikitext. Return true without altering
570 $error to allow the edit to proceed.
571
572 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
573 when there's an edit conflict. Return false to halt normal diff output; in
574 this case you're responsible for computing and outputting the entire "conflict"
575 part, i.e., the "difference between revisions" and "your text" headers and
576 sections.
577 &$editor: EditPage instance
578 &$out: OutputPage instance
579
580 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
581 &$editpage: The current EditPage object
582 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
583
584 'EditSectionLink': Override the return value of Linker::editSectionLink()
585 $skin: Skin rendering the UI
586 $title: Title being linked to
587 $section: Section to link to
588 $link: Default link
589 $result: Result (alter this to override the generated links)
590
591 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
592 $skin: Skin rendering the UI
593 $title: Title being linked to
594 $section: Section to link to
595 $hint: Anchor title/tooltip attributes
596 $link: Default link
597 $result: Result (alter this to override the generated links)
598
599 'EmailConfirmed': When checking that the user's email address is "confirmed"
600 $user: User being checked
601 $confirmed: Whether or not the email address is confirmed
602 This runs before the other checks, such as anonymity and the real check; return
603 true to allow those checks to occur, and false if checking is done.
604
605 'EmailUser': before sending email from one user to another
606 $to: address of receiving user
607 $from: address of sending user
608 $subject: subject of the mail
609 $text: text of the mail
610
611 'EmailUserComplete': after sending email from one user to another
612 $to: address of receiving user
613 $from: address of sending user
614 $subject: subject of the mail
615 $text: text of the mail
616
617 'FetchChangesList': When fetching the ChangesList derivative for a particular user
618 &$user: User the list is being fetched for
619 &$skin: Skin object to be used with the list
620 &$list: List object (defaults to NULL, change it to an object instance and return
621 false override the list derivative used)
622
623 'FileDeleteComplete': When a file is deleted
624 $file: reference to the deleted file
625 $oldimage: in case of the deletion of an old image, the name of the old file
626 $article: in case all revisions of the file are deleted a reference to the article
627 associated with the file.
628 $user: user who performed the deletion
629 $reason: reason
630
631 'FileUpload': When a file upload occurs
632 $file : Image object representing the file that was uploaded
633
634 'FileUndeleteComplete': When a file is undeleted
635 $title: title object to the file
636 $fileVersions: array of undeleted versions. Empty if all versions were restored
637 $user: user who performed the undeletion
638 $reason: reason
639
640 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
641 &$user: user to promote.
642 &$promote: groups that will be added.
643
644 'GetBlockedStatus': after loading blocking status of an user from the database
645 $user: user (object) being checked
646
647 'GetCacheVaryCookies': get cookies that should vary cache options
648 $out: OutputPage object
649 &$cookies: array of cookies name, add a value to it if you want to add a cookie
650 that have to vary cache options
651
652 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
653 $title: Title object of page
654 $url: string value as output (out parameter, can modify)
655 $query: query options passed to Title::getFullURL()
656
657 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
658 $title: Title object of page
659 $url: string value as output (out parameter, can modify)
660 $query: query options passed to Title::getInternalURL()
661
662 'GetLinkColours': modify the CSS class of an array of page links
663 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
664 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
665
666 'GetLocalURL': modify local URLs as output into page links
667 $title: Title object of page
668 $url: string value as output (out parameter, can modify)
669 $query: query options passed to Title::getLocalURL()
670
671 'getUserPermissionsErrors': Add a permissions error when permissions errors are
672 checked for. Use instead of userCan for most cases. Return false if the
673 user can't do it, and populate $result with the reason in the form of
674 array( messagename, param1, param2, ... ). For consistency, error messages
675 should be plain text with no special coloring, bolding, etc. to show that
676 they're errors; presenting them properly to the user as errors is done by
677 the caller.
678 $title: Title object being checked against
679 $user : Current user object
680 $action: Action being checked
681 $result: User permissions error to add. If none, return true.
682
683 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
684 if expensive checks are enabled.
685
686 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
687 image insertion. You can skip the default logic entirely by returning
688 false, or just modify a few things using call-by-reference.
689 &$this: Skin object
690 &$title: Title object of the image
691 &$file: File object, or false if it doesn't exist
692 &$frameParams: Various parameters with special meanings; see documentation in
693 includes/Linker.php for Linker::makeImageLink2
694 &$handlerParams: Various parameters with special meanings; see documentation in
695 includes/Linker.php for Linker::makeImageLink2
696 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
697 &$res: Final HTML output, used if you return false
698
699
700 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
701 the image on an image page
702 $imagePage: ImagePage object ($this)
703 $output: $wgOut
704
705 'ImagePageFileHistoryLine': called when a file history line is contructed
706 $file: the file
707 $line: the HTML of the history line
708 $css: the line CSS class
709
710 'ImagePageFindFile': called when fetching the file associated with an image page
711 $page: ImagePage object
712 &$file: File object
713 &$displayFile: displayed File object
714
715 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
716 $title: Title object ($wgTitle)
717 $request: WebRequest
718 $ignoreRedirect: boolean to skip redirect check
719 $target: Title/string of redirect target
720
721 'InitPreferencesForm': called at the end of PreferencesForm's constructor
722 $form: the PreferencesForm
723 $request: the web request to initialized from
724
725 'InternalParseBeforeLinks': during Parser's internalParse method before links but
726 after noinclude/includeonly/onlyinclude and other processing.
727 &$this: Parser object
728 &$text: string containing partially parsed text
729 &$this->mStripState: Parser's internal StripState object
730
731 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
732 $article: article (object) being checked
733
734 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
735 $ip: IP being check
736 $result: Change this value to override the result of wfIsTrustedProxy()
737
738 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
739 tance to return false if the domain name doesn't match your organization
740 $addr: The e-mail address entered by the user
741 &$result: Set this and return false to override the internal checks
742
743 'isValidPassword': Override the result of User::isValidPassword()
744 $password: The password entered by the user
745 &$result: Set this and return false to override the internal checks
746 $user: User the password is being validated for
747
748 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
749 $magicExtensions: associative array of magic words synonyms
750 $lang: laguage code (string)
751
752 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
753 $specialPageAliases: associative array of magic words synonyms
754 $lang: laguage code (string)
755
756 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
757 &$url: the image url
758 &$alt: the image's alt text
759 &$img: the new image HTML (if returning false)
760
761 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
762 &$url: the link url
763 &$text: the link text
764 &$link: the new link HTML (if returning false)
765
766 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
767 &$linksUpdate: the LinkUpdate object
768
769 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
770 &$linksUpdate: the LinkUpdate object
771
772 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
773 &$linksUpdate: the LinkUpdate object
774
775 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
776
777 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
778
779 'LocalFile::getHistory': called before file history query performed
780 $file: the file
781 $tables: tables
782 $fields: select fields
783 $conds: conditions
784 $opts: query options
785 $join_conds: JOIN conditions
786
787 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
788 No return data is accepted; this hook is for auditing only.
789 $user: the User object being authenticated against
790 $password: the password being submitted and found wanting
791 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
792
793 'LogLine': Processes a single log entry on Special:Log
794 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
795 database field.
796 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
797 to logging.log_action database field.
798 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
799 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
800 appears to contain anything.
801 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
802 &$revert: string that is displayed in the UI, similar to $comment.
803 $time: timestamp of the log entry (added in 1.12)
804
805 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
806 &$type: array of strings
807
808 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
809 &$typeText: array of strings
810
811 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
812 &$headerText: array of strings
813
814 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
815 &$actionText: array of strings
816
817 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
818 $magicWords: array of strings
819
820 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
821 $variableIDs: array of strings
822
823 'MarkPatrolled': before an edit is marked patrolled
824 $rcid: ID of the revision to be marked patrolled
825 $user: the user (object) marking the revision as patrolled
826 $wcOnlySysopsCanPatrol: config setting indicating whether the user
827 needs to be a sysop in order to mark an edit patrolled
828
829 'MarkPatrolledComplete': after an edit is marked patrolled
830 $rcid: ID of the revision marked as patrolled
831 $user: user (object) who marked the edit patrolled
832 $wcOnlySysopsCanPatrol: config setting indicating whether the user
833 must be a sysop to patrol the edit
834
835 'MathAfterTexvc': after texvc is executed when rendering mathematics
836 $mathRenderer: instance of MathRenderer
837 $errmsg: error message, in HTML (string). Nonempty indicates failure
838 of rendering the formula
839
840 'MediaWikiPerformAction': Override MediaWiki::performAction().
841 Use this to do something completely different, after the basic
842 globals have been set up, but before ordinary actions take place.
843 $output: $wgOut
844 $article: $wgArticle
845 $title: $wgTitle
846 $user: $wgUser
847 $request: $wgRequest
848 $this: The $mediawiki object
849
850 'MessagesPreLoad': When loading a message from the database
851 $title: title of the message (string)
852 $message: value (string), change it to the message you want to define
853
854 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
855 Note: this is only run for the Monobook skin. To add items to the toolbox
856 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
857 instead.
858 $tools: array of tools
859
860 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
861 $article: the article edited
862 $rev: the new revision
863 $baseID: the revision ID this was based off, if any
864
865 'NormalizeMessageKey': Called before the software gets the text of a message
866 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
867 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
868 &$useDB: whether or not to look up the message in the database (bool)
869 &$langCode: the language code to get the message for (string) - or -
870 whether to use the content language (true) or site language (false) (bool)
871 &$transform: whether or not to expand variables and templates in the message (bool)
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 'ParserBeforeTidy': called before tidy and custom tags replacements
925 $parser: Parser object being used
926 $text: actual text
927
928 'ParserClearState': called at the end of Parser::clearState()
929 $parser: Parser object being cleared
930
931 'ParserFirstCallInit': called when the parser initialises for the first time
932 &$parser: Parser object being cleared
933
934 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
935 $parser: Parser object
936 $varCache: array to store the value in case of multiples calls of the same magic word
937 $index: index (string) of the magic
938 $ret: value of the magic word (the hook should set it)
939
940 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
941 $parser: Parser object
942 $time: actual time (timestamp)
943
944 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
945 $parser: Parser object
946 $varCache: varaiable cache (array)
947
948 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
949 $parser: Parser object
950 $limitReport: text that will be included (without comment tags)
951
952 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
953 $title: title object representing the file
954 $file: file object that will be used to create the image
955 &$params: 2-D array of parameters
956
957 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
958 $parser: Parser object created
959
960 'ParserTestTables': alter the list of tables to duplicate when parser tests
961 are run. Use when page save hooks require the presence of custom tables
962 to ensure that tests continue to run properly.
963 &$tables: array of table names
964
965 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
966 my talk page, my contributions" etc).
967
968 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
969 &$title: Title object representing the current page
970
971 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
972 &$user : User performing the action
973 $action : Action being performed
974 &$result : Whether or not the action should be prevented
975 Change $result and return false to give a definitive answer, otherwise
976 the built-in rate limiting checks are used, if enabled.
977
978 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
979 $form : PreferencesForm object
980 &$html : HTML to append to
981
982 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
983 AJAX search suggestions. Put results into &$results outparam and return false.
984 $ns : array of int namespace keys to search in
985 $search : search term (not guaranteed to be conveniently normalized)
986 $limit : maximum number of results to return
987 &$results : out param: array of page names (strings)
988
989 'PrefsEmailAudit': called when user changes his email address
990 $user: User (object) changing his email address
991 $oldaddr: old email address (string)
992 $newaddr: new email address (string)
993
994 'PrefsPasswordAudit': called when user changes his password
995 $user: User (object) changing his passoword
996 $newPass: new password
997 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
998
999 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1000 &$obj: RawPage object
1001 &$text: The text that's going to be the output
1002
1003 'RecentChange_save': called at the end of RecenChange::save()
1004 $recentChange: RecentChange object
1005
1006 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1007 $form: the PreferencesForm
1008 $out: output page to render to, probably $wgOut
1009
1010 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1011 $form: the PreferencesForm
1012 $user: the User object to load preferences from
1013
1014 'RevisionInsertComplete': called after a revision is inserted into the DB
1015 &$revision: the Revision
1016 $data: the data stored in old_text. The meaning depends on $flags: if external
1017 is set, it's the URL of the revision text in external storage; otherwise,
1018 it's the revision text itself. In either case, if gzip is set, the revision
1019 text is gzipped.
1020 $flags: a comma-delimited list of strings representing the options used. May
1021 include: utf8 (this will always be set for new revisions); gzip; external.
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.