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