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