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