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