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