Merge "Minor CSS cleanup for Vector and Monobook skins"
[mediawiki.git] / docs / hooks.txt
blob2cde5919421d84b14b7defdf748a1401cbc980ec
1 hooks.txt
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.
6 ==Glossary==
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'.
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.
20 hook function
21      The function part of a hook.
23 ==Rationale==
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.
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):
37         function showAnArticle($article) {
38                 global $wgReverseTitle, $wgCapitalizeTitle;
40                 if ($wgReverseTitle) {
41                         wfReverseTitle($article);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
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:
55     function showAnArticle($article) {
56         global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58                 if ($wgReverseTitle) {
59                         wfReverseTitle($article);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
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:
76         function showAnArticle($article) {
78                 if (wfRunHooks('ArticleShow', array(&$article))) {
80                         # code to actually show the article goes here
82                         wfRunHooks('ArticleShowComplete', array(&$article));
83                 }
84         }
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.
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:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
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.
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:
123         require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
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.
131 ==Writing hooks==
133 A hook is a chunk of code run at some particular event. It consists of:
135   * a function with some optional accompanying data, or
136   * an object with a method and some optional accompanying data.
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:
141         $wgHooks['EventName'][] = 'someFunction'; # function, no data
142         $wgHooks['EventName'][] = array('someFunction', $someData);
143         $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
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
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:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
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)
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.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
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
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:
191         $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193         function ldapLogin($username, $password) {
194                 # log user into LDAP
195                 return false;
196         }
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
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.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
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         }
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.
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.
232 ==Events and parameters==
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.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
239 a local account.
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
254 'AbortLogin': Return false to cancel account login.
255 $user: the User object being authenticated against
256 $password: the password being submitted, not yet checked for validity
257 &$retval: a LoginForm class constant to return from authenticateUserData();
258           default is LoginForm::ABORTED. Note that the client may be using
259           a machine API rather than the HTML user interface.
260 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
262 'AbortMove': Allows to abort moving an article (title).
263 $old: old title
264 $nt: new title
265 $user: user who is doing the move
266 $err: error message
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
273 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
274 $name: name of the action
275 &$form: HTMLForm object
276 $article: Article object
278 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
279 Allows to change the fields on the form that will be generated.
280 $name: name of the action
281 &$fields: HTMLForm descriptor array
282 $article: Article object
284 'AddNewAccount': After a user account is created.
285 $user: the User object that was created. (Parameter added in 1.7)
286 $byEmail: true when account was created "by email" (added in 1.12)
288 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
289 ob_end_flush() which will send the buffered output to the client. This allows
290 for last-minute modification of the output within the buffer by using
291 ob_get_clean().
292 &$output: OutputPage object
294 'AfterImportPage': When a page import is completed.
295 $title: Title under which the revisions were imported
296 $origTitle: Title provided by the XML file
297 $revCount: Number of revisions in the XML file
298 $sRevCount: Number of successfully imported revisions
299 $pageInfo: associative array of page information
301 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
302 before OutputPage::sendCacheControl() and final ob_end_flush() which
303 will send the buffered output to the client. This allows for last-minute
304 modification of the output within the buffer by using ob_get_clean().
305 $output: The OutputPage object where output() was called
307 'AjaxAddScript': Called in output page just before the initialisation
308 of the javascript ajax engine. The hook is only called when ajax
309 is enabled ( $wgUseAjax = true; ).
310 &$output: OutputPage object
312 'AlternateEdit': Before checking if a user can edit a page and before showing
313 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
314 $editPage: the EditPage object
316 'AlternateEditPreview': Before generating the preview of the page when editing
317 ( EditPage::getPreviewText() ).
318 $editPage: the EditPage object
319 &$content: the Content object for the text field from the edit page
320 &$previewHTML: Text to be placed into the page for the preview
321 &$parserOutput: the ParserOutput object for the preview
322 return false and set $previewHTML and $parserOutput to output custom page
323 preview HTML.
325 'AlternateUserMailer': Called before mail is sent so that mail could be logged
326 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
327 the regular method of sending mail.  Return a string to return a php-mail-error
328 message containing the error. Returning true will continue with sending email
329 in the regular way.
330 $headers: Associative array of headers for the email
331 $to: MailAddress object or array
332 $from: From address
333 $subject: Subject of the email
334 $body: Body of the message
336 'APIAfterExecute': After calling the execute() method of an API module. Use
337 this to extend core API modules.
338 &$module: Module object
340 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
341 authenticate and authorize API clients before executing the module. Return
342 false and set a message to cancel the request.
343 $module: Module object
344 $user: Current user
345 &$message: API usage message to die with, as a message key or array
346 as accepted by ApiBase::dieUsageMsg.
348 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
349 processing request parameters. Return false to let the request fail, returning
350 an error message or an <edit result="Failure"> tag if $resultArr was filled.
351 $editPage : the EditPage object
352 $text : the new text of the article (has yet to be saved)
353 &$resultArr : data in this array will be added to the API result
355 'APIGetAllowedParams': Use this hook to modify a module's parameters.
356 &$module: ApiBase Module object
357 &$params: Array of parameters
358 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
360 'APIGetDescription': Use this hook to modify a module's description.
361 &$module: ApiBase Module object
362 &$desc: Array of descriptions
364 'APIGetParamDescription': Use this hook to modify a module's parameter
365 descriptions.
366 &$module: ApiBase Module object
367 &$desc: Array of parameter descriptions
369 'APIGetResultProperties': Use this hook to modify the properties in a module's
370 result.
371 &$module: ApiBase Module object
372 &$properties: Array of properties
374 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
375 errors.
376 $module: ApiBase Module object
377 &$possibleErrors: Array of possible errors
379 'APIQueryAfterExecute': After calling the execute() method of an
380 action=query submodule. Use this to extend core API modules.
381 &$module: Module object
383 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
384 an action=query submodule. Use this to extend core API modules.
385 &$module: Module object
386 &$resultPageSet: ApiPageSet object
388 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
389 token has an action, which will be used in the intoken parameter and in the
390 output (actiontoken="..."), and a callback function which should return the
391 token, or false if the user isn't allowed to obtain it. The prototype of the
392 callback function is func($pageid, $title), where $pageid is the page ID of the
393 page the token is requested for and $title is the associated Title object. In
394 the hook, just add your callback to the $tokenFunctions array and return true
395 (returning false makes no sense).
396 $tokenFunctions: array(action => callback)
398 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
399 Every token has an action, which will be used in the rvtoken parameter and in
400 the output (actiontoken="..."), and a callback function which should return the
401 token, or false if the user isn't allowed to obtain it. The prototype of the
402 callback function is func($pageid, $title, $rev), where $pageid is the page ID
403 of the page associated to the revision the token is requested for, $title the
404 associated Title object and $rev the associated Revision object. In the hook,
405 just add your callback to the $tokenFunctions array and return true (returning
406 false makes no sense).
407 $tokenFunctions: array(action => callback)
409 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
410 list=recentchanges. Every token has an action, which will be used in the rctoken
411 parameter and in the output (actiontoken="..."), and a callback function which
412 should return the token, or false if the user isn't allowed to obtain it. The
413 prototype of the callback function is func($pageid, $title, $rc), where $pageid
414 is the page ID of the page associated to the revision the token is requested
415 for, $title the associated Title object and $rc the associated RecentChange
416 object. In the hook, just add your callback to the $tokenFunctions array and
417 return true (returning false makes no sense).
418 $tokenFunctions: array(action => callback)
420 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
421 sites general information.
422 $module: the current ApiQuerySiteInfo module
423 &$results: array of results, add things here
425 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
426 token has an action, which will be used in the ustoken parameter and in the
427 output (actiontoken="..."), and a callback function which should return the
428 token, or false if the user isn't allowed to obtain it. The prototype of the
429 callback function is func($user) where $user is the User object. In the hook,
430 just add your callback to the $tokenFunctions array and return true (returning
431 false makes no sense).
432 $tokenFunctions: array(action => callback)
434 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
435 an exception is thrown during API action execution.
436 $apiMain: Calling ApiMain instance.
437 $e: Exception object.
439 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
440 should have its own entry in the $apis array and have a unique name, passed as
441 key for the array that represents the service data. In this data array, the
442 key-value-pair identified by the apiLink key is required.
443 &$apis: array of services
445 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
446 types.
447 &$tokenTypes: supported token types in format 'type' => callback function
448 used to retrieve this type of tokens.
450 'ArticleAfterFetchContent': After fetching content of an article from the
451 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
452 $article: the article (object) being loaded from the database
453 &$content: the content (string) of the article
455 'ArticleAfterFetchContentObject': After fetching content of an article from the
456 database.
457 $article: the article (object) being loaded from the database
458 &$content: the content of the article, as a Content object
460 'ArticleConfirmDelete': Before writing the confirmation form for article
461 deletion.
462 $article: the article (object) being deleted
463 $output: the OutputPage object
464 &$reason: the reason (string) the article is being deleted
466 'ArticleContentOnDiff': Before showing the article content below a diff. Use
467 this to change the content in this area or how it is loaded.
468 $diffEngine: the DifferenceEngine
469 $output: the OutputPage object
471 'ArticleDelete': Before an article is deleted.
472 $wikiPage: the WikiPage (object) being deleted
473 $user: the user (object) deleting the article
474 $reason: the reason (string) the article is being deleted
475 $error: if the deletion was prohibited, the (raw HTML) error message to display
476   (added in 1.13)
477 $status: Status object, modify this to throw an error. Overridden by $error
478   (added in 1.20)
480 'ArticleDeleteComplete': After an article is deleted.
481 $wikiPage: the WikiPage that was deleted
482 $user: the user that deleted the article
483 $reason: the reason the article was deleted
484 $id: id of the article that was deleted
485 $content: the Content of the deleted page
486 $logEntry: the ManualLogEntry used to record the deletion
488 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
489 was changed.
490 &$wikiPage: WikiPage (object) of the user talk page
491 $recipient: User (object) who's talk page was edited
493 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
494 article has been changed.
495 $wikiPage: the WikiPage (object)
496 $editInfo: data holder that includes the parser output ($editInfo->output) for
497 that page after the change
498 $changed: bool for if the page was changed
500 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
501 recentchanges table, return false to not delete old entries.
502 $wikiPage: WikiPage (object) being modified
504 'ArticleFromTitle': when creating an article object from a title object using
505 Wiki::articleFromTitle().
506 $title: Title (object) used to create the article object
507 $article: Article (object) that will be returned
509 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
510 PageContentInsertComplete.
511 $wikiPage: WikiPage created
512 $user: User creating the article
513 $text: New content
514 $summary: Edit summary/comment
515 $isMinor: Whether or not the edit was marked as minor
516 $isWatch: (No longer used)
517 $section: (No longer used)
518 $flags: Flags passed to WikiPage::doEditContent()
519 $revision: New Revision of the article
521 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
522 $targetTitle: target title (object)
523 $destTitle: destination title (object)
525 'ArticlePageDataAfter': After loading data of an article from the database.
526 $wikiPage: WikiPage (object) whose data were loaded
527 $row: row (object) returned from the database server
529 'ArticlePageDataBefore': Before loading data of an article from the database.
530 $wikiPage: WikiPage (object) that data will be loaded
531 $fields: fields (array) to load from the database
533 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
534 $wikiPage: the WikiPage being saved
535 $popts: parser options to be used for pre-save transformation
537 'ArticleProtect': Before an article is protected.
538 $wikiPage: the WikiPage being protected
539 $user: the user doing the protection
540 $protect: boolean whether this is a protect or an unprotect
541 $reason: Reason for protect
542 $moveonly: boolean whether this is for move only or not
544 'ArticleProtectComplete': After an article is protected.
545 $wikiPage: the WikiPage that was protected
546 $user: the user who did the protection
547 $protect: boolean whether it was a protect or an unprotect
548 $reason: Reason for protect
549 $moveonly: boolean whether it was for move only or not
551 'ArticlePurge': Before executing "&action=purge".
552 $wikiPage: WikiPage (object) to purge
554 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
555 revisions of an article.
556 &$title: Title object of the article
558 'ArticleRevisionUndeleted': After an article revision is restored.
559 $title: the article title
560 $revision: the revision
561 $oldPageID: the page ID of the revision when archived (may be null)
563 'ArticleRollbackComplete': After an article rollback is completed.
564 $wikiPage: the WikiPage that was edited
565 $user: the user who did the rollback
566 $revision: the revision the page was reverted back to
567 $current: the reverted revision
569 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
570 instead.
571 $wikiPage: the WikiPage (object) being saved
572 $user: the user (object) saving the article
573 $text: the new article text
574 $summary: the article summary (comment)
575 $isminor: minor flag
576 $iswatch: watch flag
577 $section: section #
579 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
580 PageContentSaveComplete instead.
581 $wikiPage: WikiPage modified
582 $user: User performing the modification
583 $text: New content
584 $summary: Edit summary/comment
585 $isMinor: Whether or not the edit was marked as minor
586 $isWatch: (No longer used)
587 $section: (No longer used)
588 $flags: Flags passed to WikiPage::doEditContent()
589 $revision: New Revision of the article
590 $status: Status object about to be returned by doEditContent()
591 $baseRevId: the rev ID (or false) this edit was based on
593 'ArticleUndelete': When one or more revisions of an article are restored.
594 $title: Title corresponding to the article restored
595 $create: Whether or not the restoration caused the page to be created (i.e. it
596   didn't exist before).
597 $comment: The comment associated with the undeletion.
599 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
600 $pageArchive: the PageArchive object
601 &$logEntry: ManualLogEntry object
602 $user: User who is performing the log action
604 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
605 the user is redirected back to the page.
606 &$article: the article
607 &$sectionanchor: The section anchor link (e.g. "#overview" )
608 &$extraq: Extra query parameters which can be added via hooked functions
610 'ArticleViewFooter': After showing the footer section of an ordinary page view
611 $article: Article object
613 'ArticleViewHeader': Before the parser cache is about to be tried for article
614 viewing.
615 &$article: the article
616 &$pcache: whether to try the parser cache or not
617 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
618 object to both indicate that the output is done and what parser output was used.
620 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
621 redirect was followed.
622 $article: target article (object)
624 'ArticleViewCustom': Allows to output the text of the article in a different
625 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
626 that it is preferable to implement proper handing for a custom data type using
627 the ContentHandler facility.
628 $text: text of the page
629 $title: title of the page
630 $output: reference to $wgOut
632 'ArticleContentViewCustom': Allows to output the text of the article in a
633 different format than wikitext. Note that it is preferable to implement proper
634 handing for a custom data type using the ContentHandler facility.
635 $content: content of the page, as a Content object
636 $title: title of the page
637 $output: reference to $wgOut
639 'AuthPluginAutoCreate': Called when creating a local account for an user logged
640 in from an external authentication method.
641 $user: User object created locally
643 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
644 Gives a chance for an extension to set it programmatically to a variable class.
645 &$auth: the $wgAuth object, probably a stub
647 'AutopromoteCondition': Check autopromote condition for user.
648 $type: condition type
649 $args: arguments
650 $user: user
651 $result: result of checking autopromote condition
653 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
654 $table: table name
655 &$prefix: prefix
657 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
658 certain title are fetched.
659 $table: table name
660 $title: title of the page to which backlinks are sought
661 &$conds: query conditions
663 'BadImage': When checking against the bad image list. Change $bad and return
664 false to override. If an image is "bad", it is not rendered inline in wiki
665 pages or galleries in category pages.
666 $name: Image name being checked
667 &$bad: Whether or not the image is "bad"
669 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
670 "noarticletext-nopermission" at Article::showMissingArticle().
671 $article: article object
673 'BeforeInitialize': Before anything is initialized in
674 MediaWiki::performRequest().
675 &$title: Title being used for request
676 $unused: null
677 &$output: OutputPage object
678 &$user: User
679 $request: WebRequest object
680 $mediaWiki: Mediawiki object
682 'BeforePageDisplay': Prior to outputting a page.
683 &$out: OutputPage object
684 &$skin: Skin object
686 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
687 override how the redirect is output by modifying, or by returning false and
688 taking over the output.
689 $out: OutputPage object
690 &$redirect: URL, modifiable
691 &$code: HTTP code (eg '301' or '302'), modifiable
693 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
694 $parser: Parser object
695 $nt: the image title
696 &$options: array of options to RepoGroup::findFile
697 &$descQuery: query string to add to thumbnail URL
699 FIXME: Where does the below sentence fit in?
700 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
702 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
703 $parser: Parser object
704 $title: title of the template
705 &$skip: skip this template and link it?
706 &$id: the id of the revision being parsed
708 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
709 &$parser: Parser object
710 &$ig: ImageGallery object
712 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
713 newly created user.
714 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
715   to a newly created user account.
716 &$injected_html: Any HTML to inject after the "logged in" message of a newly
717   created user account
719 'BitmapHandlerTransform': before a file is transformed, gives extension the
720 possibility to transform it themselves
721 $handler: BitmapHandler
722 $image: File
723 &$scalerParams: Array with scaler parameters
724 &$mto: null, set to a MediaTransformOutput
726 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
727 normalizations have been performed, except for the $wgMaxImageArea check.
728 $image: File
729 &$params: Array of parameters
730 &$checkImageAreaHookResult: null, set to true or false to override the
731   $wgMaxImageArea check result.
733 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
734 to a user.
735 $block: Block object (which is set to be autoblocking)
736 &$blockIds: Array of block IDs of the autoblock
738 'BlockIp': Before an IP address or user is blocked.
739 $block: the Block object about to be saved
740 $user: the user _doing_ the block (not the one being blocked)
742 'BlockIpComplete': After an IP address or user is blocked.
743 $block: the Block object that was saved
744 $user: the user who did the block (not the one being blocked)
746 'BookInformation': Before information output on Special:Booksources.
747 $isbn: ISBN to show information for
748 $output: OutputPage object in use
750 'CanonicalNamespaces': For extensions adding their own namespaces or altering
751 the defaults.
752 &$namespaces: Array of namespace numbers with corresponding canonical names
754 'CategoryAfterPageAdded': After a page is added to a category.
755 $category: Category that page was added to
756 $wikiPage: WikiPage that was added
758 'CategoryAfterPageRemoved': After a page is removed from a category.
759 $category: Category that page was removed from
760 $wikiPage: WikiPage that was removed
762 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
763 $catpage: CategoryPage instance
765 'ChangePasswordForm': For extensions that need to add a field to the
766 ChangePassword form via the Preferences form.
767 &$extraFields: An array of arrays that hold fields like would be passed to the
768   pretty function.
770 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
771 &$changesList: ChangesList instance.
772 &$articlelink: HTML of link to article (already filled-in).
773 &$s: HTML of row that is being constructed.
774 &$rc: RecentChange instance.
775 $unpatrolled: Whether or not we are showing unpatrolled changes.
776 $watched: Whether or not the change is watched by the user.
778 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
779 $collationName: Name of the collation in question
780 &$collationObject: Null. Replace with a subclass of the Collation class that
781   implements the collation given in $collationName.
783 'ConfirmEmailComplete': Called after a user's email has been confirmed
784 successfully.
785 $user: user (object) whose email is being confirmed
787 'ContentHandlerDefaultModelFor': Called when the default content model is determined
788 for a given title. May be used to assign a different model for that title.
789 $title: the Title in question
790 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
792 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
793 content model name, but no entry for that model exists in $wgContentHandlers.
794 $modeName: the requested content model name
795 &$handler: set this to a ContentHandler object, if desired.
797 'ConvertContent': Called by AbstractContent::convert when a conversion to another
798 content model is requested.
799 $content: The Content object to be converted.
800 $toModel: The ID of the content model to convert to.
801 $lossy:   boolean indicating whether lossy conversion is allowed.
802 &$result: Output parameter, in case the handler function wants to provide a
803 converted Content object. Note that $result->getContentModel() must return $toModel.
804 Handler functions that modify $result should generally return false to further
805 attempts at conversion.
807 'ContribsPager::getQueryInfo': Before the contributions query is about to run
808 &$pager: Pager object for contributions
809 &$queryInfo: The query for the contribs Pager
811 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
812 &$data: an array of results of all contribs queries
813 $pager: The ContribsPager object hooked into
814 $offset: Index offset, inclusive
815 $limit: Exact query limit
816 $descending: Query direction, false for ascending, true for descending
818 'ContributionsLineEnding': Called before a contributions HTML line is finished
819 $page: SpecialPage object for contributions
820 &$ret: the HTML line
821 $row: the DB row for this line
822 &$classes: the classes to add to the surrounding <li>
824 'ContributionsToolLinks': Change tool links above Special:Contributions
825 $id: User identifier
826 $title: User page title
827 &$tools: Array of tool links
829 'CustomEditor': When invoking the page editor
830 $article: Article being edited
831 $user: User performing the edit
833 Return true to allow the normal editor to be used, or false
834 if implementing a custom editor, e.g. for a special namespace,
835 etc.
837 'DatabaseOraclePostInit': Called after initialising an Oracle database
838 &$db: the DatabaseOracle object
840 'Debug': Called when outputting a debug log line via wfDebug() or wfDebugLog()
841 $text: plaintext string to be output
842 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
844 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
845 $title: the diff page title (nullable)
846 &$oldId: the actual old Id to use in the diff
847 &$newId: the actual new Id to use in the diff (0 means current)
848 $old: the ?old= param value from the url
849 $new: the ?new= param value from the url
851 'DiffRevisionTools': Override or extend the revision tools available from the
852 diff view, i.e. undo, etc.
853 $rev: Revision object
854 &$links: Array of HTML links
856 'DiffViewHeader': Called before diff display
857 $diff: DifferenceEngine object that's calling
858 $oldRev: Revision object of the "old" revision (may be null/invalid)
859 $newRev: Revision object of the "new" revision
861 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
862 an article
863 $article: article (object) being viewed
864 $oldid: oldid (int) being viewed
866 'DoEditSectionLink': Override the HTML generated for section edit links
867 $skin: Skin object rendering the UI
868 $title: Title object for the title being linked to (may not be the same as
869   $wgTitle, if the section is included from a template)
870 $section: The designation of the section being pointed to, to be included in
871   the link, like "&section=$section"
872 $tooltip: The default tooltip.  Escape before using.
873   By default, this is wrapped in the 'editsectionhint' message.
874 &$result: The HTML to return, prefilled with the default plus whatever other
875   changes earlier hooks have made
876 $lang: The language code to use for the link in the wfMessage function
878 'EditFilter': Perform checks on an edit
879 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
880 $text: Contents of the edit box
881 $section: Section being edited
882 &$error: Error message to return
883 $summary: Edit summary for page
885 'EditFilterMerged': Post-section-merge edit filter.
886 DEPRECATED, use EditFilterMergedContent instead.
887 $editor: EditPage instance (object)
888 $text: content of the edit box
889 &$error: error message to return
890 $summary: Edit summary for page
892 'EditFilterMergedContent': Post-section-merge edit filter.
893 This may be triggered by the EditPage or any other facility that modifies page content.
894 Use the $status object to indicate whether the edit should be allowed, and to provide
895 a reason for disallowing it. Return false to abort the edit, and true to continue.
896 Returning true if $status->isOK() returns false means "don't save but continue user
897 interaction", e.g. show the edit form.
898 $context: object implementing the IContextSource interface.
899 $content: content of the edit box, as a Content object.
900 $status: Status object to represent errors, etc.
901 $summary: Edit summary for page
902 $user: the User object representing the user whois performing the edit.
903 $minoredit: whether the edit was marked as minor by the user.
905 'EditFormPreloadText': Allows population of the edit form when creating
906 new pages
907 &$text: Text to preload with
908 &$title: Title object representing the page being created
910 'EditFormInitialText': Allows modifying the edit form when editing existing
911 pages
912 $editPage: EditPage     object
914 'EditPage::attemptSave': Called before an article is
915 saved, that is before WikiPage::doEditContent() is called
916 $editpage_Obj: the current EditPage object
918 'EditPage::importFormData': allow extensions to read additional data
919 posted in the form
920 $editpage: EditPage instance
921 $request: Webrequest
922 return value is ignored (should always return true)
924 'EditPage::showEditForm:fields': allows injection of form field into edit form
925 $editor: the EditPage instance for reference
926 $out: an OutputPage instance to write to
927 return value is ignored (should always return true)
929 'EditPage::showEditForm:initial': before showing the edit form
930 $editor: EditPage instance (object)
931 $out: an OutputPage instance to write to
933 Return false to halt editing; you'll need to handle error messages, etc.
934 yourself. Alternatively, modifying $error and returning true will cause the
935 contents of $error to be echoed at the top of the edit form as wikitext.
936 Return true without altering $error to allow the edit to proceed.
938 'EditPage::showStandardInputs:options': allows injection of form fields into
939 the editOptions area
940 $editor: EditPage instance (object)
941 $out: an OutputPage instance to write to
942 &$tabindex: HTML tabindex of the last edit check/button
943 return value is ignored (should always be true)
945 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
946 when there's an edit conflict.  Return false to halt normal diff output; in
947 this case you're responsible for computing and outputting the entire "conflict"
948 part, i.e., the "difference between revisions" and "your text" headers and
949 sections.
950 &$editor: EditPage instance
951 &$out: OutputPage instance
953 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
954 textarea in the edit form.
955 &$editpage: The current EditPage object
956 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
957 &$tabindex: HTML tabindex of the last edit check/button
959 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
960 in the edit form.
961 &$editpage: The current EditPage object
962 &$checks: Array of edit checks like "watch this page"/"minor edit"
963 &$tabindex: HTML tabindex of the last edit check/button
965 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
966 textarea in the edit form.
967 &$toolbar: The toolbar HTMl
969 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
970 contribution/copyright notice.
971 $title: title of page being edited
972 &$msg: localization message name, overridable. Default is either
973   'copyrightwarning' or 'copyrightwarning2'.
975 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
976 modifying the wikitext that will be used in "Show changes". Note that it is
977 preferable to implement diff handling for different data types using the
978 ContentHandler facility.
979 $editPage: EditPage object
980 &$newtext: wikitext that will be used as "your version"
982 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
983 "Show changes". Note that it is preferable to implement diff handling for
984 different data types using the ContentHandler facility.
985 $editPage: EditPage object
986 &$newtext: wikitext that will be used as "your version"
988 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
989 Allow modifying the wikitext that will be previewed. Note that it is preferable
990 to implement previews for different data types using the ContentHandler
991 facility.
992 $editPage: EditPage object
993 &$toparse: wikitext that will be parsed
995 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
996 previewed. Note that it is preferable to implement previews for different data
997 types using the ContentHandler facility.
998 $editPage: EditPage object
999 &$content: Content object to be previewed (may be replaced by hook function)
1001 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1002 &$editpage: The current EditPage object
1003 &$res: the HTML of the error text
1005 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1006 of terms of service summary link that might exist separately from the copyright
1007 notice.
1008 $title: title of page being edited
1009 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1011 'EditSectionLink': Do not use, use DoEditSectionLink instead.
1012 $skin: Skin rendering the UI
1013 $title: Title being linked to
1014 $section: Section to link to
1015 $link: Default link
1016 &$result: Result (alter this to override the generated links)
1017 $lang: The language code to use for the link in the wfMessage function
1019 'EmailConfirmed': When checking that the user's email address is "confirmed".
1020 $user: User being checked
1021 $confirmed: Whether or not the email address is confirmed
1022 This runs before the other checks, such as anonymity and the real check; return
1023 true to allow those checks to occur, and false if checking is done.
1025 'EmailUser': Before sending email from one user to another.
1026 $to: address of receiving user
1027 $from: address of sending user
1028 $subject: subject of the mail
1029 $text: text of the mail
1031 'EmailUserCC': Before sending the copy of the email to the author.
1032 $to: address of receiving user
1033 $from: address of sending user
1034 $subject: subject of the mail
1035 $text: text of the mail
1037 'EmailUserComplete': After sending email from one user to another.
1038 $to: address of receiving user
1039 $from: address of sending user
1040 $subject: subject of the mail
1041 $text: text of the mail
1043 'EmailUserForm': After building the email user form object.
1044 $form: HTMLForm object
1046 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1047 user.
1048 $user: The user who is trying to email another user.
1049 $editToken: The user's edit token.
1050 &$hookErr: Out-param for the error. Passed as the parameters to
1051   OutputPage::showErrorPage.
1053 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1054 throttle.
1055 $ip: The ip address of the user
1057 'ExtensionTypes': Called when generating the extensions credits, use this to
1058 change the tables headers.
1059 &$extTypes: associative array of extensions types
1061 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1062 thumbnail file name.
1063 $thumbname: the base name of the thumbnail file
1064 &$params: the currently extracted params (has source name, temp or archived zone)
1066 'FetchChangesList': When fetching the ChangesList derivative for a particular
1067 user.
1068 $user: User the list is being fetched for
1069 &$skin: Skin object to be used with the list
1070 &$list: List object (defaults to NULL, change it to an object instance and
1071   return false override the list derivative used)
1073 'FileDeleteComplete': When a file is deleted.
1074 $file: reference to the deleted file
1075 $oldimage: in case of the deletion of an old image, the name of the old file
1076 $article: in case all revisions of the file are deleted a reference to the
1077   WikiFilePage associated with the file.
1078 $user: user who performed the deletion
1079 $reason: reason
1081 'FileTransformed': When a file is transformed and moved into storage.
1082 $file: reference to the File object
1083 $thumb: the MediaTransformOutput object
1084 $tmpThumbPath: The temporary file system path of the transformed file
1085 $thumbPath: The permanent storage path of the transformed file
1087 'FileUpload': When a file upload occurs.
1088 $file : Image object representing the file that was uploaded
1089 $reupload : Boolean indicating if there was a previously another image there or
1090   not (since 1.17)
1091 $hasDescription : Boolean indicating that there was already a description page
1092   and a new one from the comment wasn't created (since 1.17)
1094 'FileUndeleteComplete': When a file is undeleted
1095 $title: title object to the file
1096 $fileVersions: array of undeleted versions. Empty if all versions were restored
1097 $user: user who performed the undeletion
1098 $reason: reason
1100 'FormatAutocomments': When an autocomment is formatted by the Linker.
1101  &$comment: Reference to the accumulated comment. Initially null, when set the
1102    default code will be skipped.
1103  $pre: Initial part of the parsed comment before the call to the hook.
1104  $auto: The extracted part of the parsed comment before the call to the hook.
1105  $post: The final part of the parsed comment before the call to the hook.
1106  $title: An optional title object used to links to sections. Can be null.
1107  $local: Boolean indicating whether section links should refer to local page.
1109 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1110 entitled to be in.
1111 &$user: user to promote.
1112 &$promote: groups that will be added.
1114 'GetBlockedStatus': after loading blocking status of an user from the database
1115 $user: user (object) being checked
1117 'GetCacheVaryCookies': Get cookies that should vary cache options.
1118 $out: OutputPage object
1119 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1120   that have to vary cache options
1122 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1123 notifications.
1124 $title: Title object of page
1125 $url: string value as output (out parameter, can modify)
1126 $query: query options passed to Title::getCanonicalURL()
1128 'GetDefaultSortkey': Override the default sortkey for a page.
1129 $title: Title object that we need to get a sortkey for
1130 &$sortkey: Sortkey to use.
1132 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1133 underscore) magic words. Called by MagicWord.
1134 &$doubleUnderscoreIDs: array of strings
1136 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1137 $title: Title object of page
1138 $url: string value as output (out parameter, can modify)
1139 $query: query options passed to Title::getFullURL()
1141 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1142 $title: Title object of page
1143 $url: string value as output (out parameter, can modify)
1144 $query: query options passed to Title::getInternalURL()
1146 'GetIP': modify the ip of the current user (called only once).
1147 &$ip: string holding the ip as determined so far
1149 'GetLinkColours': modify the CSS class of an array of page links.
1150 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1151         indexed by page_id.
1152 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1154 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1155 working with internal urls (non-interwiki) then it may be preferable to work
1156 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1157 be buggy for internal urls on render if you do not re-implement the horrible
1158 hack that Title::getLocalURL uses in your own extension.
1159 $title: Title object of page
1160 &$url: string value as output (out parameter, can modify)
1161 $query: query options passed to Title::getLocalURL()
1163 'GetLocalURL::Internal': Modify local URLs to internal pages.
1164 $title: Title object of page
1165 &$url: string value as output (out parameter, can modify)
1166 $query: query options passed to Title::getLocalURL()
1168 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1169 without any fancy queries or variants.
1170 $title: Title object of page
1171 &$url: string value as output (out parameter, can modify)
1173 'GetMetadataVersion': Modify the image metadata version currently in use. This
1174 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1175 that need to have versioned metadata should add an element to the end of the
1176 version array of the form 'handler_name=version'. Most media handlers won't need
1177 to do this unless they broke backwards compatibility with a previous version of
1178 the media handler metadata output.
1179 &$version: Array of version strings
1181 'GetPreferences': Modify user preferences.
1182 $user: User whose preferences are being modified.
1183 &$preferences: Preferences description array, to be fed to an HTMLForm object
1185 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1186 checked for. Use instead of userCan for most cases. Return false if the user
1187 can't do it, and populate $result with the reason in the form of
1188 array( messagename, param1, param2, ... ). For consistency, error messages
1189 should be plain text with no special coloring, bolding, etc. to show that
1190 they're errors; presenting them properly to the user as errors is done by the
1191 caller.
1192 $title: Title object being checked against
1193 $user : Current user object
1194 $action: Action being checked
1195 $result: User permissions error to add. If none, return true.
1197 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1198 called only if expensive checks are enabled. Add a permissions error when
1199 permissions errors are checked for. Return false if the user can't do it, and
1200 populate $result with the reason in the form of array( messagename, param1,
1201 param2, ... ). For consistency, error messages should be plain text with no
1202 special coloring, bolding, etc. to show that they're errors; presenting them
1203 properly to the user as errors is done by the caller.
1205 $title: Title object being checked against
1206 $user : Current user object
1207 $action: Action being checked
1208 $result: User permissions error to add. If none, return true.
1210 'GitViewers': Called when generating the list of git viewers for
1211 Special:Version, use this to change the list.
1212 &$extTypes: associative array of repo URLS to viewer URLs.
1214 'HistoryRevisionTools': Override or extend the revision tools available from the
1215 page history view, i.e. undo, rollback, etc.
1216 $rev: Revision object
1217 &$links: Array of HTML links
1219 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1220 image insertion. You can skip the default logic entirely by returning false, or
1221 just modify a few things using call-by-reference.
1222 &$skin: Skin object
1223 &$title: Title object of the image
1224 &$file: File object, or false if it doesn't exist
1225 &$frameParams: Various parameters with special meanings; see documentation in
1226   includes/Linker.php for Linker::makeImageLink
1227 &$handlerParams: Various parameters with special meanings; see documentation in
1228   includes/Linker.php for Linker::makeImageLink
1229 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1230 &$res: Final HTML output, used if you return false
1233 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1234 the image on an image page.
1235 $imagePage: ImagePage object ($this)
1236 $output: $wgOut
1238 'ImagePageAfterImageLinks': Called after the image links section on an image
1239 page is built.
1240 $imagePage: ImagePage object ($this)
1241 &$html: HTML for the hook to add
1243 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1244 $file: the file
1245 $line: the HTML of the history line
1246 $css: the line CSS class
1248 'ImagePageFindFile': Called when fetching the file associated with an image
1249 page.
1250 $page: ImagePage object
1251 &$file: File object
1252 &$displayFile: displayed File object
1254 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1255 $page: ImagePage object
1256 &$toc: Array of <li> strings
1258 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1259 using img_auth.php.
1260 &$title: the Title object of the file as it would appear for the upload page
1261 &$path: the original file and path name when img_auth was invoked by the the web
1262   server
1263 &$name: the name only component of the file
1264 &$result: The location to pass back results of the hook routine (only used if
1265   failed)
1266   $result[0]=The index of the header message
1267   $result[1]=The index of the body text message
1268   $result[2 through n]=Parameters passed to body text message. Please note the
1269   header message cannot receive/use parameters.
1271 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1272 $reader: XMLReader object
1273 $logInfo: Array of information
1274 Return false to stop further processing of the tag
1276 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1277 $reader: XMLReader object
1278 $pageInfo: Array of information
1279 Return false to stop further processing of the tag
1281 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1282 $reader: XMLReader object
1283 $pageInfo: Array of page information
1284 $revisionInfo: Array of revision information
1285 Return false to stop further processing of the tag
1287 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1288 $reader: XMLReader object
1289 Return false to stop further processing of the tag
1291 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1292 $reader: XMLReader object
1293 $revisionInfo: Array of information
1294 Return false to stop further processing of the tag
1296 'InfoAction': When building information to display on the action=info page.
1297 $context: IContextSource object
1298 &$pageInfo: Array of information
1300 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1301 $title: Title object ($wgTitle)
1302 $request: WebRequest
1303 $ignoreRedirect: boolean to skip redirect check
1304 $target: Title/string of redirect target
1305 $article: Article object
1307 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1308 Return true without providing an interwiki to continue interwiki search.
1309 $prefix: interwiki prefix we are looking for.
1310 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1311   iw_trans and optionally iw_api and iw_wikiid.
1313 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1314 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1315 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1316 template/parser function execution which respect nowiki and HTML-comments.
1317 &$parser: Parser object
1318 &$text: string containing partially parsed text
1319 &$stripState: Parser's internal StripState object
1321 'InternalParseBeforeLinks': during Parser's internalParse method before links
1322 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1323 &$parser: Parser object
1324 &$text: string containing partially parsed text
1325 &$stripState: Parser's internal StripState object
1327 'InvalidateEmailComplete': Called after a user's email has been invalidated
1328 successfully.
1329 $user: user (object) whose email is being invalidated
1331 'IRCLineURL': When constructing the URL to use in an IRC notification.
1332 Callee may modify $url and $query, URL will be constructed as $url . $query
1333 &$url: URL to index.php
1334 &$query: Query string
1336 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1337 $article: article (object) being checked
1339 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1340 $ip: IP being check
1341 $result: Change this value to override the result of wfIsTrustedProxy()
1343 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1344 instance to return false if the domain name doesn't match your organization.
1345 $addr: The e-mail address entered by the user
1346 &$result: Set this and return false to override the internal checks
1348 'isValidPassword': Override the result of User::isValidPassword()
1349 $password: The password entered by the user
1350 &$result: Set this and return false to override the internal checks
1351 $user: User the password is being validated for
1353 'Language::getMessagesFileName':
1354 $code: The language code or the language we're looking for a messages file for
1355 &$file: The messages file path, you can override this to change the location.
1357 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1358 remove namespaces. Do not use this hook to add namespaces. Use
1359 CanonicalNamespaces for that.
1360 &$namespaces: Array of namespaces indexed by their numbers
1362 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1363 $wgExtensionMessagesFiles instead.
1364 Use this to define synonyms of magic words depending of the language
1365 $magicExtensions: associative array of magic words synonyms
1366 $lang: language code (string)
1368 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1369 listed in $wgExtensionMessagesFiles instead.
1370 Use to define aliases of special pages names depending of the language
1371 $specialPageAliases: associative array of magic words synonyms
1372 $lang: language code (string)
1374 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1375 &$names: array of language code => language name
1376 $code language of the preferred translations
1378 'LinkBegin': Used when generating internal and interwiki links in
1379 Linker::link(), before processing starts.  Return false to skip default
1380 processing and return $ret. See documentation for Linker::link() for details on
1381 the expected meanings of parameters.
1382 $skin: the Skin object
1383 $target: the Title that the link is pointing to
1384 &$html: the contents that the <a> tag should have (raw HTML); null means
1385   "default".
1386 &$customAttribs: the HTML attributes that the <a> tag should have, in
1387 associative array form, with keys and values unescaped.  Should be merged with
1388 default values, with a value of false meaning to suppress the attribute.
1389 &$query: the query string to add to the generated URL (the bit after the "?"),
1390   in associative array form, with keys and values unescaped.
1391 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1392 &$ret: the value to return if your hook returns false.
1394 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1395 just before the function returns a value.  If you return true, an <a> element
1396 with HTML attributes $attribs and contents $html will be returned.  If you
1397 return false, $ret will be returned.
1398 $skin: the Skin object
1399 $target: the Title object that the link is pointing to
1400 $options: the options.  Will always include either 'known' or 'broken', and may
1401   include 'noclasses'.
1402 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1403 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1404   associative array form.
1405 &$ret: the value to return if your hook returns false.
1407 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1408 before the return.
1409 &$url: the image url
1410 &$alt: the image's alt text
1411 &$img: the new image HTML (if returning false)
1413 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1414 before the return.
1415 &$url: the link url
1416 &$text: the link text
1417 &$link: the new link HTML (if returning false)
1418 &$attribs: the attributes to be applied.
1419 $linkType: The external link type
1421 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1422 actual update.
1423 &$linksUpdate: the LinksUpdate object
1425 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1426 each link table insert.  For example, pagelinks, imagelinks, externallinks.
1427 $linksUpdate: LinksUpdate object
1428 $table: the table to insert links to
1429 $insertions: an array of links to insert
1431 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1432 including delete and insert, has completed for all link tables
1433 &$linksUpdate: the LinksUpdate object
1435 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1436 &$linksUpdate: the LinksUpdate object
1438 'ListDefinedTags': When trying to find all defined tags.
1439 &$tags: The list of tags.
1441 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1442 &updater: A DatabaseUpdater subclass
1444 'LocalFile::getHistory': Called before file history query performed.
1445 $file: the File object
1446 $tables: tables
1447 $fields: select fields
1448 $conds: conditions
1449 $opts: query options
1450 $join_conds: JOIN conditions
1452 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1453 $file: the File object
1454 $archiveName: name of an old file version or false if it's the current one
1456 'LocalisationCacheRecache': Called when loading the localisation data into
1457 cache.
1458 $cache: The LocalisationCache object
1459 $code: language code
1460 &$alldata: The localisation data from core and extensions
1462 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1463 Returning false will prevent the string from being added to the OutputPage.
1464 &$s: html string to show for the log extract
1465 $types: String or Array Log types to show
1466 $page: String or Title The page title to show log entries for
1467 $user: String The user who made the log entries
1468 $param: Associative Array with the following additional options:
1469   - lim Integer Limit of items to show, default is 50
1470   - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1471   - showIfEmpty boolean Set to false if you don't want any output in case the
1472     loglist is empty if set to true (default), "No matching items in log" is
1473     displayed if loglist is empty
1474   - msgKey Array If you want a nice box with a message, set this to the key of
1475     the message. First element is the message key, additional optional elements
1476     are parameters for the key that are processed with
1477     wfMessage()->params()->parseAsBlock()
1478   - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1479     offset
1480   - wrap String Wrap the message in html (usually something like
1481     "&lt;div ...>$1&lt;/div>").
1482   - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1484 'LoginAuthenticateAudit': A login attempt for a valid user account either
1485 succeeded or failed. No return data is accepted; this hook is for auditing only.
1486 $user: the User object being authenticated against
1487 $password: the password being submitted and found wanting
1488 $retval: a LoginForm class constant with authenticateUserData() return
1489   value (SUCCESS, WRONG_PASS, etc.).
1491 'LogLine': Processes a single log entry on Special:Log.
1492 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1493   logging.log_type database field.
1494 $log_action: string for the type of log action (e.g. 'delete', 'block',
1495   'create2'). Corresponds to logging.log_action database field.
1496 $title: Title object that corresponds to logging.log_namespace and
1497   logging.log_title database fields.
1498 $paramArray: Array of parameters that corresponds to logging.log_params field.
1499   Note that only $paramArray[0] appears to contain anything.
1500 &$comment: string that corresponds to logging.log_comment database field, and
1501   which is displayed in the UI.
1502 &$revert: string that is displayed in the UI, similar to $comment.
1503 $time: timestamp of the log entry (added in 1.12)
1505 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1506 script.
1507 $refreshLinks: RefreshLinks object
1509 'MagicWordwgVariableIDs': When defining new magic words IDs.
1510 $variableIDs: array of strings
1512 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1513 executed. Ideally, this hook should only be used to add variables that depend on
1514 the current page/request; static configuration should be added through
1515 ResourceLoaderGetConfigVars instead.
1516 &$vars: variable (or multiple variables) to be added into the output of
1517   Skin::makeVariablesScript
1518 $out: The OutputPage which called the hook, can be used to get the real title.
1520 'MarkPatrolled': Before an edit is marked patrolled.
1521 $rcid: ID of the revision to be marked patrolled
1522 $user: the user (object) marking the revision as patrolled
1523 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1524   sysop in order to mark an edit patrolled.
1526 'MarkPatrolledComplete': After an edit is marked patrolled.
1527 $rcid: ID of the revision marked as patrolled
1528 $user: user (object) who marked the edit patrolled
1529 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1530   sysop to patrol the edit.
1532 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1533 something completely different, after the basic globals have been set up, but
1534 before ordinary actions take place.
1535 $output: $wgOut
1536 $article: $wgArticle
1537 $title: $wgTitle
1538 $user: $wgUser
1539 $request: $wgRequest
1540 $mediaWiki: The $mediawiki object
1542 'MessagesPreLoad': When loading a message from the database.
1543 $title: title of the message (string)
1544 $message: value (string), change it to the message you want to define
1546 'MessageCacheReplace': When a message page is changed. Useful for updating
1547 caches.
1548 $title: name of the page changed.
1549 $text: new contents of the page.
1551 'ModifyExportQuery': Modify the query used by the exporter.
1552 $db: The database object to be queried.
1553 &$tables: Tables in the query.
1554 &$conds: Conditions in the query.
1555 &$opts: Options for the query.
1556 &$join_conds: Join conditions for the query.
1558 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1559 links have been rendered (useful for adding more). Note: this is only run for
1560 the Monobook skin. To add items to the toolbox you should use the
1561 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1562 skins.
1563 $tools: array of tools
1565 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1566 and returning it for the skin to output. You can add items to the toolbox while
1567 still letting the skin make final decisions on skin-specific markup conventions
1568 using this hook.
1569 &$sk: The BaseTemplate base skin template
1570 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1571   BaseTemplate::makeListItem for details on the format of individual items
1572   inside of this array.
1574 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1575 namespace.
1576 $index: Integer; the index of the namespace being checked.
1577 $result: Boolean; whether MediaWiki currently thinks that pages in this
1578   namespace are movable. Hooks may change this value to override the return
1579   value of MWNamespace::isMovable().
1581 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1582 edit.
1583 $wikiPage: the WikiPage edited
1584 $rev: the new revision
1585 $baseID: the revision ID this was based off, if any
1586 $user: the editing user
1588 'NormalizeMessageKey': Called before the software gets the text of a message
1589 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1590 displayed.
1591 &$key: the message being looked up. Change this to something else to change
1592   what message gets displayed (string)
1593 &$useDB: whether or not to look up the message in the database (bool)
1594 &$langCode: the language code to get the message for (string) - or -
1595   whether to use the content language (true) or site language (false) (bool)
1596 &$transform: whether or not to expand variables and templates
1597   in the message (bool)
1599 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1600 return false to omit the line from RecentChanges and Watchlist special pages.
1601 &$changeslist: The OldChangesList instance.
1602 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1603 &$rc: The RecentChange object.
1604 &$classes: array of css classes for the <li> element
1606 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1607 can alter or append to the array of URLs for search & suggestion formats.
1608 &$urls: array of associative arrays with Url element attributes
1610 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1611 users and/or IP addresses too.
1612 $otherBlockLink: An array with links to other block logs
1613 $ip: The requested IP address or username
1615 'OutputPageBeforeHTML': A page has been processed by the parser and the
1616 resulting HTML is about to be displayed.
1617 $parserOutput: the parserOutput (object) that corresponds to the page
1618 $text: the text that will be displayed, in HTML (string)
1620 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1621 body tag to allow for extensions to add attributes to the body of the page they
1622 might need. Or to allow building extensions to add body classes that aren't of
1623 high enough demand to be included in core.
1624 $out: The OutputPage which called the hook, can be used to get the real title
1625 $sk: The Skin that called OutputPage::headElement
1626 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1628 'OutputPageCheckLastModified': when checking if the page has been modified
1629 since the last visit.
1630 &$modifiedTimes: array of timestamps.
1631         The following keys are set: page, user, epoch
1633 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1634 $out: OutputPage instance (object)
1635 $parserOutput: parserOutput instance being added in $out
1637 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1638 categories. Implementations should return false if they generate the category
1639 links, so the default link generation is skipped.
1640 $out: OutputPage instance (object)
1641 $categories: associative array, keys are category names, values are category
1642   types ("normal" or "hidden")
1643 $links: array, intended to hold the result. Must be an associative array with
1644   category types as keys and arrays of HTML links as values.
1646 'PageContentInsertComplete': After a new article is created.
1647 $wikiPage: WikiPage created
1648 $user: User creating the article
1649 $content: New content as a Content object
1650 $summary: Edit summary/comment
1651 $isMinor: Whether or not the edit was marked as minor
1652 $isWatch: (No longer used)
1653 $section: (No longer used)
1654 $flags: Flags passed to WikiPage::doEditContent()
1655 $revision: New Revision of the article
1657 'PageContentLanguage': Allows changing the language in which the content of a
1658 page is written. Defaults to the wiki content language ($wgContLang).
1659 $title: Title object
1660 &$pageLang: the page content language (either an object or a language code)
1661 $wgLang: the user language
1663 'PageContentSave': Before an article is saved.
1664 $wikiPage: the WikiPage (object) being saved
1665 $user: the user (object) saving the article
1666 $content: the new article content, as a Content object
1667 $summary: the article summary (comment)
1668 $isminor: minor flag
1669 $iswatch: watch flag
1670 $section: section #
1672 'PageContentSaveComplete': After an article has been updated.
1673 $wikiPage: WikiPage modified
1674 $user: User performing the modification
1675 $content: New content, as a Content object
1676 $summary: Edit summary/comment
1677 $isMinor: Whether or not the edit was marked as minor
1678 $isWatch: (No longer used)
1679 $section: (No longer used)
1680 $flags: Flags passed to WikiPage::doEditContent()
1681 $revision: New Revision of the article
1682 $status: Status object about to be returned by doEditContent()
1683 $baseRevId: the rev ID (or false) this edit was based on
1685 'PageHistoryBeforeList': When a history page list is about to be constructed.
1686 $article: the article that the history is loading for
1687 $context: RequestContext object
1689 'PageHistoryLineEnding' : Right before the end <li> is added to a history line.
1690 $row: the revision row for this line
1691 $s: the string representing this parsed line
1692 $classes: array containing the <li> element classes
1694 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1695 constructed.
1696 $pager: the pager
1697 $queryInfo: the query parameters
1699 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1700 which depends on user options should install this hook and append its values to
1701 the key.
1702 $hash: reference to a hash key string which can be modified
1704 'ParserAfterParse': Called from Parser::parse() just after the call to
1705 Parser::internalParse() returns.
1706 $parser: parser object
1707 $text: text being parsed
1708 $stripState: stripState used (object)
1710 'ParserAfterStrip': Called at end of parsing time.
1711 TODO: No more strip, deprecated ?
1712 $parser: parser object
1713 $text: text being parsed
1714 $stripState: stripState used (object)
1716 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1717 $parser: Parser object being used
1718 $text: text that will be returned
1720 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1721 $parser: Parser object
1722 $text: text to parse
1723 $stripState: StripState instance being used
1725 'ParserBeforeStrip': Called at start of parsing time.
1726 TODO: No more strip, deprecated ?
1727 $parser: parser object
1728 $text: text being parsed
1729 $stripState: stripState used (object)
1731 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1732 $parser: Parser object being used
1733 $text: actual text
1735 'ParserClearState': Called at the end of Parser::clearState().
1736 $parser: Parser object being cleared
1738 'ParserCloned': Called when the parser is cloned.
1739 $parser: Newly-cloned Parser object
1741 'ParserFirstCallInit': Called when the parser initialises for the first time.
1742 &$parser: Parser object being cleared
1744 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1745 custom magic word
1746 $parser: Parser object
1747 $varCache: array to store the value in case of multiples calls of the
1748         same magic word
1749 $index: index (string) of the magic
1750 $ret: value of the magic word (the hook should set it)
1751 $frame: PPFrame object to use for expanding any template variables
1753 'ParserGetVariableValueTs': Use this to change the value of the time for the
1754 {{LOCAL...}} magic word.
1755 $parser: Parser object
1756 $time: actual time (timestamp)
1758 'ParserGetVariableValueVarCache': use this to change the value of the variable
1759 cache or return false to not use it.
1760 $parser: Parser object
1761 $varCache: variable cache (array)
1763 'ParserLimitReport': Called at the end of Parser:parse() when the parser will
1764 include comments about size of the text parsed.
1765 $parser: Parser object
1766 $limitReport: text that will be included (without comment tags)
1768 'ParserMakeImageParams': Called before the parser make an image link, use this
1769 to modify the parameters of the image.
1770 $title: title object representing the file
1771 $file: file object that will be used to create the image
1772 &$params: 2-D array of parameters
1773 $parser: Parser object that called the hook
1775 'ParserSectionCreate': Called each time the parser creates a document section
1776 from wikitext. Use this to apply per-section modifications to HTML (like
1777 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
1778 can begin in one section and end in another. Make sure your code can handle
1779 that case gracefully. See the EditSectionClearerLink extension for an example.
1780 $parser: the calling Parser instance
1781 $section: the section number, zero-based, but section 0 is usually empty
1782 &$sectionContent: ref to the content of the section. modify this.
1783 $showEditLinks: boolean describing whether this section has an edit link
1785 'ParserTestParser': Called when creating a new instance of Parser in
1786 maintenance/parserTests.inc.
1787 $parser: Parser object created
1789 'ParserTestGlobals': Allows to define globals for parser tests.
1790 &$globals: Array with all the globals which should be set for parser tests.
1791   The arrays keys serve as the globals names, its values are the globals values.
1793 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1794 run. Use when page save hooks require the presence of custom tables to ensure
1795 that tests continue to run properly.
1796 &$tables: array of table names
1798 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1799 my talk page, my contributions" etc).
1800 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1801 &$title: Title object representing the current page
1803 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1804 &$user : User performing the action
1805 $action : Action being performed
1806 &$result : Whether or not the action should be prevented
1807 Change $result and return false to give a definitive answer, otherwise
1808 the built-in rate limiting checks are used, if enabled.
1810 'PlaceNewSection': Override placement of new sections. Return false and put the
1811 merged text into $text to override the default behavior.
1812 $wikipage : WikiPage object
1813 $oldtext : the text of the article before editing
1814 $subject : subject of the new section
1815 &$text : text of the new section
1817 'PreferencesGetLegend': Override the text used for the <legend> of a
1818 preferences section.
1819 $form: the PreferencesForm object. This is a ContextSource as well
1820 $key: the section name
1821 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1823 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1824 AJAX search suggestions. Put results into &$results outparam and return false.
1825 $ns : array of int namespace keys to search in
1826 $search : search term (not guaranteed to be conveniently normalized)
1827 $limit : maximum number of results to return
1828 &$results : out param: array of page names (strings)
1830 'PrefsEmailAudit': Called when user changes their email address.
1831 $user: User (object) changing his email address
1832 $oldaddr: old email address (string)
1833 $newaddr: new email address (string)
1835 'PrefsPasswordAudit': Called when user changes his password.
1836 $user: User (object) changing his password
1837 $newPass: new password
1838 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1840 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1841 in the form.
1842 $article: the title being (un)protected
1843 $output: a string of the form HTML so far
1845 'ProtectionForm::save': Called when a protection form is submitted.
1846 $article: the title being (un)protected
1847 $errorMsg: an html message string of an error or an array of message name and
1848   its parameters
1850 'ProtectionForm::showLogExtract': Called after the protection log extract is
1851 shown.
1852 $article: the page the form is shown for
1853 $out: OutputPage object
1855 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1856 &$obj: RawPage object
1857 &$text: The text that's going to be the output
1859 'RecentChange_save': Called at the end of RecentChange::save().
1860 $recentChange: RecentChange object
1862 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1863 names such as "oldid" that are preserved when using redirecting special pages
1864 such as Special:MyPage and Special:MyTalk.
1865 &$redirectParams: An array of parameters preserved by redirecting special pages.
1867 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
1868 instance. Can be used by an extension override what skin is used in certain
1869 contexts.
1870 IContextSource $context: The RequestContext the skin is being created for.
1871 &$skin: A variable reference you may set a Skin instance or string key on to
1872   override the skin that will be used for the context.
1874 'ResourceLoaderGetConfigVars': Called at the end of
1875 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1876 configuration variables to JavaScript. Things that depend on the current page
1877 or request state must be added through MakeGlobalVariablesScript instead.
1878 &$vars: array( variable name => value )
1880 'ResourceLoaderGetStartupModules': Run once the startup module is being
1881 generated. This allows you to add modules to the startup module. This hook
1882 should be used sparingly since any module added here will be loaded on all
1883 pages. This hook is useful if you want to make code available to module loader
1884 scripts.
1886 'ResourceLoaderRegisterModules': Right before modules information is required,
1887 such as when responding to a resource
1888 loader request or generating HTML output.
1889 &$resourceLoader: ResourceLoader object
1891 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
1892 called after the addition of 'qunit' and MediaWiki testing resources.
1893 &testModules: array of JavaScript testing modules. The 'qunit' framework,
1894   included in core, is fed using tests/qunit/QUnitTestResources.php.
1895 &ResourceLoader object
1897 To add a new qunit module named 'myext.tests':
1898 testModules['qunit']['myext.tests'] = array(
1899         'script' => 'extension/myext/tests.js',
1900         'dependencies' => <any module dependency you might have>
1902 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
1903 added to any module.
1905 'RevisionInsertComplete': Called after a revision is inserted into the database.
1906 &$revision: the Revision
1907 $data: the data stored in old_text.  The meaning depends on $flags: if external
1908   is set, it's the URL of the revision text in external storage; otherwise,
1909   it's the revision text itself.  In either case, if gzip is set, the revision
1910   text is gzipped.
1911 $flags: a comma-delimited list of strings representing the options used.  May
1912   include: utf8 (this will always be set for new revisions); gzip; external.
1914 'SearchUpdate': Prior to search update completion.
1915 $id : Page id
1916 $namespace : Page namespace
1917 $title : Page title
1918 $text : Current text being indexed
1920 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
1921 the normal operations.
1922 $allSearchTerms : Array of the search terms in all content languages
1923 &$titleResult : Outparam; the value to return. A Title object or null.
1925 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
1926 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
1927 runs after.
1928 $term : Search term string
1929 &$title : Outparam; set to $title object and return false for a match
1931 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1932 if nothing was found.
1933 $term : Search term string
1934 &$title : Outparam; set to $title object and return false for a match
1936 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
1937 searches.
1938 $term : Search term string
1939 &$title : Current Title object that is being returned (null if none found).
1941 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1942 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1943 in the $searchEngine->namespaces array.
1944 $query : Original query.
1945 &$parsed : Resultant query with the prefixes stripped.
1947 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1948 search results.
1949 $title : Current Title object being displayed in search results.
1950 &$id: Revision ID (default is false, for latest)
1952 'SearchableNamespaces': An option to modify which namespaces are searchable.
1953 &$arr : Array of namespaces ($nsId => $name) which will be used.
1955 'SeleniumSettings': TODO
1957 'SetupAfterCache': Called in Setup.php, after cache objects are set
1959 'ShowMissingArticle': Called when generating the output for a non-existent page.
1960 $article: The article object corresponding to the page
1962 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1963 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1964 $text: Text being shown
1965 $title: Title of the custom script/stylesheet page
1966 $output: Current OutputPage object
1968 'ShowSearchHitTitle': Customise display of search hit title/link.
1969 &$title: Title to link to
1970 &$text: Text to use for the link
1971 $result: The search result
1972 $terms: The search terms entered
1973 $page: The SpecialSearch object.
1975 'ShowSearchHit': Customize display of search hit.
1976 $searchPage: The SpecialSearch instance.
1977 $result: The SearchResult to show
1978 $terms: Search terms, for highlighting
1979 &$link: HTML of link to the matching page. May be modified.
1980 &$redirect: HTML of redirect info. May be modified.
1981 &$section: HTML of matching section. May be modified.
1982 &$extract: HTML of content extract. May be modified.
1983 &$score: HTML of score. May be modified.
1984 &$size: HTML of page size. May be modified.
1985 &$date: HTML of of page modification date. May be modified.
1986 &$related: HTML of additional info for the matching page. May be modified.
1987 &$html: May be set to the full HTML that should be used to represent the search
1988   hit. Must include the <li> ... </li> tags. Will only be used if the hook
1989   function returned false.
1991 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
1992 allow the normal method of notice selection/rendering to work, or change the
1993 value of $siteNotice and return false to alter it.
1994 &$siteNotice: HTML returned as the sitenotice
1995 $skin: Skin object
1997 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
1998 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
1999   the sitenotice/anonnotice.
2000 $skin: Skin object
2002 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2003 $skin: Skin object
2004 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2005   the stock bottom scripts.
2007 'SkinAfterContent': Allows extensions to add text after the page content and
2008 article metadata. This hook should work in all skins. Set the &$data variable to
2009 the text you're going to add.
2010 &$data: (string) Text to be printed out directly (without parsing)
2011 $skin: Skin object
2013 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2014 $skin: Skin object
2015 &$bar: Sidebar contents
2016 Modify $bar to add or modify sidebar portlets.
2018 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2019 copyright notice.
2020 $title: displayed page title
2021 $type: 'normal' or 'history' for old/diff views
2022 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2023   message must be in HTML format, not wikitext!
2024 &$link: overridable HTML link to be passed into the message as $1
2025 &$forContent: overridable flag if copyright footer is shown in content language.
2027 'SkinGetPoweredBy': TODO
2028 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2029 the MediaWiki icon but plain text instead.
2030 $skin: Skin object
2032 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2033 &$subpages: Subpage links HTML
2034 $skin: Skin object
2035 $out: OutputPage object
2036 If false is returned $subpages will be used instead of the HTML
2037 subPageSubtitle() generates.
2038 If true is returned, $subpages will be ignored and the rest of
2039 subPageSubtitle() will run.
2041 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2042 link" tab.
2043 $sktemplate: SkinTemplate object
2044 $nav_urls: array of tabs
2046 To alter the structured navigation links in SkinTemplates, there are three
2047 hooks called in different spots:
2049 'SkinTemplateNavigation': Called on content pages after the tabs have been
2050 added, but before variants have been added.
2051 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2052 tab is added but before variants have been added.
2053 'SkinTemplateNavigation::Universal': Called on both content and special pages
2054 after variants have been added.
2055 &$sktemplate: SkinTemplate object
2056 &$links: Structured navigation links. This is used to alter the navigation for
2057   skins which use buildNavigationUrls such as Vector.
2059 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2060 page output.
2061 &$sktemplate: SkinTemplate object
2062 &$tpl: Template engine object
2064 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2065 $sktemplate: SkinTemplate object
2066 $res: set to true to prevent active tabs
2068 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2069 You can either create your own array, or alter the parameters for
2070 the normal one.
2071 &$sktemplate: The SkinTemplate instance.
2072 $title: Title instance for the page.
2073 $message: Visible label of tab.
2074 $selected: Whether this is a selected tab.
2075 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2076 &$classes: Array of CSS classes to apply.
2077 &$query: Query string to add to link.
2078 &$text: Link text.
2079 &$result: Complete assoc. array if you want to return true.
2081 'SkinTemplateTabs': TODO
2083 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2084 been rendered (useful for adding more).
2085 $sk: The QuickTemplate based skin template running the hook.
2086 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2087   extensions that add support for BaseTemplateToolbox should watch for this
2088   dummy parameter with "$dummy=false" in their code and return without echoing
2089   any HTML to avoid creating duplicate toolbox items.
2091 'SoftwareInfo': Called by Special:Version for returning information about the
2092 software.
2093 $software: The array of software in format 'name' => 'version'. See
2094   SpecialVersion::softwareInformation().
2096 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2097 $id: User identifier
2099 'SpecialListusersDefaultQuery': Called right before the end of
2100 UsersPager::getDefaultQuery().
2101 $pager: The UsersPager instance
2102 $query: The query array to be returned
2104 'SpecialListusersFormatRow': Called right before the end of
2105 UsersPager::formatRow().
2106 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2107 $row: Database row object
2109 'SpecialListusersHeader': Called before closing the <fieldset> in
2110 UsersPager::getPageHeader().
2111 $pager: The UsersPager instance
2112 $out: The header HTML
2114 'SpecialListusersHeaderForm': Called before adding the submit button in
2115 UsersPager::getPageHeader().
2116 $pager: The UsersPager instance
2117 $out: The header HTML
2119 'SpecialListusersQueryInfo': Called right before the end of.
2120 UsersPager::getQueryInfo()
2121 $pager: The UsersPager instance
2122 $query: The query array to be returned
2124 'SpecialMovepageAfterMove': Called after moving a page.
2125 $movePage: MovePageForm object
2126 $oldTitle: old title (object)
2127 $newTitle: new title (object)
2129 'SpecialNewpagesConditions': Called when building sql query for
2130 Special:NewPages.
2131 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2132 $opts: FormOptions object containing special page options
2133 &$conds: array of WHERE conditionals for query
2134 &tables: array of tables to be queried
2135 &$fields: array of columns to select
2136 &$join_conds: join conditions for the tables
2138 'SpecialNewPagesFilters': Called after building form options at NewPages.
2139 $special: the special page object
2140 &$filters: associative array of filter definitions. The keys are the HTML
2141   name/URL parameters. Each key maps to an associative array with a 'msg'
2142   (message key) and a 'default' value.
2144 'SpecialPage_initList': Called when setting up SpecialPage::$mList, use this
2145 hook to remove a core special page.
2146 $list: list (array) of core special pages
2148 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2149 $special: the SpecialPage object
2150 $subPage: the subpage string or null if no subpage was specified
2152 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2153 $special: the SpecialPage object
2154 $subPage: the subpage string or null if no subpage was specified
2156 'SpecialPasswordResetOnSubmit': When executing a form submission on
2157 Special:PasswordReset.
2158 $users: array of User objects.
2159 $data: array of data submitted by the user
2160 &$error: string, error code (message key) used to describe to error (out
2161   parameter). The hook needs to return false when setting this, otherwise it
2162   will have no effect.
2164 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2165 use this to change some selection criteria or substitute a different title.
2166 &$randstr: The random number from wfRandom()
2167 &$isRedir: Boolean, whether to select a redirect or non-redirect
2168 &$namespaces: An array of namespace indexes to get the title from
2169 &$extra: An array of extra SQL statements
2170 &$title: If the hook returns false, a Title object to use instead of the
2171   result from the normal query
2173 'SpecialRecentChangesFilters': Called after building form options at
2174 RecentChanges.
2175 $special: the special page object
2176 &$filters: associative array of filter definitions. The keys are the HTML
2177   name/URL parameters. Each key maps to an associative array with a 'msg'
2178   (message key) and a 'default' value.
2180 'SpecialRecentChangesPanel': Called when building form options in
2181 SpecialRecentChanges.
2182 &$extraOpts: array of added items, to which can be added
2183 $opts: FormOptions for this request
2185 'SpecialRecentChangesQuery': Called when building SQL query for
2186 SpecialRecentChanges and SpecialRecentChangesLinked.
2187 &$conds: array of WHERE conditionals for query
2188 &$tables: array of tables to be queried
2189 &$join_conds: join conditions for the tables
2190 $opts: FormOptions for this request
2191 &$query_options: array of options for the database request
2192 &$select: Array of columns to select
2194 'SpecialSearchCreateLink': Called when making the message to create a page or
2195 go to the existing page.
2196 $t: title object searched for
2197 &$params: an array of the default message name and page title (as parameter)
2199 'SpecialSearchGo': Called when user clicked the "Go".
2200 &$title: title object generated from the text entered by the user
2201 &$term: the search term entered by the user
2203 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2204 target doesn't exist.
2205 &$title: title object generated from the text entered by the user
2207 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2208 the advanced form, a.k.a. power search box.
2209 &$showSections: an array to add values with more options to
2210 $term: the search term (not a title object)
2211 $opts: an array of hidden options (containing 'redirs' and 'profile')
2213 'SpecialSearchProfiles': Allows modification of search profiles.
2214 &$profiles: profiles, which can be modified.
2216 'SpecialSearchProfileForm': Allows modification of search profile forms.
2217 $search: special page object
2218 &$form: String: form html
2219 $profile: String: current search profile
2220 $term: String: search term
2221 $opts: Array: key => value of hidden options for inclusion in custom forms
2223 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2224 $search: SpecialSearch special page object
2225 $profile: String: current search profile
2226 $engine: the search engine
2228 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2229 on the search results page.  Useful for including an external search
2230 provider.  To disable the output of MediaWiki search output, return
2231 false.
2232 $specialSearch: SpecialSearch object ($this)
2233 $output: $wgOut
2234 $term: Search term specified by the user
2236 'SpecialSearchResultsAppend': Called after all search results HTML has
2237 been output.  Note that in some cases, this hook will not be called (no
2238 results, too many results, SpecialSearchResultsPrepend returned false,
2239 etc).
2240 $specialSearch: SpecialSearch object ($this)
2241 $output: $wgOut
2242 $term: Search term specified by the user
2244 'SpecialSearchResults': Called before search result display when there are
2245 matches.
2246 $term: string of search term
2247 &$titleMatches: empty or SearchResultSet object
2248 &$textMatches: empty or SearchResultSet object
2250 'SpecialSearchNoResults': Called before search result display when there are no
2251 matches.
2252 $term: string of search term
2254 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2255 &$extraStats: Array to save the new stats
2256   ( $extraStats['<name of statistic>'] => <value>; )
2258 'SpecialUploadComplete': Called after successfully uploading a file from
2259 Special:Upload.
2260 $form: The SpecialUpload object
2262 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2263 use this to change the tables headers.
2264 $extTypes: associative array of extensions types
2266 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2267 $wgVersion: Current $wgVersion for you to use
2268 &$versionUrl: Raw url to link to (eg: release notes)
2270 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2271 $special: the special page object
2272 &$filters: associative array of filter definitions. The keys are the HTML
2273   name/URL parameters. Each key maps to an associative array with a 'msg'
2274   (message key) and a 'default' value.
2276 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2277 &$conds: array of WHERE conditionals for query
2278 &$tables: array of tables to be queried
2279 &$join_conds: join conditions for the tables
2280 &$fields: array of query fields
2281 $values: array of variables with watchlist options
2283 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2284 URL for a title when we have no other parameters on the URL. Gives a chance for
2285 extensions that alter page view behavior radically to abort that redirect or
2286 handle it manually.
2287 $request: WebRequest
2288 $title: Title of the currently found title obj
2289 $output: OutputPage object
2291 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2292 rendered (by ThumbnailImage:toHtml method).
2293 $thumbnail: the ThumbnailImage object
2294 &$attribs: image attribute array
2295 &$linkAttribs: image link attribute array
2297 'TitleArrayFromResult': Called when creating an TitleArray object from a
2298 database result.
2299 &$titleArray: set this to an object to override the default object returned
2300 $res: database result used to create the object
2302 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2303 that can be applied.
2304 $title: The title in question.
2305 &$types: The types of protection available.
2307 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2308 $title: Title object that is being checked
2309 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2310   Hooks may change this value to override the return value of
2311   Title::isCssOrJsPage().
2313 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2314 overriding default behavior for determining if a page exists. If $isKnown is
2315 kept as null, regular checks happen. If it's a boolean, this value is returned
2316 by the isKnown method.
2317 $title: Title object that is being checked
2318 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2320 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2321 that this hook is not called for interwiki pages or pages in immovable
2322 namespaces: for these, isMovable() always returns false.
2323 $title: Title object that is being checked
2324 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2325   Hooks may change this value to override the return value of
2326   Title::isMovable().
2328 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2329 be handled by separate handler (via ArticleViewCustom).
2330 $title: Title object that is being checked
2331 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2332   Hooks may change this value to override the return value of
2333   Title::isWikitextPage()
2335 'TitleMoveComplete': After moving an article (title).
2336 $old: old title
2337 $nt: new title
2338 $user: user who did the move
2339 $pageid: database ID of the page that's been moved
2340 $redirid: database ID of the created redirect
2342 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2343 adding the default error message if nothing allows the user to read the page. If
2344 a handler wants a title to *not* be whitelisted, it should also return false.
2345 $title: Title object being checked against
2346 $user: Current user object
2347 &$whitelisted: Boolean value of whether this title is whitelisted
2349 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2350 PageArchive object has been created but before any further processing is done.
2351 &$archive: PageArchive object
2352 $title: Title object of the page that we're viewing
2354 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2355 PageArchive object has been created but before any further processing is done.
2356 &$archive: PageArchive object
2357 $title: Title object of the page that we're viewing
2359 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2360 the site is not in read-only mode, that the Title object is not null and after
2361 a PageArchive object has been constructed but before performing any further
2362 processing.
2363 &$archive: PageArchive object
2364 $title: Title object of the page that we're about to undelete
2366 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2367 $title: title object related to the revision
2368 $rev: revision (object) that will be viewed
2370 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2371 actions).
2372 $action: action name
2373 $article: article "acted on"
2375 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2376 &$files: list of files
2378 'UnwatchArticle': Before a watch is removed from an article.
2379 $user: user watching
2380 $page: WikiPage object to be removed
2382 'UnwatchArticleComplete': After a watch is removed from an article.
2383 $user: user that watched
2384 $page: WikiPage object that was watched
2386 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2387 $formattedPageStatus: list of valid page states
2389 'UploadForm:initial': Before the upload form is generated. You might set the
2390 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2391 text (HTML) either before or after the editform.
2392 $form: UploadForm object
2394 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2395 poke at member variables like $mUploadDescription before the file is saved. Do
2396 not use this hook to break upload processing. This will return the user to a
2397 blank form with no error message; use UploadVerification and UploadVerifyFile
2398 instead.
2399 $form: UploadForm object
2401 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2402 $type: (string) the requested upload type
2403 &$className: the class name of the Upload instance to be created
2405 'UploadComplete': when Upload completes an upload.
2406 &$upload: an UploadBase child instance
2408 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2409 assembled.
2410 $descriptor: (array) the HTMLForm descriptor
2412 'UploadFormSourceDescriptors': after the standard source inputs have been
2413 added to the descriptor
2414 $descriptor: (array) the HTMLForm descriptor
2416 'UploadVerification': Additional chances to reject an uploaded file. Consider
2417 using UploadVerifyFile instead.
2418 string $saveName: destination file name
2419 string $tempName: filesystem path to the temporary file for checks
2420 string &$error: output: message key for message to show if upload canceled by
2421   returning false. May also be an array, where the first element is the message
2422   key and the remaining elements are used as parameters to the message.
2424 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2425 in most cases over UploadVerification.
2426 object $upload: an instance of UploadBase, with all info about the upload
2427 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2428   will typically only apply for specific mime types.
2429 object &$error: output: true if the file is valid. Otherwise, an indexed array
2430   representing the problem with the file, where the first element is the message
2431   key and the remaining elements are used as parameters to the message.
2433 'UploadComplete': Upon completion of a file upload.
2434 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2435   $uploadBase->getLocalFile().
2437 'User::mailPasswordInternal': before creation and mailing of a user's new
2438 temporary password
2439 $user: the user who sent the message out
2440 $ip: IP of the user who sent the message out
2441 $u: the account whose new password will be set
2443 'UserAddGroup': Called when adding a group; return false to override
2444 stock group addition.
2445 $user: the user object that is to have a group added
2446 &$group: the group to add, can be modified
2448 'UserArrayFromResult': Called when creating an UserArray object from a database
2449 result.
2450 &$userArray: set this to an object to override the default object returned
2451 $res: database result used to create the object
2453 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2454 want to display an error message, try getUserPermissionsErrors.
2455 $title: Title object being checked against
2456 $user : Current user object
2457 $action: Action being checked
2458 $result: Pointer to result returned if hook returns false. If null is returned,
2459   userCan checks are continued by internal code.
2461 'UserCanSendEmail': To override User::canSendEmail() permission check.
2462 $user: User (object) whose permission is being checked
2463 &$canSend: bool set on input, can override on output
2465 'UserClearNewTalkNotification': Called when clearing the "You have new
2466 messages!" message, return false to not delete it.
2467 $user: User (object) that will clear the message
2469 'UserComparePasswords': Called when checking passwords, return false to
2470 override the default password checks.
2471 &$hash: String of the password hash (from the database)
2472 &$password: String of the plaintext password the user entered
2473 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2474   supplied
2475 &$result: If the hook returns false, this Boolean value will be checked to
2476   determine if the password was valid
2478 'UserCreateForm': change to manipulate the login form
2479 $template: SimpleTemplate instance for the form
2481 'UserCryptPassword': Called when hashing a password, return false to implement
2482 your own hashing method.
2483 &$password: String of the plaintext password to encrypt
2484 &$salt: String of the password salt or Boolean false if no salt is provided
2485 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2486   method
2487 &$hash: If the hook returns false, this String will be used as the hash
2489 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2490 $user: User to get groups for
2491 &$groups: Current effective groups
2493 'UserGetAllRights': After calculating a list of all available rights.
2494 &$rights: Array of rights, which may be added to.
2496 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2497 before returning the options to the caller. Warning: This hook is called for
2498 every call to User::getDefaultOptions(), which means it's potentially called
2499 dozens or hundreds of times. You may want to cache the results of non-trivial
2500 operations in your hook function for this reason.
2501 &$defaultOptions: Array of preference keys and their default values.
2503 'UserGetEmail': Called when getting an user email address.
2504 $user: User object
2505 &$email: email, change this to override local email
2507 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2508 email authentication.
2509 $user: User object
2510 &$timestamp: timestamp, change this to override local email authentication
2511   timestamp
2513 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2514 &$groups: List of implicit (automatically-assigned) groups
2516 'UserGetLanguageObject': Called when getting user's interface language object.
2517 $user: User object
2518 &$code: Language code that will be used to create the object
2519 $context: RequestContext object
2521 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2522 &$reservedUsernames: $wgReservedUsernames
2524 'UserGetRights': Called in User::getRights().
2525 $user: User to get rights for
2526 &$rights: Current rights
2528 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2529 specific block exemptions).
2530 $user: User in question
2531 $title: Title of the page in question
2532 &$blocked: Out-param, whether or not the user is blocked from that page.
2533 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2534   to edit their own user talk pages.
2536 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2537 &$user: User object
2538 $ip: User's IP address
2539 &$blocked: Whether the user is blocked, to be modified by the hook
2541 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2542 environmental means; occurs after session is loaded.
2543 $user: user object being loaded
2545 'UserLoadDefaults': Called when loading a default user.
2546 $user: user object
2547 $name: user name
2549 'UserLoadFromDatabase': Called when loading a user from the database.
2550 $user: user object
2551 &$s: database query object
2553 'UserLoadFromSession': Called to authenticate users on external/environmental
2554 means; occurs before session is loaded.
2555 $user: user object being loaded
2556 &$result: set this to a boolean value to abort the normal authentication
2557   process
2559 'UserLoadOptions': When user options/preferences are being loaded from the
2560 database.
2561 $user: User object
2562 &$options: Options, can be modified.
2564 'UserLoginComplete': After a user has logged in.
2565 $user: the user object that was created on login
2566 $inject_html: Any HTML to inject after the "logged in" message.
2568 'UserLoginForm': change to manipulate the login form
2569 $template: SimpleTemplate instance for the form
2571 'UserLogout': Before a user logs out.
2572 $user: the user object that is about to be logged out
2574 'UserLogoutComplete': After a user has logged out.
2575 $user: the user object _after_ logout (won't have name, ID, etc.)
2576 $inject_html: Any HTML to inject after the "logged out" message.
2577 $oldName: name of the user before logout (string)
2579 'UserRemoveGroup': Called when removing a group; return false to override stock
2580 group removal.
2581 $user: the user object that is to have a group removed
2582 &$group: the group to be removed, can be modified
2584 'UserRights': After a user's group memberships are changed.
2585 $user  : User object that was changed
2586 $add   : Array of strings corresponding to groups added
2587 $remove: Array of strings corresponding to groups removed
2589 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2590 message(s).
2591 $user: user retrieving new talks messages
2592 $talks: array of new talks page(s)
2594 'UserSaveSettings': Called when saving user settings.
2595 $user: User object
2597 'UserSaveOptions': Called just before saving user preferences/options.
2598 $user: User object
2599 &$options: Options, modifiable
2601 'UserSetCookies': Called when setting user cookies.
2602 $user: User object
2603 &$session: session array, will be added to $_SESSION
2604 &$cookies: cookies array mapping cookie name to its value
2606 'UserSetEmail': Called when changing user email address.
2607 $user: User object
2608 &$email: new email, change this to override new email address
2610 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2611 email authentication.
2612 $user: User object
2613 &$timestamp: new timestamp, change this to override local email
2614 authentication timestamp
2616 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2617 "Foobar (Talk | Contribs | Block)".
2618 $userId: User id of the current user
2619 $userText: User name of the current user
2620 &$items: Array of user tool links as HTML fragments
2622 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2623 used to alter the SQL query which gets the list of wanted pages.
2624 &$wantedPages: WantedPagesPage object
2625 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2627 'WatchArticle': Before a watch is added to an article.
2628 $user: user that will watch
2629 $page: WikiPage object to be watched
2631 'WatchArticleComplete': After a watch is added to an article.
2632 $user: user that watched
2633 $page: WikiPage object watched
2635 'WatchlistEditorBuildRemoveLine': when building remove lines in
2636 Special:Watchlist/edit.
2637 &$tools: array of extra links
2638 $title: Title object
2639 $redirect: whether the page is a redirect
2640 $skin: Skin object
2642 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2643 REQUEST_URI.
2644 $router: The PathRouter instance
2646 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2647 dumps. One, and only one hook should set this, and return false.
2648 &$tables: Database tables to use in the SELECT query
2649 &$opts: Options to use for the query
2650 &$join: Join conditions
2652 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2653 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2654 specific to a content model should be provided by the respective Content's
2655 getDeletionUpdates() method.
2656 $page: the WikiPage
2657 $content: the Content to generate updates for
2658 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2660 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2661 run a MediaWiki cli script.
2662 &$script: MediaWiki cli script path
2663 &$parameters: Array of arguments and options to the script
2664 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2665   keys
2667 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2668 query pages to be updated with maintenance/updateSpecialPages.php.
2669 $query: $wgQueryPages itself
2671 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2672 extra metadata to be added.
2673 $obj: The XmlDumpWriter object.
2674 &$out: The output string.
2675 $row: The database row for the page.
2676 $title: The title of the page.
2678 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2679 add extra metadata.
2680 $obj: The XmlDumpWriter object.
2681 &$out: The text being output.
2682 $row: The database row for the revision.
2683 $text: The revision text.
2685 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2686 to add additional tags to extract.
2687 &$items: Array containing information on which items to extract. See XMPInfo for
2688   details on the format.
2690 'XMPGetResults': Called just before returning the results array of parsing xmp
2691 data. Can be used to post-process the results.
2692 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2693   is an array of metadata tags returned (each tag is either a value, or an array
2694   of values).
2696 More hooks might be available but undocumented, you can execute
2697 'php maintenance/findHooks.php' to find hidden ones.