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