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