whitespace clean up mw.util
[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 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
204
205 ==Using hooks==
206
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
209
210 class Article {
211 # ...
212 function protect() {
213 global $wgUser;
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217 }
218 }
219 }
220
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
225
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
230 MediaWiki 1.4rc1.
231
232 ==Events and parameters==
233
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
236
237 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
240
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
243
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248 default is LoginForm::ABORTED. Note that the client may be using
249 a machine API rather than the HTML user interface.
250
251 'AbortMove': allows to abort moving an article (title)
252 $old: old title
253 $nt: new title
254 $user: user who is doing the move
255 $err: error message
256 $reason: the reason for the move (added in 1.13)
257
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
261
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
265
266 'AfterImportPage': When a page import is completed
267 $title: Title under which the revisions were imported
268 $origTitle: Title provided by the XML file
269 $revCount: Number of revisions in the XML file
270 $sRevCount: Number of sucessfully imported revisions
271 $pageInfo: associative array of page information
272
273 'AfterUserMessage': After a user message has been left, this hook is
274 called to take care of any cleanup.
275 $user: The user who we left the message for.
276 $article: The article the message was left on.
277 $subject: The subject of the message
278 $text: The text of the message.
279 $signature: The signature we used.
280 $summary: The edit summary.
281 $editor: The editor that performed the edit.
282
283 'AjaxAddScript': Called in output page just before the initialisation
284 of the javascript ajax engine. The hook is only called when ajax
285 is enabled ( $wgUseAjax = true; ).
286
287 'AlternateEdit': before checking if an user can edit a page and
288 before showing the edit form ( EditPage::edit() ). This is triggered
289 on &action=edit.
290 $EditPage: the EditPage object
291
292 'APIAfterExecute': after calling the execute() method of an API module.
293 Use this to extend core API modules.
294 &$module: Module object
295
296 'APIEditBeforeSave': before saving a page with api.php?action=edit,
297 after processing request parameters. Return false to let the request
298 fail, returning an error message or an <edit result="Failure"> tag
299 if $resultArr was filled.
300 $EditPage : the EditPage object
301 $text : the new text of the article (has yet to be saved)
302 &$resultArr : data in this array will be added to the API result
303
304 'APIGetAllowedParams': use this hook to modify a module's parameters.
305 &$module: Module object
306 &$params: Array of parameters
307
308 'APIGetParamDescription': use this hook to modify a module's parameter
309 descriptions.
310 &$module: Module object
311 &$desc: Array of parameter descriptions
312
313 'APIQueryAfterExecute': after calling the execute() method of an
314 action=query submodule. Use this to extend core API modules.
315 &$module: Module object
316
317 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
318 method of an action=query submodule. Use this to extend core API modules.
319 &$module: Module object
320 &$resultPageSet: ApiPageSet object
321
322 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
323 Every token has an action, which will be used in the intoken parameter
324 and in the output (actiontoken="..."), and a callback function which
325 should return the token, or false if the user isn't allowed to obtain
326 it. The prototype of the callback function is func($pageid, $title)
327 where $pageid is the page ID of the page the token is requested for
328 and $title is the associated Title object. In the hook, just add
329 your callback to the $tokenFunctions array and return true (returning
330 false makes no sense)
331 $tokenFunctions: array(action => callback)
332
333 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
334 Every token has an action, which will be used in the rvtoken parameter
335 and in the output (actiontoken="..."), and a callback function which
336 should return the token, or false if the user isn't allowed to obtain
337 it. The prototype of the callback function is func($pageid, $title, $rev)
338 where $pageid is the page ID of the page associated to the revision the
339 token is requested for, $title the associated Title object and $rev the
340 associated Revision object. In the hook, just add your callback to the
341 $tokenFunctions array and return true (returning false makes no sense)
342 $tokenFunctions: array(action => callback)
343
344 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
345 list=recentchanges.
346 Every token has an action, which will be used in the rctoken parameter
347 and in the output (actiontoken="..."), and a callback function which
348 should return the token, or false if the user isn't allowed to obtain
349 it. The prototype of the callback function is func($pageid, $title, $rc)
350 where $pageid is the page ID of the page associated to the revision the
351 token is requested for, $title the associated Title object and $rc the
352 associated RecentChange object. In the hook, just add your callback to the
353 $tokenFunctions array and return true (returning false makes no sense)
354 $tokenFunctions: array(action => callback)
355
356 'APIQueryUsersTokens': use this hook to add custom token to list=users.
357 Every token has an action, which will be used in the ustoken parameter
358 and in the output (actiontoken="..."), and a callback function which
359 should return the token, or false if the user isn't allowed to obtain
360 it. The prototype of the callback function is func($user) where $user
361 is the User object. In the hook, just add your callback to the
362 $tokenFunctions array and return true (returning false makes no sense)
363 $tokenFunctions: array(action => callback)
364
365 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
366 Each service should have its own entry in the $apis array and have a
367 unique name, passed as key for the array that represents the service data.
368 In this data array, the key-value-pair identified by the apiLink key is
369 required.
370 &$apis: array of services
371
372 'ArticleAfterFetchContent': after fetching content of an article from
373 the database
374 $article: the article (object) being loaded from the database
375 $content: the content (string) of the article
376
377 'ArticleConfirmDelete': before writing the confirmation form for article
378 deletion
379 $article: the article (object) being deleted
380 $output: the OutputPage object ($wgOut)
381 &$reason: the reason (string) the article is being deleted
382
383 'ArticleContentOnDiff': before showing the article below a diff
384 $diffEngine: the DifferenceEngine
385 $output: the OutputPage object ($wgOut)
386
387 'ArticleDelete': before an article is deleted
388 $article: the article (object) being deleted
389 $user: the user (object) deleting the article
390 $reason: the reason (string) the article is being deleted
391 $error: if the deletion was prohibited, the (raw HTML) error message to display
392 (added in 1.13)
393
394 'ArticleDeleteComplete': after an article is deleted
395 $article: the article that was deleted
396 $user: the user that deleted the article
397 $reason: the reason the article was deleted
398 $id: id of the article that was deleted
399
400 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
401 was changed
402 $article: article (object) of the user talk page
403
404 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
405 article has been changed
406 $article: the article (object)
407 $editInfo: data holder that includes the parser output ($editInfo->output) for
408 that page after the change
409 $changed: bool for if the page was changed
410
411 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
412 recentchanges table, return false to not delete old entries
413 $article: article (object) being modified
414
415 'ArticleFromTitle': when creating an article object from a title object using
416 Wiki::articleFromTitle()
417 $title: title (object) used to create the article object
418 $article: article (object) that will be returned
419
420 'ArticleInsertComplete': After a new article is created
421 $article: Article created
422 $user: User creating the article
423 $text: New content
424 $summary: Edit summary/comment
425 $isMinor: Whether or not the edit was marked as minor
426 $isWatch: (No longer used)
427 $section: (No longer used)
428 $flags: Flags passed to Article::doEdit()
429 $revision: New Revision of the article
430
431 'ArticleMergeComplete': after merging to article using Special:Mergehistory
432 $targetTitle: target title (object)
433 $destTitle: destination title (object)
434
435 'ArticlePageDataAfter': after loading data of an article from the database
436 $article: article (object) whose data were loaded
437 $row: row (object) returned from the database server
438
439 'ArticlePageDataBefore': before loading data of an article from the database
440 $article: article (object) that data will be loaded
441 $fields: fileds (array) to load from the database
442
443 'ArticleProtect': before an article is protected
444 $article: the article being protected
445 $user: the user doing the protection
446 $protect: boolean whether this is a protect or an unprotect
447 $reason: Reason for protect
448 $moveonly: boolean whether this is for move only or not
449
450 'ArticleProtectComplete': after an article is protected
451 $article: the article that was protected
452 $user: the user who did the protection
453 $protect: boolean whether it was a protect or an unprotect
454 $reason: Reason for protect
455 $moveonly: boolean whether it was for move only or not
456
457 'ArticlePurge': before executing "&action=purge"
458 $article: article (object) to purge
459
460 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
461 revision of an article
462 &$title: title object of the article
463
464 'ArticleRevisionUndeleted': after an article revision is restored
465 $title: the article title
466 $revision: the revision
467 $oldPageID: the page ID of the revision when archived (may be null)
468
469 'ArticleRollbackComplete': after an article rollback is completed
470 $article: the article that was edited
471 $user: the user who did the rollback
472 $revision: the revision the page was reverted back to
473 $current: the reverted revision
474
475 'ArticleSave': before an article is saved
476 $article: the article (object) being saved
477 $user: the user (object) saving the article
478 $text: the new article text
479 $summary: the article summary (comment)
480 $isminor: minor flag
481 $iswatch: watch flag
482 $section: section #
483
484 'ArticleSaveComplete': After an article has been updated
485 $article: Article modified
486 $user: User performing the modification
487 $text: New content
488 $summary: Edit summary/comment
489 $isMinor: Whether or not the edit was marked as minor
490 $isWatch: (No longer used)
491 $section: (No longer used)
492 $flags: Flags passed to Article::doEdit()
493 $revision: New Revision of the article
494 $baseRevId: the rev ID (or false) this edit was based on
495
496 'ArticleUndelete': When one or more revisions of an article are restored
497 $title: Title corresponding to the article restored
498 $create: Whether or not the restoration caused the page to be created
499 (i.e. it didn't exist before)
500 $comment: The comment associated with the undeletion.
501
502 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
503 before the user is redirected back to the page
504 &$article: the article
505 &$sectionanchor: The section anchor link (e.g. "#overview" )
506 &$extraq: Extra query parameters which can be added via hooked functions
507
508 'ArticleViewHeader': Before the parser cache is about to be tried for article
509 viewing.
510 &$article: the article
511 &$pcache: whether to try the parser cache or not
512 &$outputDone: whether the output for this page finished or not
513
514 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
515 follwed an redirect
516 $article: target article (object)
517
518 'AuthPluginAutoCreate': Called when creating a local account for an user logged
519 in from an external authentication method
520 $user: User object created locally
521
522 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
523 Gives a chance for an extension to set it programattically to a variable class.
524 &$auth: the $wgAuth object, probably a stub
525
526 'AutopromoteCondition': check autopromote condition for user.
527 $type: condition type
528 $args: arguments
529 $user: user
530 $result: result of checking autopromote condition
531
532 'BadImage': When checking against the bad image list
533 $name: Image name being checked
534 &$bad: Whether or not the image is "bad"
535
536 Change $bad and return false to override. If an image is "bad", it is not
537 rendered inline in wiki pages or galleries in category pages.
538
539 'BeforeGalleryFindFile': before an image is fetched for a gallery
540 &$gallery,: the gallery object
541 &$nt: the image title
542 &$time: image timestamp
543
544 'BeforeInitialize': before anything is initialized in performRequestForTitle()
545 &$title: Title being used for request
546 &$article: The associated Article object
547 &$output: OutputPage object
548 &$user: User
549 $request: WebRequest object
550 $mediaWiki: Mediawiki object
551
552 'BeforePageDisplay': Prior to outputting a page
553 &$out: OutputPage object
554 &$skin: Skin object
555
556 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
557 &$parser: Parser object
558 &$title: title of the template
559 &$skip: skip this template and link it?
560 &$id: the id of the revision being parsed
561
562 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
563 &$parser: Parser object
564 &$nt: the image title
565 &$skip: skip this image and link it?
566 &$time: the image timestamp
567
568 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
569 &$parser: Parser object
570 &$ig: ImageGallery object
571
572 'BlockIp': before an IP address or user is blocked
573 $block: the Block object about to be saved
574 $user: the user _doing_ the block (not the one being blocked)
575
576 'BlockIpComplete': after an IP address or user is blocked
577 $block: the Block object that was saved
578 $user: the user who did the block (not the one being blocked)
579
580 'BookInformation': Before information output on Special:Booksources
581 $isbn: ISBN to show information for
582 $output: OutputPage object in use
583
584 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
585 &$namespaces: Array of namespace numbers with corresponding canonical names
586
587 'CategoryPageView': before viewing a categorypage in CategoryPage::view
588 $catpage: CategoryPage instance
589
590 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
591 &$changesList: ChangesList instance.
592 &$articlelink: HTML of link to article (already filled-in).
593 &$s: HTML of row that is being constructed.
594 &$rc: RecentChange instance.
595 $unpatrolled: Whether or not we are showing unpatrolled changes.
596 $watched: Whether or not the change is watched by the user.
597
598 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
599 $user: user (object) whose email is being confirmed
600
601 'ContribsPager::getQueryInfo': Before the contributions query is about to run
602 &$pager: Pager object for contributions
603 &queryInfo: The query for the contribs Pager
604
605 'ContributionsLineEnding': Called before a contributions HTML line is finished
606 $page: SpecialPage object for contributions
607 $ret: the HTML line
608 $row: the DB row for this line
609
610 'ContributionsToolLinks': Change tool links above Special:Contributions
611 $id: User identifier
612 $title: User page title
613 &$tools: Array of tool links
614
615 'CustomEditor': When invoking the page editor
616 $article: Article being edited
617 $user: User performing the edit
618
619 Return true to allow the normal editor to be used, or false
620 if implementing a custom editor, e.g. for a special namespace,
621 etc.
622
623 'DatabaseOraclePostInit': Called after initialising an Oracle database
624 &$db: the DatabaseOracle object
625
626 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
627 $title: the diff page title (nullable)
628 &$oldId: the actual old Id to use in the diff
629 &$newId: the actual new Id to use in the diff (0 means current)
630 $old: the ?old= param value from the url
631 $new: the ?new= param value from the url
632
633 'DiffViewHeader': called before diff display
634 $diff: DifferenceEngine object that's calling
635 $oldRev: Revision object of the "old" revision (may be null/invalid)
636 $newRev: Revision object of the "new" revision
637
638 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
639 an article
640 $article: article (object) being viewed
641 $oldid: oldid (int) being viewed
642
643 'DoEditSectionLink': Override the HTML generated for section edit links
644 $skin: Skin object rendering the UI
645 $title: Title object for the title being linked to (may not be the same as
646 $wgTitle, if the section is included from a template)
647 $section: The designation of the section being pointed to, to be included in
648 the link, like "&section=$section"
649 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
650 By default, this is wrapped in the 'editsectionhint' message.
651 &$result: The HTML to return, prefilled with the default plus whatever other
652 changes earlier hooks have made
653 $lang: The language code to use for the link in the wfMsg* functions
654
655 'EditFilter': Perform checks on an edit
656 $editor: Edit form (see includes/EditPage.php)
657 $text: Contents of the edit box
658 $section: Section being edited
659 &$error: Error message to return
660 $summary: Edit summary for page
661
662 'EditFilterMerged': Post-section-merge edit filter
663 $editor: EditPage instance (object)
664 $text: content of the edit box
665 &$error: error message to return
666 $summary: Edit summary for page
667
668 'EditFormPreloadText': Allows population of the edit form when creating
669 new pages
670 &$text: Text to preload with
671 &$title: Title object representing the page being created
672
673 'EditFormInitialText': Allows modifying the edit form when editing existing
674 pages
675 $editPage: EditPage object
676
677 'EditPage::attemptSave': called before an article is
678 saved, that is before insertNewArticle() is called
679 $editpage_Obj: the current EditPage object
680
681 'EditPage::importFormData': allow extensions to read additional data
682 posted in the form
683 $editpage: EditPage instance
684 $request: Webrequest
685 return value is ignored (should always return true)
686
687 'EditPage::showEditForm:fields': allows injection of form field into edit form
688 &$editor: the EditPage instance for reference
689 &$out: an OutputPage instance to write to
690 return value is ignored (should always return true)
691
692 'EditPage::showEditForm:initial': before showing the edit form
693 $editor: EditPage instance (object)
694
695 Return false to halt editing; you'll need to handle error messages, etc.
696 yourself. Alternatively, modifying $error and returning true will cause the
697 contents of $error to be echoed at the top of the edit form as wikitext.
698 Return true without altering $error to allow the edit to proceed.
699
700 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
701 when there's an edit conflict. Return false to halt normal diff output; in
702 this case you're responsible for computing and outputting the entire "conflict"
703 part, i.e., the "difference between revisions" and "your text" headers and
704 sections.
705 &$editor: EditPage instance
706 &$out: OutputPage instance
707
708 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
709 textarea in the edit form
710 &$editpage: The current EditPage object
711 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
712 &$tabindex: HTML tabindex of the last edit check/button
713
714 'EditPageBeforeEditChecks': allows modifying the edit checks below the
715 textarea in the edit form
716 &$editpage: The current EditPage object
717 &$checks: Array of edit checks like "watch this page"/"minor edit"
718 &$tabindex: HTML tabindex of the last edit check/button
719
720 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
721 textarea in the edit form
722 &$toolbar: The toolbar HTMl
723
724 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
725 $title: title of page being edited
726 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
727
728 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
729 "Show changes"
730 $editPage: EditPage object
731 &$newtext: wikitext that will be used as "your version"
732
733 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
734 $editPage: EditPage object
735 &$toparse: wikitext that will be parsed
736
737 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
738 &$editpage: The current EditPage object
739 &$res: the HTML of the error text
740
741 'EditPageTosSummary': Give a chance for site and per-namespace customizations
742 of terms of service summary link that might exist separately from the copyright
743 notice.
744 $title: title of page being edited
745 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
746
747 'EditSectionLink': Do not use, use DoEditSectionLink instead.
748 $skin: Skin rendering the UI
749 $title: Title being linked to
750 $section: Section to link to
751 $link: Default link
752 &$result: Result (alter this to override the generated links)
753 $lang: The language code to use for the link in the wfMsg* functions
754
755 'EmailConfirmed': When checking that the user's email address is "confirmed"
756 $user: User being checked
757 $confirmed: Whether or not the email address is confirmed
758 This runs before the other checks, such as anonymity and the real check; return
759 true to allow those checks to occur, and false if checking is done.
760
761 'EmailUser': before sending email from one user to another
762 $to: address of receiving user
763 $from: address of sending user
764 $subject: subject of the mail
765 $text: text of the mail
766
767 'EmailUserCC': before sending the copy of the email to the author
768 $to: address of receiving user
769 $from: address of sending user
770 $subject: subject of the mail
771 $text: text of the mail
772
773 'EmailUserComplete': after sending email from one user to another
774 $to: address of receiving user
775 $from: address of sending user
776 $subject: subject of the mail
777 $text: text of the mail
778
779 'EmailUserForm': after building the email user form object
780 $form: HTMLForm object
781
782 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
783 $user: The user who is trying to email another user.
784 $editToken: The user's edit token.
785 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
786
787 'FetchChangesList': When fetching the ChangesList derivative for
788 a particular user
789 &$user: User the list is being fetched for
790 &$skin: Skin object to be used with the list
791 &$list: List object (defaults to NULL, change it to an object
792 instance and return false override the list derivative used)
793
794 'FileDeleteComplete': When a file is deleted
795 $file: reference to the deleted file
796 $oldimage: in case of the deletion of an old image, the name of the old file
797 $article: in case all revisions of the file are deleted a reference to the
798 article associated with the file.
799 $user: user who performed the deletion
800 $reason: reason
801
802 'FileUpload': When a file upload occurs
803 $file : Image object representing the file that was uploaded
804 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
805 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
806
807 'FileUndeleteComplete': When a file is undeleted
808 $title: title object to the file
809 $fileVersions: array of undeleted versions. Empty if all versions were restored
810 $user: user who performed the undeletion
811 $reason: reason
812
813 'FormatUserMessage': Hook to format a message if you want to override
814 the internal formatter.
815 $subject: Title of the message.
816 &$text: Text of the message.
817 $signature: Signature that they would like to leave.
818
819 'GetAutoPromoteGroups': When determining which autopromote groups a user
820 is entitled to be in.
821 &$user: user to promote.
822 &$promote: groups that will be added.
823
824 'GetBlockedStatus': after loading blocking status of an user from the database
825 $user: user (object) being checked
826
827 'GetCacheVaryCookies': get cookies that should vary cache options
828 $out: OutputPage object
829 &$cookies: array of cookies name, add a value to it if you want to add a cookie
830 that have to vary cache options
831
832 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
833 $title: Title object of page
834 $url: string value as output (out parameter, can modify)
835 $query: query options passed to Title::getFullURL()
836
837 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
838 $title: Title object of page
839 $url: string value as output (out parameter, can modify)
840 $query: query options passed to Title::getInternalURL()
841
842 'GetIP': modify the ip of the current user (called only once)
843 &$ip: string holding the ip as determined so far
844
845 'GetLinkColours': modify the CSS class of an array of page links
846 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
847 indexed by page_id.
848 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
849
850 'GetLocalURL': modify local URLs as output into page links
851 $title: Title object of page
852 $url: string value as output (out parameter, can modify)
853 $query: query options passed to Title::getLocalURL()
854
855 'GetPreferences': modify user preferences
856 $user: User whose preferences are being modified.
857 &$preferences: Preferences description array, to be fed to an HTMLForm object
858
859 'getUserPermissionsErrors': Add a permissions error when permissions errors are
860 checked for. Use instead of userCan for most cases. Return false if the
861 user can't do it, and populate $result with the reason in the form of
862 array( messagename, param1, param2, ... ). For consistency, error messages
863 should be plain text with no special coloring, bolding, etc. to show that
864 they're errors; presenting them properly to the user as errors is done by
865 the caller.
866 $title: Title object being checked against
867 $user : Current user object
868 $action: Action being checked
869 $result: User permissions error to add. If none, return true.
870
871 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
872 if expensive checks are enabled.
873
874 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
875 image insertion. You can skip the default logic entirely by returning
876 false, or just modify a few things using call-by-reference.
877 &$skin: Skin object
878 &$title: Title object of the image
879 &$file: File object, or false if it doesn't exist
880 &$frameParams: Various parameters with special meanings; see documentation in
881 includes/Linker.php for Linker::makeImageLink2
882 &$handlerParams: Various parameters with special meanings; see documentation in
883 includes/Linker.php for Linker::makeImageLink2
884 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
885 &$res: Final HTML output, used if you return false
886
887
888 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
889 the image on an image page
890 $imagePage: ImagePage object ($this)
891 $output: $wgOut
892
893 'ImagePageAfterImageLinks': called after the image links section on an image
894 page is built
895 $imagePage: ImagePage object ($this)
896 &$html: HTML for the hook to add
897
898 'ImagePageFileHistoryLine': called when a file history line is contructed
899 $file: the file
900 $line: the HTML of the history line
901 $css: the line CSS class
902
903 'ImagePageFindFile': called when fetching the file associated with an image page
904 $page: ImagePage object
905 &$file: File object
906 &$displayFile: displayed File object
907
908 'ImagePageShowTOC': called when the file toc on an image page is generated
909 $page: ImagePage object
910 &$toc: Array of <li> strings
911
912 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
913 using img_auth.php
914 &$title: the Title object of the file as it would appear for the upload page
915 &$path: the original file and path name when img_auth was invoked by the the web
916 server
917 &$name: the name only component of the file
918 &$result: The location to pass back results of the hook routine (only used if
919 failed)
920 $result[0]=The index of the header message
921 $result[1]=The index of the body text message
922 $result[2 through n]=Parameters passed to body text message. Please note the
923 header message cannot receive/use parameters.
924
925 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
926 $reader: XMLReader object
927 $logInfo: Array of information
928 Return false to stop further processing of the tag
929
930 'ImportHandlePageXMLTag': When parsing a XML tag in a page
931 $reader: XMLReader object
932 $pageInfo: Array of information
933 Return false to stop further processing of the tag
934
935 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
936 $reader: XMLReader object
937 $revInfo: Array of information
938 Return false to stop further processing of the tag
939
940 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
941 $reader: XMLReader object
942 Return false to stop further processing of the tag
943
944 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
945 $reader: XMLReader object
946 $revisionInfo: Array of information
947 Return false to stop further processing of the tag
948
949 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
950 $title: Title object ($wgTitle)
951 $request: WebRequest
952 $ignoreRedirect: boolean to skip redirect check
953 $target: Title/string of redirect target
954 $article: Article object
955
956 'InternalParseBeforeLinks': during Parser's internalParse method before links
957 but after noinclude/includeonly/onlyinclude and other processing.
958 &$parser: Parser object
959 &$text: string containing partially parsed text
960 &$stripState: Parser's internal StripState object
961
962 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
963 $user: user (object) whose email is being invalidated
964
965 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
966 $article: article (object) being checked
967
968 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
969 $ip: IP being check
970 $result: Change this value to override the result of wfIsTrustedProxy()
971
972 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
973 tance to return false if the domain name doesn't match your organization
974 $addr: The e-mail address entered by the user
975 &$result: Set this and return false to override the internal checks
976
977 'isValidPassword': Override the result of User::isValidPassword()
978 $password: The password entered by the user
979 &$result: Set this and return false to override the internal checks
980 $user: User the password is being validated for
981
982 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
983 $wgExtensionMessagesFiles instead.
984 Use this to define synonyms of magic words depending of the language
985 $magicExtensions: associative array of magic words synonyms
986 $lang: laguage code (string)
987
988 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
989 listed in $wgExtensionMessagesFiles instead.
990 Use to define aliases of special pages names depending of the language
991 $specialPageAliases: associative array of magic words synonyms
992 $lang: laguage code (string)
993
994 'LinkBegin': Used when generating internal and interwiki links in
995 Linker::link(), before processing starts. Return false to skip default proces-
996 sing and return $ret. See documentation for Linker::link() for details on the
997 expected meanings of parameters.
998 $skin: the Skin object
999 $target: the Title that the link is pointing to
1000 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
1001 fault"
1002 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1003 tive array form, with keys and values unescaped. Should be merged with de-
1004 fault values, with a value of false meaning to suppress the attribute.
1005 &$query: the query string to add to the generated URL (the bit after the "?"),
1006 in associative array form, with keys and values unescaped.
1007 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1008 &$ret: the value to return if your hook returns false.
1009
1010 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1011 just before the function returns a value. If you return true, an <a> element
1012 with HTML attributes $attribs and contents $text will be returned. If you re-
1013 turn false, $ret will be returned.
1014 $skin: the Skin object
1015 $target: the Title object that the link is pointing to
1016 $options: the options. Will always include either 'known' or 'broken', and may
1017 include 'noclasses'.
1018 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1019 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1020 ciative array form.
1021 &$ret: the value to return if your hook returns false.
1022
1023 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1024 before the return
1025 &$url: the image url
1026 &$alt: the image's alt text
1027 &$img: the new image HTML (if returning false)
1028
1029 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1030 before the return
1031 &$url: the link url
1032 &$text: the link text
1033 &$link: the new link HTML (if returning false)
1034 &$attribs: the attributes to be applied.
1035 $linkType: The external link type
1036
1037 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1038 actual update
1039 &$linksUpdate: the LinksUpdate object
1040
1041 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1042 completed
1043 &$linksUpdate: the LinksUpdate object
1044
1045 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1046 &$linksUpdate: the LinksUpdate object
1047
1048 'ListDefinedTags': When trying to find all defined tags.
1049 &$tags: The list of tags.
1050
1051 'LoadExtensionSchemaUpdates': called during database installation and updates
1052 &updater: A DatabaseUpdater subclass
1053
1054 'LocalFile::getHistory': called before file history query performed
1055 $file: the file
1056 $tables: tables
1057 $fields: select fields
1058 $conds: conditions
1059 $opts: query options
1060 $join_conds: JOIN conditions
1061
1062 'LocalisationCacheRecache': Called when loading the localisation data into cache
1063 $cache: The LocalisationCache object
1064 $code: language code
1065 &$alldata: The localisation data from core and extensions
1066
1067 'LoginAuthenticateAudit': a login attempt for a valid user account either
1068 succeeded or failed. No return data is accepted; this hook is for auditing only.
1069 $user: the User object being authenticated against
1070 $password: the password being submitted and found wanting
1071 $retval: a LoginForm class constant with authenticateUserData() return
1072 value (SUCCESS, WRONG_PASS, etc)
1073
1074 'LogLine': Processes a single log entry on Special:Log
1075 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1076 logging.log_type database field.
1077 $log_action: string for the type of log action (e.g. 'delete', 'block',
1078 'create2'). Corresponds to logging.log_action database field.
1079 $title: Title object that corresponds to logging.log_namespace and
1080 logging.log_title database fields.
1081 $paramArray: Array of parameters that corresponds to logging.log_params field.
1082 Note that only $paramArray[0] appears to contain anything.
1083 &$comment: string that corresponds to logging.log_comment database field, and
1084 which is displayed in the UI.
1085 &$revert: string that is displayed in the UI, similar to $comment.
1086 $time: timestamp of the log entry (added in 1.12)
1087
1088 'LogPageValidTypes': action being logged.
1089 DEPRECATED: Use $wgLogTypes
1090 &$type: array of strings
1091
1092 'LogPageLogName': name of the logging page(s).
1093 DEPRECATED: Use $wgLogNames
1094 &$typeText: array of strings
1095
1096 'LogPageLogHeader': strings used by wfMsg as a header.
1097 DEPRECATED: Use $wgLogHeaders
1098 &$headerText: array of strings
1099
1100 'LogPageActionText': strings used by wfMsg as a header.
1101 DEPRECATED: Use $wgLogActions
1102 &$actionText: array of strings
1103
1104 'MagicWordMagicWords': When defining new magic word.
1105 DEPRECATED: use $magicWords in a file listed in
1106 $wgExtensionMessagesFiles instead.
1107 $magicWords: array of strings
1108
1109 'MagicWordwgVariableIDs': When definig new magic words IDs.
1110 $variableIDs: array of strings
1111
1112 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1113 is executed
1114 &$vars: variable (or multiple variables) to be added into the output
1115 of Skin::makeVariablesScript
1116
1117 'MarkPatrolled': before an edit is marked patrolled
1118 $rcid: ID of the revision to be marked patrolled
1119 $user: the user (object) marking the revision as patrolled
1120 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1121 needs to be a sysop in order to mark an edit patrolled
1122
1123 'MarkPatrolledComplete': after an edit is marked patrolled
1124 $rcid: ID of the revision marked as patrolled
1125 $user: user (object) who marked the edit patrolled
1126 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1127 must be a sysop to patrol the edit
1128
1129 'MathAfterTexvc': after texvc is executed when rendering mathematics
1130 $mathRenderer: instance of MathRenderer
1131 $errmsg: error message, in HTML (string). Nonempty indicates failure
1132 of rendering the formula
1133
1134 'MediaWikiPerformAction': Override MediaWiki::performAction().
1135 Use this to do something completely different, after the basic
1136 globals have been set up, but before ordinary actions take place.
1137 $output: $wgOut
1138 $article: $wgArticle
1139 $title: $wgTitle
1140 $user: $wgUser
1141 $request: $wgRequest
1142 $mediaWiki: The $mediawiki object
1143
1144 'MessagesPreLoad': When loading a message from the database
1145 $title: title of the message (string)
1146 $message: value (string), change it to the message you want to define
1147
1148 'MessageCacheReplace': When a message page is changed.
1149 Useful for updating caches.
1150 $title: name of the page changed.
1151 $text: new contents of the page.
1152
1153 'ModifyExportQuery': Modify the query used by the exporter.
1154 $db: The database object to be queried.
1155 &$tables: Tables in the query.
1156 &$conds: Conditions in the query.
1157 &$opts: Options for the query.
1158 &$join_conds: Join conditions for the query.
1159
1160 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1161 been rendered (useful for adding more)
1162 Note: this is only run for the Monobook skin. This hook is deprecated and
1163 may be removed in the future. To add items to the toolbox you should use
1164 the SkinTemplateToolboxEnd hook instead, which works for all
1165 "SkinTemplate"-type skins.
1166 $tools: array of tools
1167
1168 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1169 and returning it for the skin to output. You can add items to the toolbox while
1170 still letting the skin make final decisions on skin-specific markup conventions
1171 using this hook.
1172 &$sk: The BaseTemplate base skin template
1173 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1174 BaseTemplate::makeListItem for details on the format of individual
1175 items inside of this array
1176
1177 'NewRevisionFromEditComplete': called when a revision was inserted
1178 due to an edit
1179 $article: the article edited
1180 $rev: the new revision
1181 $baseID: the revision ID this was based off, if any
1182 $user: the editing user
1183
1184 'NormalizeMessageKey': Called before the software gets the text of a message
1185 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1186 displayed
1187 &$key: the message being looked up. Change this to something else to change
1188 what message gets displayed (string)
1189 &$useDB: whether or not to look up the message in the database (bool)
1190 &$langCode: the language code to get the message for (string) - or -
1191 whether to use the content language (true) or site language (false) (bool)
1192 &$transform: whether or not to expand variables and templates
1193 in the message (bool)
1194
1195 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1196 &$changeslist: The OldChangesList instance.
1197 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1198 &$rc: The RecentChange object.
1199
1200 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1201 Hooks can alter or append to the array of URLs for search & suggestion formats.
1202 &$urls: array of associative arrays with Url element attributes
1203
1204 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1205 users and/or IP addresses too
1206 $otherBlockLink: An array with links to other block logs
1207 $ip: The requested IP address or username
1208
1209 'OutputPageBeforeHTML': a page has been processed by the parser and
1210 the resulting HTML is about to be displayed.
1211 $parserOutput: the parserOutput (object) that corresponds to the page
1212 $text: the text that will be displayed, in HTML (string)
1213
1214 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1215 tag to allow for extensions to add attributes to the body of the page they might
1216 need. Or to allow building extensions to add body classes that aren't of high
1217 enough demand to be included in core.
1218 $out: The OutputPage which called the hook, can be used to get the real title
1219 $sk: The Skin that called OutputPage::headElement
1220 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1221
1222 'OutputPageCheckLastModified': when checking if the page has been modified
1223 since the last visit
1224 &$modifiedTimes: array of timestamps.
1225 The following keys are set: page, user, epoch
1226
1227 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1228 $out: OutputPage instance (object)
1229 $parserOutput: parserOutput instance being added in $out
1230
1231 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1232 categories. Implementations should return false if they generate the category
1233 links, so the default link generation is skipped.
1234 $out: OutputPage instance (object)
1235 $categories: associative array, keys are category names, values are category
1236 types ("normal" or "hidden")
1237 $links: array, intended to hold the result. Must be an associative array with
1238 category types as keys and arrays of HTML links as values.
1239
1240 'PageHistoryBeforeList': When a history page list is about to be constructed.
1241 $article: the article that the history is loading for
1242
1243 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1244 $row: the revision row for this line
1245 $s: the string representing this parsed line
1246 $classes: array containing the <li> element classes
1247
1248 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1249 is constructed
1250 $pager: the pager
1251 $queryInfo: the query parameters
1252
1253 'PageRenderingHash': alter the parser cache option hash key
1254 A parser extension which depends on user options should install
1255 this hook and append its values to the key.
1256 $hash: reference to a hash key string which can be modified
1257
1258 'ParserAfterStrip': Same as ParserBeforeStrip
1259
1260 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1261 $parser: Parser object being used
1262 $text: text that'll be returned
1263
1264 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1265 $parser: Parser object
1266 $text: text to parse
1267 $stripState: StripState instance being used
1268
1269 'ParserBeforeStrip': Called at start of parsing time
1270 (no more strip, deprecated ?)
1271 $parser: parser object
1272 $text: text being parsed
1273 $stripState: stripState used (object)
1274
1275 'ParserBeforeTidy': called before tidy and custom tags replacements
1276 $parser: Parser object being used
1277 $text: actual text
1278
1279 'ParserClearState': called at the end of Parser::clearState()
1280 $parser: Parser object being cleared
1281
1282 'ParserFirstCallInit': called when the parser initialises for the first time
1283 &$parser: Parser object being cleared
1284
1285 'ParserGetVariableValueSwitch': called when the parser need the value of a
1286 custom magic word
1287 $parser: Parser object
1288 $varCache: array to store the value in case of multiples calls of the
1289 same magic word
1290 $index: index (string) of the magic
1291 $ret: value of the magic word (the hook should set it)
1292 $frame: PPFrame object to use for expanding any template variables
1293
1294 'ParserGetVariableValueTs': use this to change the value of the time for the
1295 {{LOCAL...}} magic word
1296 $parser: Parser object
1297 $time: actual time (timestamp)
1298
1299 'ParserGetVariableValueVarCache': use this to change the value of the
1300 variable cache or return false to not use it
1301 $parser: Parser object
1302 $varCache: varaiable cache (array)
1303
1304 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1305 include comments about size of the text parsed
1306 $parser: Parser object
1307 $limitReport: text that will be included (without comment tags)
1308
1309 'ParserMakeImageParams': Called before the parser make an image link, use this
1310 to modify the parameters of the image.
1311 $title: title object representing the file
1312 $file: file object that will be used to create the image
1313 &$params: 2-D array of parameters
1314
1315 'ParserTestParser': called when creating a new instance of Parser in
1316 maintenance/parserTests.inc
1317 $parser: Parser object created
1318
1319 'ParserTestTables': alter the list of tables to duplicate when parser tests
1320 are run. Use when page save hooks require the presence of custom tables
1321 to ensure that tests continue to run properly.
1322 &$tables: array of table names
1323
1324 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1325 my talk page, my contributions" etc).
1326
1327 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1328 &$title: Title object representing the current page
1329
1330 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1331 &$user : User performing the action
1332 $action : Action being performed
1333 &$result : Whether or not the action should be prevented
1334 Change $result and return false to give a definitive answer, otherwise
1335 the built-in rate limiting checks are used, if enabled.
1336
1337 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1338 AJAX search suggestions. Put results into &$results outparam and return false.
1339 $ns : array of int namespace keys to search in
1340 $search : search term (not guaranteed to be conveniently normalized)
1341 $limit : maximum number of results to return
1342 &$results : out param: array of page names (strings)
1343
1344 'PrefsEmailAudit': called when user changes his email address
1345 $user: User (object) changing his email address
1346 $oldaddr: old email address (string)
1347 $newaddr: new email address (string)
1348
1349 'PrefsPasswordAudit': called when user changes his password
1350 $user: User (object) changing his passoword
1351 $newPass: new password
1352 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1353
1354 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1355 $article: the title being (un)protected
1356 $output: a string of the form HTML so far
1357
1358 'ProtectionForm::save': called when a protection form is submitted
1359 $article: the title being (un)protected
1360 $errorMsg: an html message string of an error
1361
1362 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1363 $article: the page the form is shown for
1364 $out: OutputPage object
1365
1366 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1367 loader request or generating HTML output.
1368 &$resourceLoader: ResourceLoader object
1369
1370 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1371 &$obj: RawPage object
1372 &$text: The text that's going to be the output
1373
1374 'RecentChange_save': called at the end of RecenChange::save()
1375 $recentChange: RecentChange object
1376
1377 'RevisionInsertComplete': called after a revision is inserted into the DB
1378 &$revision: the Revision
1379 $data: the data stored in old_text. The meaning depends on $flags: if external
1380 is set, it's the URL of the revision text in external storage; otherwise,
1381 it's the revision text itself. In either case, if gzip is set, the revision
1382 text is gzipped.
1383 $flags: a comma-delimited list of strings representing the options used. May
1384 include: utf8 (this will always be set for new revisions); gzip; external.
1385
1386 'SearchUpdate': Prior to search update completion
1387 $id : Page id
1388 $namespace : Page namespace
1389 $title : Page title
1390 $text : Current text being indexed
1391
1392 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1393 $allSearchTerms : Array of the search terms in all content languages
1394 &$titleResult : Outparam; the value to return. A Title object or null.
1395
1396 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1397 $term : Search term string
1398 &$title : Outparam; set to $title object and return false for a match
1399
1400 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1401 $term : Search term string
1402 &$title : Current Title object that is being returned (null if none found).
1403
1404 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1405 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1406 in the $searchEngine->namespaces array.
1407 $query : Original query.
1408 &$parsed : Resultant query with the prefixes stripped.
1409
1410 'SearchableNamespaces': An option to modify which namespaces are searchable.
1411 &$arr : Array of namespaces ($nsId => $name) which will be used.
1412
1413 'SetupAfterCache': Called in Setup.php, after cache objects are set
1414
1415 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1416 anything has been posted to the article.
1417 $user: The user who we left the message for.
1418 &$article: The article that will be posted to.
1419 $subject: The subject of the message
1420 $text: The text of the message.
1421 $signature: The signature we used.
1422 $summary: The edit summary.
1423 $editor: The editor that performed the edit.
1424
1425 'ShowMissingArticle': Called when generating the output for a non-existent page
1426 $article: The article object corresponding to the page
1427
1428 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1429 $text: Text being shown
1430 $title: Title of the custom script/stylesheet page
1431 $output: Current OutputPage object
1432
1433 'ShowSearchHitTitle': Customise display of search hit title/link.
1434 &$title: Title to link to
1435 &$text: Text to use for the link
1436 $result: The search result
1437 $terms: The search terms entered
1438 $page: The SpecialSearch object.
1439
1440 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1441 &$siteNotice: HTML returned as the sitenotice
1442 Return true to allow the normal method of notice selection/rendering to work,
1443 or change the value of $siteNotice and return false to alter it.
1444
1445 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1446 &$siteNotice: HTML sitenotice
1447 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1448
1449 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1450 $skin: Skin object
1451 &$text: bottomScripts Text
1452 Append to $text to add additional text/scripts after the stock bottom scripts.
1453
1454 'SkinAfterContent': Allows extensions to add text after the page content and
1455 article metadata.
1456 &$data: (string) Text to be printed out directly (without parsing)
1457 $skin: Skin object
1458 This hook should work in all skins. Just set the &$data variable to the text
1459 you're going to add.
1460
1461 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1462 $skin: Skin object
1463 &$bar: Sidebar contents
1464 Modify $bar to add or modify sidebar portlets.
1465
1466 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1467 $title: displayed page title
1468 $type: 'normal' or 'history' for old/diff views
1469 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1470 &$link: overridable HTML link to be passed into the message as $1
1471 &$forContent: overridable flag if copyright footer is shown in content language.
1472
1473 'SkinGetPoweredBy'
1474 &$text: additional 'powered by' icons in HTML.
1475 Note: Modern skin does not use the MediaWiki icon but plain text instead
1476 $skin: Skin object
1477
1478 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1479 &$subpages: Subpage links HTML
1480 $skin: Skin object
1481 If false is returned $subpages will be used instead of the HTML
1482 subPageSubtitle() generates.
1483 If true is returned, $subpages will be ignored and the rest of
1484 subPageSubtitle() will run.
1485
1486 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1487 when showing a special page
1488 $sktemplate: SkinTemplate object
1489 $content_actions: array of tabs
1490
1491 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1492 "permanent link" tab
1493 $sktemplate: SkinTemplate object
1494 $nav_urls: array of tabs
1495
1496 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1497 &$content_actions: Content actions
1498 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1499 for an example]
1500
1501 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1502 &$sktemplate: SkinTemplate object
1503 &$links: Structured navigation links
1504 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1505
1506 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1507 starts page output
1508 &$sktemplate: SkinTemplate object
1509 &$tpl: Template engine object
1510
1511 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1512 $sktemplate: SkinTemplate object
1513 $res: set to true to prevent active tabs
1514
1515 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1516 $out: Css to return
1517
1518 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1519 You can either create your own array, or alter the parameters for
1520 the normal one.
1521 &$sktemplate: The SkinTemplate instance.
1522 $title: Title instance for the page.
1523 $message: Visible label of tab.
1524 $selected: Whether this is a selected tab.
1525 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1526 &$classes: Array of CSS classes to apply.
1527 &$query: Query string to add to link.
1528 &$text: Link text.
1529 &$result: Complete assoc. array if you want to return true.
1530
1531 'SkinTemplateTabs': called when finished to build the actions tabs
1532 $sktemplate: SkinTemplate object
1533 $content_actions: array of tabs
1534
1535 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1536 been rendered (useful for adding more)
1537 $tools: array of tools
1538
1539 'SoftwareInfo': Called by Special:Version for returning information about
1540 the software
1541 $software: The array of software in format 'name' => 'version'.
1542 See SpecialVersion::softwareInformation()
1543
1544 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1545 $id: User identifier
1546
1547 'SpecialListusersDefaultQuery': called right before the end of
1548 UsersPager::getDefaultQuery()
1549 $pager: The UsersPager instance
1550 $query: The query array to be returned
1551
1552 'SpecialListusersFormatRow': called right before the end of
1553 UsersPager::formatRow()
1554 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1555 $row: Database row object
1556
1557 'SpecialListusersHeader': called before closing the <fieldset> in
1558 UsersPager::getPageHeader()
1559 $pager: The UsersPager instance
1560 $out: The header HTML
1561
1562 'SpecialListusersHeaderForm': called before adding the submit button in
1563 UsersPager::getPageHeader()
1564 $pager: The UsersPager instance
1565 $out: The header HTML
1566
1567 'SpecialListusersQueryInfo': called right before the end of
1568 UsersPager::getQueryInfo()
1569 $pager: The UsersPager instance
1570 $query: The query array to be returned
1571
1572 'SpecialMovepageAfterMove': called after moving a page
1573 $movePage: MovePageForm object
1574 $oldTitle: old title (object)
1575 $newTitle: new title (object)
1576
1577 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1578 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1579 $opts: FormOptions object containing special page options
1580 &$conds: array of WHERE conditionals for query
1581
1582 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1583 hook to remove a core special page
1584 $list: list (array) of core special pages
1585
1586 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1587 use this to change some selection criteria or substitute a different title
1588 &$randstr: The random number from wfRandom()
1589 &$isRedir: Boolean, whether to select a redirect or non-redirect
1590 &$namespaces: An array of namespace indexes to get the title from
1591 &$extra: An array of extra SQL statements
1592 &$title: If the hook returns false, a Title object to use instead of the
1593 result from the normal query
1594
1595 'SpecialRecentChangesPanel': called when building form options in
1596 SpecialRecentChanges
1597 &$extraOpts: array of added items, to which can be added
1598 $opts: FormOptions for this request
1599
1600 'SpecialRecentChangesQuery': called when building sql query for
1601 SpecialRecentChanges and SpecialRecentChangesLinked
1602 &$conds: array of WHERE conditionals for query
1603 &$tables: array of tables to be queried
1604 &$join_conds: join conditions for the tables
1605 $opts: FormOptions for this request
1606 &$query_options: array of options for the database request
1607 &$select: String '*' or array of columns to select
1608
1609 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1610 exists
1611 &$title: title object generated from the text entred by the user
1612
1613 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1614 target doesn't exist
1615 &$title: title object generated from the text entred by the user
1616
1617 'SpecialSearchProfiles': allows modification of search profiles
1618 &$profiles: profiles, which can be modified.
1619
1620 'SpecialSearchResults': called before search result display when there
1621 are matches
1622 $term: string of search term
1623 &$titleMatches: empty or SearchResultSet object
1624 &$textMatches: empty or SearchResultSet object
1625
1626 'SpecialSearchNoResults': called before search result display when there are
1627 no matches
1628 $term: string of search term
1629
1630 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1631 &$extraStats: Array to save the new stats
1632 ( $extraStats['<name of statistic>'] => <value>; )
1633
1634 'SpecialUploadComplete': Called after successfully uploading a file from
1635 Special:Upload
1636 $form: The SpecialUpload object
1637
1638 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1639 use this to change the tables headers
1640 $extTypes: associative array of extensions types
1641
1642 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1643 &$conds: array of WHERE conditionals for query
1644 &$tables: array of tables to be queried
1645 &$join_conds: join conditions for the tables
1646 &$fields: array of query fields
1647
1648 'TitleArrayFromResult': called when creating an TitleArray object from a
1649 database result
1650 &$titleArray: set this to an object to override the default object returned
1651 $res: database result used to create the object
1652
1653 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1654 that can be applied.
1655 $title: The title in question.
1656 &$types: The types of protection available.
1657
1658 'TitleMoveComplete': after moving an article (title)
1659 $old: old title
1660 $nt: new title
1661 $user: user who did the move
1662 $pageid: database ID of the page that's been moved
1663 $redirid: database ID of the created redirect
1664
1665 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1666 $title: title object related to the revision
1667 $rev: revision (object) that will be viewed
1668
1669 'UnknownAction': An unknown "action" has occured (useful for defining
1670 your own actions)
1671 $action: action name
1672 $article: article "acted on"
1673
1674 'UnitTestsList': Called when building a list of files with PHPUnit tests
1675 &$files: list of files
1676
1677 'UnwatchArticle': before a watch is removed from an article
1678 $user: user watching
1679 $article: article object to be removed
1680
1681 'UnwatchArticle': after a watch is removed from an article
1682 $user: user that was watching
1683 $article: article object removed
1684
1685 'UnwatchArticleComplete': after a watch is removed from an article
1686 $user: user that watched
1687 $article: article object that was watched
1688
1689 'UploadForm:initial': before the upload form is generated
1690 $form: UploadForm object
1691 You might set the member-variables $uploadFormTextTop and
1692 $uploadFormTextAfterSummary to inject text (HTML) either before
1693 or after the editform.
1694
1695 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1696 $form: UploadForm object
1697 Lets you poke at member variables like $mUploadDescription before the
1698 file is saved.
1699 Do not use this hook to break upload processing. This will return the user to
1700 a blank form with no error message; use UploadVerification and
1701 UploadVerifyFile instead
1702
1703 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1704 $type: (string) the requested upload type
1705 &$className: the class name of the Upload instance to be created
1706
1707 'UploadComplete': when Upload completes an upload
1708 &$upload: an UploadBase child instance
1709
1710 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1711 assembled
1712 $descriptor: (array) the HTMLForm descriptor
1713
1714 'UploadFormSourceDescriptors': after the standard source inputs have been
1715 added to the descriptor
1716 $descriptor: (array) the HTMLForm descriptor
1717
1718 'UploadVerification': additional chances to reject an uploaded file. Consider
1719 using UploadVerifyFile instead.
1720 string $saveName: destination file name
1721 string $tempName: filesystem path to the temporary file for checks
1722 string &$error: output: message key for message to show if upload canceled
1723 by returning false. May also be an array, where the first element
1724 is the message key and the remaining elements are used as parameters to
1725 the message.
1726
1727 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1728 in most cases over UploadVerification.
1729 object $upload: an instance of UploadBase, with all info about the upload
1730 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1731 will typically only apply for specific mime types.
1732 object &$error: output: true if the file is valid. Otherwise, an indexed array
1733 representing the problem with the file, where the first element
1734 is the message key and the remaining elements are used as parameters to
1735 the message.
1736
1737 'UploadComplete': Upon completion of a file upload
1738 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1739 $uploadBase->getLocalFile().
1740
1741 'User::mailPasswordInternal': before creation and mailing of a user's new
1742 temporary password
1743 $user: the user who sent the message out
1744 $ip: IP of the user who sent the message out
1745 $u: the account whose new password will be set
1746
1747 'UserArrayFromResult': called when creating an UserArray object from a
1748 database result
1749 &$userArray: set this to an object to override the default object returned
1750 $res: database result used to create the object
1751
1752 'userCan': To interrupt/advise the "user can do X to Y article" check.
1753 If you want to display an error message, try getUserPermissionsErrors.
1754 $title: Title object being checked against
1755 $user : Current user object
1756 $action: Action being checked
1757 $result: Pointer to result returned if hook returns false. If null is returned,
1758 userCan checks are continued by internal code.
1759
1760 'UserCanSendEmail': To override User::canSendEmail() permission check
1761 $user: User (object) whose permission is being checked
1762 &$canSend: bool set on input, can override on output
1763
1764 'UserClearNewTalkNotification': called when clearing the
1765 "You have new messages!" message, return false to not delete it
1766 $user: User (object) that'll clear the message
1767
1768 'UserComparePasswords': called when checking passwords, return false to
1769 override the default password checks
1770 &$hash: String of the password hash (from the database)
1771 &$password: String of the plaintext password the user entered
1772 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1773 supplied
1774 &$result: If the hook returns false, this Boolean value will be checked to
1775 determine if the password was valid
1776
1777 'UserCreateForm': change to manipulate the login form
1778 $template: SimpleTemplate instance for the form
1779
1780 'UserCryptPassword': called when hashing a password, return false to implement
1781 your own hashing method
1782 &$password: String of the plaintext password to encrypt
1783 &$salt: String of the password salt or Boolean false if no salt is provided
1784 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1785 hashing method
1786 &$hash: If the hook returns false, this String will be used as the hash
1787
1788 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1789 $user: User to get groups for
1790 &$groups: Current effective groups
1791
1792 'UserGetAllRights': after calculating a list of all available rights
1793 &$rights: Array of rights, which may be added to.
1794
1795 'UserGetEmail': called when getting an user email address
1796 $user: User object
1797 &$email: email, change this to override local email
1798
1799 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1800 email authentification
1801 $user: User object
1802 &$timestamp: timestamp, change this to override local email authentification
1803 timestamp
1804
1805 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1806 &$groups: List of implicit (automatically-assigned) groups
1807
1808 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1809 &$reservedUsernames: $wgReservedUsernames
1810
1811 'UserGetRights': Called in User::getRights()
1812 $user: User to get rights for
1813 &$rights: Current rights
1814
1815 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1816 exemptions).
1817 $user: User in question
1818 $title: Title of the page in question
1819 &$blocked: Out-param, whether or not the user is blocked from that page.
1820 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1821 own user talk pages.
1822
1823 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1824 &$user: User object
1825 $ip: User's IP address
1826 &$blocked: Whether the user is blocked, to be modified by the hook
1827
1828 'UserLoadAfterLoadFromSession': called to authenticate users on
1829 external/environmental means; occurs after session is loaded
1830 $user: user object being loaded
1831
1832 'UserLoadDefaults': called when loading a default user
1833 $user: user object
1834 $name: user name
1835
1836 'UserLoadFromDatabase': called when loading a user from the database
1837 $user: user object
1838 &$s: database query object
1839
1840 'UserLoadFromSession': called to authenticate users on external/environmental
1841 means; occurs before session is loaded
1842 $user: user object being loaded
1843 &$result: set this to a boolean value to abort the normal authentification
1844 process
1845
1846 'UserLoadOptions': when user options/preferences are being loaded from
1847 the database.
1848 $user: User object
1849 &$options: Options, can be modified.
1850
1851 'UserLoginComplete': after a user has logged in
1852 $user: the user object that was created on login
1853 $inject_html: Any HTML to inject after the "logged in" message.
1854
1855 'UserLoginForm': change to manipulate the login form
1856 $template: SimpleTemplate instance for the form
1857
1858 'UserLoginMailPassword': Block users from emailing passwords
1859 $name: the username to email the password of.
1860 &$error: out-param - the error message to return.
1861
1862 'UserLogout': before a user logs out
1863 $user: the user object that is about to be logged out
1864
1865 'UserLogoutComplete': after a user has logged out
1866 $user: the user object _after_ logout (won't have name, ID, etc.)
1867 $inject_html: Any HTML to inject after the "logged out" message.
1868 $oldName: name of the user before logout (string)
1869
1870 'UserRights': After a user's group memberships are changed
1871 $user : User object that was changed
1872 $add : Array of strings corresponding to groups added
1873 $remove: Array of strings corresponding to groups removed
1874
1875 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1876 message(s)
1877 $user: user retrieving new talks messages
1878 $talks: array of new talks page(s)
1879
1880 'UserSaveSettings': called when saving user settings
1881 $user: User object
1882
1883 'UserSaveOptions': Called just before saving user preferences/options.
1884 $user: User object
1885 &$options: Options, modifiable
1886
1887 'UserSetCookies': called when setting user cookies
1888 $user: User object
1889 &$session: session array, will be added to $_SESSION
1890 &$cookies: cookies array mapping cookie name to its value
1891
1892 'UserSetEmail': called when changing user email address
1893 $user: User object
1894 &$email: new email, change this to override new email address
1895
1896 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1897 of email authentification
1898 $user: User object
1899 &$timestamp: new timestamp, change this to override local email
1900 authentification timestamp
1901
1902 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1903 alter the SQL query which gets the list of wanted pages
1904 &$wantedPages: WantedPagesPage object
1905 &$sql: raw SQL query used to get the list of wanted pages
1906
1907 'WatchArticle': before a watch is added to an article
1908 $user: user that will watch
1909 $article: article object to be watched
1910
1911 'WatchArticleComplete': after a watch is added to an article
1912 $user: user that watched
1913 $article: article object watched
1914
1915 'WatchlistEditorBuildRemoveLine': when building remove lines in
1916 Special:Watchlist/edit
1917 &$tools: array of extra links
1918 $title: Title object
1919 $redirect: whether the page is a redirect
1920 $skin: Skin object
1921
1922 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1923 dumps
1924 One, and only one hook should set this, and return false.
1925 &$tables: Database tables to use in the SELECT query
1926 &$opts: Options to use for the query
1927 &$join: Join conditions
1928
1929 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1930 query pages to be updated with maintenance/updateSpecialPages.php
1931 $query: $wgQueryPages itself
1932
1933 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1934 metadata to be added.
1935 $obj: The XmlDumpWriter object.
1936 &$out: The output string.
1937 $row: The database row for the page.
1938 $title: The title of the page.
1939
1940 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1941 metadata.
1942 $obj: The XmlDumpWriter object.
1943 &$out: The text being output.
1944 $row: The database row for the revision.
1945 $text: The revision text.
1946
1947 More hooks might be available but undocumented, you can execute
1948 ./maintenance/findhooks.php to find hidden one.