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