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