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