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