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