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