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.
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',
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.
21 The function part of a hook.
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);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
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);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
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));
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
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
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
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.
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:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
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
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) {
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.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
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
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
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).
265 $user: user who is doing the move
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
273 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
274 $name: name of the action
275 &$form: HTMLForm object
276 $article: Article object
278 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
279 Allows to change the fields on the form that will be generated.
280 $name: name of the action
281 &$fields: HTMLForm descriptor array
282 $article: Article object
284 'AddNewAccount': After a user account is created.
285 $user: the User object that was created. (Parameter added in 1.7)
286 $byEmail: true when account was created "by email" (added in 1.12)
288 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
289 ob_end_flush() which will send the buffered output to the client. This allows
290 for last-minute modification of the output within the buffer by using
292 &$output: OutputPage object
294 'AfterImportPage': When a page import is completed.
295 $title: Title under which the revisions were imported
296 $origTitle: Title provided by the XML file
297 $revCount: Number of revisions in the XML file
298 $sRevCount: Number of sucessfully imported revisions
299 $pageInfo: associative array of page information
301 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
302 before OutputPage::sendCacheControl() and final ob_end_flush() which
303 will send the buffered output to the client. This allows for last-minute
304 modification of the output within the buffer by using ob_get_clean().
305 $output: The OutputPage object where output() was called
307 'AjaxAddScript': Called in output page just before the initialisation
308 of the javascript ajax engine. The hook is only called when ajax
309 is enabled ( $wgUseAjax = true; ).
310 &$output: OutputPage object
312 'AlternateEdit': Before checking if a user can edit a page and before showing
313 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
314 $editPage: the EditPage object
316 'AlternateEditPreview': Before generating the preview of the page when editing
317 ( EditPage::getPreviewText() ).
318 $editPage: the EditPage object
319 &$content: the Content object for the text field from the edit page
320 &$previewHTML: Text to be placed into the page for the preview
321 &$parserOutput: the ParserOutput object for the preview
322 return false and set $previewHTML and $parserOutput to output custom page
325 'AlternateUserMailer': Called before mail is sent so that mail could be logged
326 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
327 the regular method of sending mail. Return a string to return a php-mail-error
328 message containing the error. Returning true will continue with sending email
330 $headers: Associative array of headers for the email
331 $to: MailAddress object or array
333 $subject: Subject of the email
334 $body: Body of the message
336 'APIAfterExecute': After calling the execute() method of an API module. Use
337 this to extend core API modules.
338 &$module: Module object
340 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
341 authenticate and authorize API clients before executing the module. Return
342 false and set a message to cancel the request.
343 $module: Module object
345 &$message: API usage message to die with, as a message key or array
346 as accepted by ApiBase::dieUsageMsg.
348 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
349 processing request parameters. Return false to let the request fail, returning
350 an error message or an <edit result="Failure"> tag if $resultArr was filled.
351 $editPage : the EditPage object
352 $text : the new text of the article (has yet to be saved)
353 &$resultArr : data in this array will be added to the API result
355 'APIGetAllowedParams': Use this hook to modify a module's parameters.
356 &$module: ApiBase Module object
357 &$params: Array of parameters
359 'APIGetDescription': Use this hook to modify a module's description.
360 &$module: ApiBase Module object
361 &$desc: Array of descriptions
363 'APIGetParamDescription': Use this hook to modify a module's parameter
365 &$module: ApiBase Module object
366 &$desc: Array of parameter descriptions
368 'APIGetResultProperties': Use this hook to mofify the propertiesin a module's
370 &$module: ApiBase Module object
371 &$properties: Array of properties
373 'APIQueryAfterExecute': After calling the execute() method of an
374 action=query submodule. Use this to extend core API modules.
375 &$module: Module object
377 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
378 an action=query submodule. Use this to extend core API modules.
379 &$module: Module object
380 &$resultPageSet: ApiPageSet object
382 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
383 token has an action, which will be used in the intoken parameter and in the
384 output (actiontoken="..."), and a callback function which should return the
385 token, or false if the user isn't allowed to obtain it. The prototype of the
386 callback function is func($pageid, $title), where $pageid is the page ID of the
387 page the token is requested for and $title is the associated Title object. In
388 the hook, just add your callback to the $tokenFunctions array and return true
389 (returning false makes no sense).
390 $tokenFunctions: array(action => callback)
392 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
393 Every token has an action, which will be used in the rvtoken parameter and in
394 the output (actiontoken="..."), and a callback function which should return the
395 token, or false if the user isn't allowed to obtain it. The prototype of the
396 callback function is func($pageid, $title, $rev), where $pageid is the page ID
397 of the page associated to the revision the token is requested for, $title the
398 associated Title object and $rev the associated Revision object. In the hook,
399 just add your callback to the $tokenFunctions array and return true (returning
400 false makes no sense).
401 $tokenFunctions: array(action => callback)
403 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
404 list=recentchanges. Every token has an action, which will be used in the rctoken
405 parameter and in the output (actiontoken="..."), and a callback function which
406 should return the token, or false if the user isn't allowed to obtain it. The
407 prototype of the callback function is func($pageid, $title, $rc), where $pageid
408 is the page ID of the page associated to the revision the token is requested
409 for, $title the associated Title object and $rc the associated RecentChange
410 object. In the hook, just add your callback to the $tokenFunctions array and
411 return true (returning false makes no sense).
412 $tokenFunctions: array(action => callback)
414 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
415 sites general information.
416 $module: the current ApiQuerySiteInfo module
417 &$results: array of results, add things here
419 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
420 token has an action, which will be used in the ustoken parameter and in the
421 output (actiontoken="..."), and a callback function which should return the
422 token, or false if the user isn't allowed to obtain it. The prototype of the
423 callback function is func($user) where $user is the User object. In the hook,
424 just add your callback to the $tokenFunctions array and return true (returning
425 false makes no sense).
426 $tokenFunctions: array(action => callback)
428 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
429 an exception is thrown during API action execution.
430 $apiMain: Calling ApiMain instance.
431 $e: Exception object.
433 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
434 should have its own entry in the $apis array and have a unique name, passed as
435 key for the array that represents the service data. In this data array, the
436 key-value-pair identified by the apiLink key is required.
437 &$apis: array of services
439 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
441 &$tokenTypes: supported token types in format 'type' => callback function
442 used to retrieve this type of tokens.
444 'ArticleAfterFetchContent': After fetching content of an article from the
445 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
446 $article: the article (object) being loaded from the database
447 &$content: the content (string) of the article
449 'ArticleAfterFetchContentObject': After fetching content of an article from the
451 $article: the article (object) being loaded from the database
452 &$content: the content of the article, as a Content object
454 'ArticleConfirmDelete': Before writing the confirmation form for article
456 $article: the article (object) being deleted
457 $output: the OutputPage object
458 &$reason: the reason (string) the article is being deleted
460 'ArticleContentOnDiff': Before showing the article content below a diff. Use
461 this to change the content in this area or how it is loaded.
462 $diffEngine: the DifferenceEngine
463 $output: the OutputPage object
465 'ArticleDelete': Before an article is deleted.
466 $wikiPage: the WikiPage (object) being deleted
467 $user: the user (object) deleting the article
468 $reason: the reason (string) the article is being deleted
469 $error: if the deletion was prohibited, the (raw HTML) error message to display
471 $status: Status object, modify this to throw an error. Overridden by $error
474 'ArticleDeleteComplete': After an article is deleted.
475 $wikiPage: the WikiPage that was deleted
476 $user: the user that deleted the article
477 $reason: the reason the article was deleted
478 $id: id of the article that was deleted
479 $content: the Content of the deleted page
480 $logEntry: the ManualLogEntry used to record the deletion
482 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
484 $wikiPage: WikiPage (object) of the user talk page
486 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
487 article has been changed.
488 $wikiPage: the WikiPage (object)
489 $editInfo: data holder that includes the parser output ($editInfo->output) for
490 that page after the change
491 $changed: bool for if the page was changed
493 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
494 recentchanges table, return false to not delete old entries.
495 $wikiPage: WikiPage (object) being modified
497 'ArticleFromTitle': when creating an article object from a title object using
498 Wiki::articleFromTitle().
499 $title: Title (object) used to create the article object
500 $article: Article (object) that will be returned
502 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
503 PageContentInsertComplete.
504 $wikiPage: WikiPage created
505 $user: User creating the article
507 $summary: Edit summary/comment
508 $isMinor: Whether or not the edit was marked as minor
509 $isWatch: (No longer used)
510 $section: (No longer used)
511 $flags: Flags passed to WikiPage::doEditContent()
512 $revision: New Revision of the article
514 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
515 $targetTitle: target title (object)
516 $destTitle: destination title (object)
518 'ArticlePageDataAfter': After loading data of an article from the database.
519 $wikiPage: WikiPage (object) whose data were loaded
520 $row: row (object) returned from the database server
522 'ArticlePageDataBefore': Before loading data of an article from the database.
523 $wikiPage: WikiPage (object) that data will be loaded
524 $fields: fileds (array) to load from the database
526 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
527 $wikiPage: the WikiPage being saved
528 $popts: parser options to be used for pre-save transformation
530 'ArticleProtect': Before an article is protected.
531 $wikiPage: the WikiPage being protected
532 $user: the user doing the protection
533 $protect: boolean whether this is a protect or an unprotect
534 $reason: Reason for protect
535 $moveonly: boolean whether this is for move only or not
537 'ArticleProtectComplete': After an article is protected.
538 $wikiPage: the WikiPage that was protected
539 $user: the user who did the protection
540 $protect: boolean whether it was a protect or an unprotect
541 $reason: Reason for protect
542 $moveonly: boolean whether it was for move only or not
544 'ArticlePurge': Before executing "&action=purge".
545 $wikiPage: WikiPage (object) to purge
547 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
548 revisions of an article.
549 &$title: Title object of the article
551 'ArticleRevisionUndeleted': After an article revision is restored.
552 $title: the article title
553 $revision: the revision
554 $oldPageID: the page ID of the revision when archived (may be null)
556 'ArticleRollbackComplete': After an article rollback is completed.
557 $wikiPage: the WikiPage that was edited
558 $user: the user who did the rollback
559 $revision: the revision the page was reverted back to
560 $current: the reverted revision
562 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
564 $wikiPage: the WikiPage (object) being saved
565 $user: the user (object) saving the article
566 $text: the new article text
567 $summary: the article summary (comment)
572 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
573 PageContentSaveComplete instead.
574 $wikiPage: WikiPage modified
575 $user: User performing the modification
577 $summary: Edit summary/comment
578 $isMinor: Whether or not the edit was marked as minor
579 $isWatch: (No longer used)
580 $section: (No longer used)
581 $flags: Flags passed to WikiPage::doEditContent()
582 $revision: New Revision of the article
583 $status: Status object about to be returned by doEditContent()
584 $baseRevId: the rev ID (or false) this edit was based on
586 'ArticleUndelete': When one or more revisions of an article are restored.
587 $title: Title corresponding to the article restored
588 $create: Whether or not the restoration caused the page to be created (i.e. it
589 didn't exist before).
590 $comment: The comment associated with the undeletion.
592 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
593 $pageArchive: the PageArchive object
594 &$logEntry: ManualLogEntry object
595 $user: User who is performing the log action
597 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
598 the user is redirected back to the page.
599 &$article: the article
600 &$sectionanchor: The section anchor link (e.g. "#overview" )
601 &$extraq: Extra query parameters which can be added via hooked functions
603 'ArticleViewFooter': After showing the footer section of an ordinary page view
604 $article: Article object
606 'ArticleViewHeader': Before the parser cache is about to be tried for article
608 &$article: the article
609 &$pcache: whether to try the parser cache or not
610 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
611 object to both indicate that the output is done and what parser output was used.
613 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
614 redirect was followed.
615 $article: target article (object)
617 'ArticleViewCustom': Allows to output the text of the article in a different
618 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
619 that it is preferrable to implement proper handing for a custom data type using
620 the ContentHandler facility.
621 $text: text of the page
622 $title: title of the page
623 $output: reference to $wgOut
625 'ArticleContentViewCustom': Allows to output the text of the article in a
626 different format than wikitext. Note that it is preferrable to implement proper
627 handing for a custom data type using the ContentHandler facility.
628 $content: content of the page, as a Content object
629 $title: title of the page
630 $output: reference to $wgOut
632 'AuthPluginAutoCreate': Called when creating a local account for an user logged
633 in from an external authentication method.
634 $user: User object created locally
636 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
637 Gives a chance for an extension to set it programattically to a variable class.
638 &$auth: the $wgAuth object, probably a stub
640 'AutopromoteCondition': Check autopromote condition for user.
641 $type: condition type
644 $result: result of checking autopromote condition
646 'BacklinkCacheGetPrefix': Allows to set prefix for a spefific link table.
650 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
651 certain title are fetched.
653 $title: title of the page to which backlinks are sought
654 &$conds: query conditions
656 'BadImage': When checking against the bad image list. Change $bad and return
657 false to override. If an image is "bad", it is not rendered inline in wiki
658 pages or galleries in category pages.
659 $name: Image name being checked
660 &$bad: Whether or not the image is "bad"
662 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
663 "noarticletext-nopermission" at Article::showMissingArticle().
664 $article: article object
666 'BeforeInitialize': Before anything is initialized in
667 MediaWiki::performRequest().
668 &$title: Title being used for request
670 &$output: OutputPage object
672 $request: WebRequest object
673 $mediaWiki: Mediawiki object
675 'BeforePageDisplay': Prior to outputting a page.
676 &$out: OutputPage object
679 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
680 override how the redirect is output by modifying, or by returning false and
681 taking over the output.
682 $out: OutputPage object
683 &$redirect: URL, modifiable
684 &$code: HTTP code (eg '301' or '302'), modifiable
686 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
687 $parser: Parser object
689 &$options: array of options to RepoGroup::findFile
690 &$descQuery: query string to add to thumbnail URL
692 FIXME: Where does the below sentence fit in?
693 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
695 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
696 $parser: Parser object
697 $title: title of the template
698 &$skip: skip this template and link it?
699 &$id: the id of the revision being parsed
701 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
702 &$parser: Parser object
703 &$ig: ImageGallery object
705 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
707 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
708 to a newly created user account.
709 &$injected_html: Any HTML to inject after the "logged in" message of a newly
712 'BitmapHandlerTransform': before a file is transformed, gives extension the
713 possibility to transform it themselves
714 $handler: BitmapHandler
716 &$scalerParams: Array with scaler parameters
717 &$mto: null, set to a MediaTransformOutput
719 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
720 normalizations have been performed, except for the $wgMaxImageArea check.
722 &$params: Array of parameters
723 &$checkImageAreaHookResult: null, set to true or false to override the
724 $wgMaxImageArea check result.
726 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
728 $block: Block object (which is set to be autoblocking)
729 &$blockIds: Array of block IDs of the autoblock
731 'BlockIp': Before an IP address or user is blocked.
732 $block: the Block object about to be saved
733 $user: the user _doing_ the block (not the one being blocked)
735 'BlockIpComplete': After an IP address or user is blocked.
736 $block: the Block object that was saved
737 $user: the user who did the block (not the one being blocked)
739 'BookInformation': Before information output on Special:Booksources.
740 $isbn: ISBN to show information for
741 $output: OutputPage object in use
743 'CanonicalNamespaces': For extensions adding their own namespaces or altering
745 &$namespaces: Array of namespace numbers with corresponding canonical names
747 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
748 $catpage: CategoryPage instance
750 'ChangePasswordForm': For extensions that need to add a field to the
751 ChangePassword form via the Preferences form.
752 &$extraFields: An array of arrays that hold fields like would be passed to the
755 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
756 &$changesList: ChangesList instance.
757 &$articlelink: HTML of link to article (already filled-in).
758 &$s: HTML of row that is being constructed.
759 &$rc: RecentChange instance.
760 $unpatrolled: Whether or not we are showing unpatrolled changes.
761 $watched: Whether or not the change is watched by the user.
763 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
764 $collationName: Name of the collation in question
765 &$collationObject: Null. Replace with a subclass of the Collation class that
766 implements the collation given in $collationName.
768 'ConfirmEmailComplete': Called after a user's email has been confirmed
770 $user: user (object) whose email is being confirmed
772 'ContentHandlerDefaultModelFor': Called when the default content model is determiend
773 for a given title. May be used to assign a different model for that title.
774 $title: the Title in question
775 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
777 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
778 content model name, but no entry for that model exists in $wgContentHandlers.
779 $modeName: the requested content model name
780 &$handler: set this to a ContentHandler object, if desired.
782 'ConvertContent': Called by AbstractContent::convert when a conversion to another
783 content model is requested.
784 $content: The Content object to be converted.
785 $toModel: The ID of the content model to convert to.
786 $lossy: boolean indicating whether lossy conversion is allowed.
787 &$result: Output parameter, in case the handler function wants to provide a
788 converted Content object. Note that $result->getContentModel() must return $toModel.
789 Handler functions that modify $result should generally return false to further
790 attempts at conversion.
792 'ContribsPager::getQueryInfo': Before the contributions query is about to run
793 &$pager: Pager object for contributions
794 &$queryInfo: The query for the contribs Pager
796 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
797 &$data: an array of results of all contribs queries
798 $pager: The ContribsPager object hooked into
799 $offset: Index offset, inclusive
800 $limit: Exact query limit
801 $descending: Query direction, false for ascending, true for descending
803 'ContributionsLineEnding': Called before a contributions HTML line is finished
804 $page: SpecialPage object for contributions
806 $row: the DB row for this line
807 &$classes: the classes to add to the surrounding <li>
809 'ContributionsToolLinks': Change tool links above Special:Contributions
811 $title: User page title
812 &$tools: Array of tool links
814 'CustomEditor': When invoking the page editor
815 $article: Article being edited
816 $user: User performing the edit
818 Return true to allow the normal editor to be used, or false
819 if implementing a custom editor, e.g. for a special namespace,
822 'DatabaseOraclePostInit': Called after initialising an Oracle database
823 &$db: the DatabaseOracle object
825 'Debug': Called when outputting a debug log line via wfDebug() or wfDebugLog()
826 $text: plaintext string to be output
827 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
829 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
830 $title: the diff page title (nullable)
831 &$oldId: the actual old Id to use in the diff
832 &$newId: the actual new Id to use in the diff (0 means current)
833 $old: the ?old= param value from the url
834 $new: the ?new= param value from the url
836 'DiffViewHeader': Called before diff display
837 $diff: DifferenceEngine object that's calling
838 $oldRev: Revision object of the "old" revision (may be null/invalid)
839 $newRev: Revision object of the "new" revision
841 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
843 $article: article (object) being viewed
844 $oldid: oldid (int) being viewed
846 'DoEditSectionLink': Override the HTML generated for section edit links
847 $skin: Skin object rendering the UI
848 $title: Title object for the title being linked to (may not be the same as
849 $wgTitle, if the section is included from a template)
850 $section: The designation of the section being pointed to, to be included in
851 the link, like "§ion=$section"
852 $tooltip: The default tooltip. Escape before using.
853 By default, this is wrapped in the 'editsectionhint' message.
854 &$result: The HTML to return, prefilled with the default plus whatever other
855 changes earlier hooks have made
856 $lang: The language code to use for the link in the wfMessage function
858 'EditFilter': Perform checks on an edit
859 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
860 $text: Contents of the edit box
861 $section: Section being edited
862 &$error: Error message to return
863 $summary: Edit summary for page
865 'EditFilterMerged': Post-section-merge edit filter.
866 DEPRECATED, use EditFilterMergedContent instead.
867 $editor: EditPage instance (object)
868 $text: content of the edit box
869 &$error: error message to return
870 $summary: Edit summary for page
872 'EditFilterMergedContent': Post-section-merge edit filter.
873 This may be triggered by the EditPage or any other facility that modifies page content.
874 Use the $status object to indicate whether the edit should be allowed, and to provide
875 a reason for disallowing it. Return false to abort the edit, and true to continue.
876 Returning true if $status->isOK() returns false means "don't save but continue user
877 interaction", e.g. show the edit form.
878 $context: object implementing the IContextSource interface.
879 $content: content of the edit box, as a Content object.
880 $status: Status object to represent errors, etc.
881 $summary: Edit summary for page
882 $user: the User object representing the user whois performing the edit.
883 $minoredit: whether the edit was marked as minor by the user.
885 'EditFormPreloadText': Allows population of the edit form when creating
887 &$text: Text to preload with
888 &$title: Title object representing the page being created
890 'EditFormInitialText': Allows modifying the edit form when editing existing
892 $editPage: EditPage object
894 'EditPage::attemptSave': Called before an article is
895 saved, that is before WikiPage::doEditContent() is called
896 $editpage_Obj: the current EditPage object
898 'EditPage::importFormData': allow extensions to read additional data
900 $editpage: EditPage instance
902 return value is ignored (should always return true)
904 'EditPage::showEditForm:fields': allows injection of form field into edit form
905 $editor: the EditPage instance for reference
906 $out: an OutputPage instance to write to
907 return value is ignored (should always return true)
909 'EditPage::showEditForm:initial': before showing the edit form
910 $editor: EditPage instance (object)
911 $out: an OutputPage instance to write to
913 Return false to halt editing; you'll need to handle error messages, etc.
914 yourself. Alternatively, modifying $error and returning true will cause the
915 contents of $error to be echoed at the top of the edit form as wikitext.
916 Return true without altering $error to allow the edit to proceed.
918 'EditPage::showStandardInputs:options': allows injection of form fields into
920 $editor: EditPage instance (object)
921 $out: an OutputPage instance to write to
922 &$tabindex: HTML tabindex of the last edit check/button
923 return value is ignored (should always be true)
925 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
926 when there's an edit conflict. Return false to halt normal diff output; in
927 this case you're responsible for computing and outputting the entire "conflict"
928 part, i.e., the "difference between revisions" and "your text" headers and
930 &$editor: EditPage instance
931 &$out: OutputPage instance
933 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
934 textarea in the edit form.
935 &$editpage: The current EditPage object
936 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
937 &$tabindex: HTML tabindex of the last edit check/button
939 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
941 &$editpage: The current EditPage object
942 &$checks: Array of edit checks like "watch this page"/"minor edit"
943 &$tabindex: HTML tabindex of the last edit check/button
945 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
946 textarea in the edit form.
947 &$toolbar: The toolbar HTMl
949 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
950 contribution/copyright notice.
951 $title: title of page being edited
952 &$msg: localization message name, overridable. Default is either
953 'copyrightwarning' or 'copyrightwarning2'.
955 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
956 modifying the wikitext that will be used in "Show changes". Note that it is
957 preferrable to implement diff handling for different data types using the
958 ContentHandler facility.
959 $editPage: EditPage object
960 &$newtext: wikitext that will be used as "your version"
962 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
963 "Show changes". Note that it is preferrable to implement diff handling for
964 different data types using the ContentHandler facility.
965 $editPage: EditPage object
966 &$newtext: wikitext that will be used as "your version"
968 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
969 Allow modifying the wikitext that will be previewed. Note that it is preferrable
970 to implement previews for different data types using the COntentHandler
972 $editPage: EditPage object
973 &$toparse: wikitext that will be parsed
975 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
976 previewed. Note that it is preferrable to implement previews for different data
977 types using the COntentHandler facility.
978 $editPage: EditPage object
979 &$content: Content object to be previewed (may be replaced by hook function)
981 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
982 &$editpage: The current EditPage object
983 &$res: the HTML of the error text
985 'EditPageTosSummary': Give a chance for site and per-namespace customizations
986 of terms of service summary link that might exist separately from the copyright
988 $title: title of page being edited
989 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
991 'EditSectionLink': Do not use, use DoEditSectionLink instead.
992 $skin: Skin rendering the UI
993 $title: Title being linked to
994 $section: Section to link to
996 &$result: Result (alter this to override the generated links)
997 $lang: The language code to use for the link in the wfMessage function
999 'EmailConfirmed': When checking that the user's email address is "confirmed".
1000 $user: User being checked
1001 $confirmed: Whether or not the email address is confirmed
1002 This runs before the other checks, such as anonymity and the real check; return
1003 true to allow those checks to occur, and false if checking is done.
1005 'EmailUser': Before sending email from one user to another.
1006 $to: address of receiving user
1007 $from: address of sending user
1008 $subject: subject of the mail
1009 $text: text of the mail
1011 'EmailUserCC': Before sending the copy of the email to the author.
1012 $to: address of receiving user
1013 $from: address of sending user
1014 $subject: subject of the mail
1015 $text: text of the mail
1017 'EmailUserComplete': After sending email from one user to another.
1018 $to: address of receiving user
1019 $from: address of sending user
1020 $subject: subject of the mail
1021 $text: text of the mail
1023 'EmailUserForm': After building the email user form object.
1024 $form: HTMLForm object
1026 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1028 $user: The user who is trying to email another user.
1029 $editToken: The user's edit token.
1030 &$hookErr: Out-param for the error. Passed as the parameters to
1031 OutputPage::showErrorPage.
1033 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1035 $ip: The ip address of the user
1037 'ExtensionTypes': Called when generating the extensions credits, use this to
1038 change the tables headers.
1039 &$extTypes: associative array of extensions types
1041 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1042 thumbnail file name.
1043 $thumbname: the base name of the thumbnail file
1044 &$params: the currently extracted params (has source name, temp or archived zone)
1046 'FetchChangesList': When fetching the ChangesList derivative for a particular
1048 $user: User the list is being fetched for
1049 &$skin: Skin object to be used with the list
1050 &$list: List object (defaults to NULL, change it to an object instance and
1051 return false override the list derivative used)
1053 'FileDeleteComplete': When a file is deleted.
1054 $file: reference to the deleted file
1055 $oldimage: in case of the deletion of an old image, the name of the old file
1056 $article: in case all revisions of the file are deleted a reference to the
1057 WikiFilePage associated with the file.
1058 $user: user who performed the deletion
1061 'FileTransformed': When a file is transformed and moved into storage.
1062 $file: reference to the File object
1063 $thumb: the MediaTransformOutput object
1064 $tmpThumbPath: The temporary file system path of the transformed file
1065 $thumbPath: The permanent storage path of the transformed file
1067 'FileUpload': When a file upload occurs.
1068 $file : Image object representing the file that was uploaded
1069 $reupload : Boolean indicating if there was a previously another image there or
1071 $hasDescription : Boolean indicating that there was already a description page
1072 and a new one from the comment wasn't created (since 1.17)
1074 'FileUndeleteComplete': When a file is undeleted
1075 $title: title object to the file
1076 $fileVersions: array of undeleted versions. Empty if all versions were restored
1077 $user: user who performed the undeletion
1080 'FormatAutocomments': When an autocomment is formatted by the Linker.
1081 &$comment: Reference to the accumulated comment. Initially null, when set the
1082 default code will be skipped.
1083 $pre: Initial part of the parsed comment before the call to the hook.
1084 $auto: The extracted part of the parsed comment before the call to the hook.
1085 $post: The final part of the parsed comment before the call to the hook.
1086 $title: An optional title object used to links to sections. Can be null.
1087 $local: Boolean indicating whether section links should refer to local page.
1089 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1091 &$user: user to promote.
1092 &$promote: groups that will be added.
1094 'GetBlockedStatus': after loading blocking status of an user from the database
1095 $user: user (object) being checked
1097 'GetCacheVaryCookies': Get cookies that should vary cache options.
1098 $out: OutputPage object
1099 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1100 that have to vary cache options
1102 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1104 $title: Title object of page
1105 $url: string value as output (out parameter, can modify)
1106 $query: query options passed to Title::getCanonicalURL()
1108 'GetDefaultSortkey': Override the default sortkey for a page.
1109 $title: Title object that we need to get a sortkey for
1110 &$sortkey: Sortkey to use.
1112 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1113 underscore) magic words. Called by MagicWord.
1114 &$doubleUnderscoreIDs: array of strings
1116 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1117 $title: Title object of page
1118 $url: string value as output (out parameter, can modify)
1119 $query: query options passed to Title::getFullURL()
1121 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1122 $title: Title object of page
1123 $url: string value as output (out parameter, can modify)
1124 $query: query options passed to Title::getInternalURL()
1126 'GetIP': modify the ip of the current user (called only once).
1127 &$ip: string holding the ip as determined so far
1129 'GetLinkColours': modify the CSS class of an array of page links.
1130 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1132 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1134 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1135 working with internal urls (non-interwiki) then it may be preferable to work
1136 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1137 be buggy for internal urls on render if you do not re-implement the horrible
1138 hack that Title::getLocalURL uses in your own extension.
1139 $title: Title object of page
1140 &$url: string value as output (out parameter, can modify)
1141 $query: query options passed to Title::getLocalURL()
1143 'GetLocalURL::Internal': Modify local URLs to internal pages.
1144 $title: Title object of page
1145 &$url: string value as output (out parameter, can modify)
1146 $query: query options passed to Title::getLocalURL()
1148 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1149 without any fancy queries or variants.
1150 $title: Title object of page
1151 &$url: string value as output (out parameter, can modify)
1153 'GetMetadataVersion': Modify the image metadata version currently in use. This
1154 is used when requesting image metadata from a ForiegnApiRepo. Media handlers
1155 that need to have versioned metadata should add an element to the end of the
1156 version array of the form 'handler_name=version'. Most media handlers won't need
1157 to do this unless they broke backwards compatibility with a previous version of
1158 the media handler metadata output.
1159 &$version: Array of version strings
1161 'GetPreferences': Modify user preferences.
1162 $user: User whose preferences are being modified.
1163 &$preferences: Preferences description array, to be fed to an HTMLForm object
1165 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1166 checked for. Use instead of userCan for most cases. Return false if the user
1167 can't do it, and populate $result with the reason in the form of
1168 array( messagename, param1, param2, ... ). For consistency, error messages
1169 should be plain text with no special coloring, bolding, etc. to show that
1170 they're errors; presenting them properly to the user as errors is done by the
1172 $title: Title object being checked against
1173 $user : Current user object
1174 $action: Action being checked
1175 $result: User permissions error to add. If none, return true.
1177 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1178 called only if expensive checks are enabled. Add a permissions error when
1179 permissions errors are checked for. Return false if the user can't do it, and
1180 populate $result with the reason in the form of array( messagename, param1,
1181 param2, ... ). For consistency, error messages should be plain text with no
1182 special coloring, bolding, etc. to show that they're errors; presenting them
1183 properly to the user as errors is done by the caller.
1185 $title: Title object being checked against
1186 $user : Current user object
1187 $action: Action being checked
1188 $result: User permissions error to add. If none, return true.
1190 'GitViewers': Called when generating the list of git viewers for
1191 Special:Version, use this to change the list.
1192 &$extTypes: associative array of repo URLS to viewer URLs.
1194 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1195 image insertion. You can skip the default logic entirely by returning false, or
1196 just modify a few things using call-by-reference.
1198 &$title: Title object of the image
1199 &$file: File object, or false if it doesn't exist
1200 &$frameParams: Various parameters with special meanings; see documentation in
1201 includes/Linker.php for Linker::makeImageLink
1202 &$handlerParams: Various parameters with special meanings; see documentation in
1203 includes/Linker.php for Linker::makeImageLink
1204 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1205 &$res: Final HTML output, used if you return false
1208 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1209 the image on an image page.
1210 $imagePage: ImagePage object ($this)
1213 'ImagePageAfterImageLinks': Called after the image links section on an image
1215 $imagePage: ImagePage object ($this)
1216 &$html: HTML for the hook to add
1218 'ImagePageFileHistoryLine': Called when a file history line is contructed.
1220 $line: the HTML of the history line
1221 $css: the line CSS class
1223 'ImagePageFindFile': Called when fetching the file associated with an image
1225 $page: ImagePage object
1227 &$displayFile: displayed File object
1229 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1230 $page: ImagePage object
1231 &$toc: Array of <li> strings
1233 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1235 &$title: the Title object of the file as it would appear for the upload page
1236 &$path: the original file and path name when img_auth was invoked by the the web
1238 &$name: the name only component of the file
1239 &$result: The location to pass back results of the hook routine (only used if
1241 $result[0]=The index of the header message
1242 $result[1]=The index of the body text message
1243 $result[2 through n]=Parameters passed to body text message. Please note the
1244 header message cannot receive/use parameters.
1246 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1247 $reader: XMLReader object
1248 $logInfo: Array of information
1249 Return false to stop further processing of the tag
1251 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1252 $reader: XMLReader object
1253 $pageInfo: Array of information
1254 Return false to stop further processing of the tag
1256 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1257 $reader: XMLReader object
1258 $pageInfo: Array of page information
1259 $revisionInfo: Array of revision information
1260 Return false to stop further processing of the tag
1262 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1263 $reader: XMLReader object
1264 Return false to stop further processing of the tag
1266 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1267 $reader: XMLReader object
1268 $revisionInfo: Array of information
1269 Return false to stop further processing of the tag
1271 'InfoAction': When building information to display on the action=info page.
1272 $context: IContextSource object
1273 &$pageInfo: Array of information
1275 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1276 $title: Title object ($wgTitle)
1277 $request: WebRequest
1278 $ignoreRedirect: boolean to skip redirect check
1279 $target: Title/string of redirect target
1280 $article: Article object
1282 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1283 Return true without providing an interwiki to continue interwiki search.
1284 $prefix: interwiki prefix we are looking for.
1285 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1286 iw_trans and optionally iw_api and iw_wikiid.
1288 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1289 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1290 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1291 template/parser function execution which respect nowiki and HTML-comments.
1292 &$parser: Parser object
1293 &$text: string containing partially parsed text
1294 &$stripState: Parser's internal StripState object
1296 'InternalParseBeforeLinks': during Parser's internalParse method before links
1297 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1298 &$parser: Parser object
1299 &$text: string containing partially parsed text
1300 &$stripState: Parser's internal StripState object
1302 'InvalidateEmailComplete': Called after a user's email has been invalidated
1304 $user: user (object) whose email is being invalidated
1306 'IRCLineURL': When constructing the URL to use in an IRC notification.
1307 Callee may modify $url and $query, URL will be constructed as $url . $query
1308 &$url: URL to index.php
1309 &$query: Query string
1311 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1312 $article: article (object) being checked
1314 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1316 $result: Change this value to override the result of wfIsTrustedProxy()
1318 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1319 instance to return false if the domain name doesn't match your organization.
1320 $addr: The e-mail address entered by the user
1321 &$result: Set this and return false to override the internal checks
1323 'isValidPassword': Override the result of User::isValidPassword()
1324 $password: The password entered by the user
1325 &$result: Set this and return false to override the internal checks
1326 $user: User the password is being validated for
1328 'Language::getMessagesFileName':
1329 $code: The language code or the language we're looking for a messages file for
1330 &$file: The messages file path, you can override this to change the location.
1332 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1333 remove namespaces. Do not use this hook to add namespaces. Use
1334 CanonicalNamespaces for that.
1335 &$namespaces: Array of namespaces indexed by their numbers
1337 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1338 $wgExtensionMessagesFiles instead.
1339 Use this to define synonyms of magic words depending of the language
1340 $magicExtensions: associative array of magic words synonyms
1341 $lang: laguage code (string)
1343 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1344 listed in $wgExtensionMessagesFiles instead.
1345 Use to define aliases of special pages names depending of the language
1346 $specialPageAliases: associative array of magic words synonyms
1347 $lang: laguage code (string)
1349 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1350 &$names: array of language code => language name
1351 $code language of the preferred translations
1353 'LinkBegin': Used when generating internal and interwiki links in
1354 Linker::link(), before processing starts. Return false to skip default
1355 processing and return $ret. See documentation for Linker::link() for details on
1356 the expected meanings of parameters.
1357 $skin: the Skin object
1358 $target: the Title that the link is pointing to
1359 &$html: the contents that the <a> tag should have (raw HTML); null means
1361 &$customAttribs: the HTML attributes that the <a> tag should have, in
1362 associative array form, with keys and values unescaped. Should be merged with
1363 default values, with a value of false meaning to suppress the attribute.
1364 &$query: the query string to add to the generated URL (the bit after the "?"),
1365 in associative array form, with keys and values unescaped.
1366 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1367 &$ret: the value to return if your hook returns false.
1369 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1370 just before the function returns a value. If you return true, an <a> element
1371 with HTML attributes $attribs and contents $html will be returned. If you
1372 return false, $ret will be returned.
1373 $skin: the Skin object
1374 $target: the Title object that the link is pointing to
1375 $options: the options. Will always include either 'known' or 'broken', and may
1376 include 'noclasses'.
1377 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1378 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1380 &$ret: the value to return if your hook returns false.
1382 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1384 &$url: the image url
1385 &$alt: the image's alt text
1386 &$img: the new image HTML (if returning false)
1388 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1391 &$text: the link text
1392 &$link: the new link HTML (if returning false)
1393 &$attribs: the attributes to be applied.
1394 $linkType: The external link type
1396 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1398 &$linksUpdate: the LinksUpdate object
1400 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1401 each link table insert. For example, pagelinks, imagelinks, externallinks.
1402 $linksUpdate: LinksUpdate object
1403 $table: the table to insert links to
1404 $insertions: an arry of links to insert
1406 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1407 including delete and insert, has completed for all link tables
1408 &$linksUpdate: the LinksUpdate object
1410 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1411 &$linksUpdate: the LinksUpdate object
1413 'ListDefinedTags': When trying to find all defined tags.
1414 &$tags: The list of tags.
1416 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1417 &updater: A DatabaseUpdater subclass
1419 'LocalFile::getHistory': Called before file history query performed.
1420 $file: the File object
1422 $fields: select fields
1424 $opts: query options
1425 $join_conds: JOIN conditions
1427 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1428 $file: the File object
1429 $archiveName: name of an old file version or false if it's the current one
1431 'LocalisationCacheRecache': Called when loading the localisation data into
1433 $cache: The LocalisationCache object
1434 $code: language code
1435 &$alldata: The localisation data from core and extensions
1437 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1438 Returning false will prevent the string from being added to the OutputPage.
1439 &$s: html string to show for the log extract
1440 $types: String or Array Log types to show
1441 $page: String or Title The page title to show log entries for
1442 $user: String The user who made the log entries
1443 $param: Associative Array with the following additional options:
1444 - lim Integer Limit of items to show, default is 50
1445 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1446 - showIfEmpty boolean Set to false if you don't want any output in case the
1447 loglist is empty if set to true (default), "No matching items in log" is
1448 displayed if loglist is empty
1449 - msgKey Array If you want a nice box with a message, set this to the key of
1450 the message. First element is the message key, additional optional elements
1451 are parameters for the key that are processed with
1452 wfMessage()->params()->parseAsBlock()
1453 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1455 - wrap String Wrap the message in html (usually something like
1456 "<div ...>$1</div>").
1457 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1459 'LoginAuthenticateAudit': A login attempt for a valid user account either
1460 succeeded or failed. No return data is accepted; this hook is for auditing only.
1461 $user: the User object being authenticated against
1462 $password: the password being submitted and found wanting
1463 $retval: a LoginForm class constant with authenticateUserData() return
1464 value (SUCCESS, WRONG_PASS, etc.).
1466 'LogLine': Processes a single log entry on Special:Log.
1467 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1468 logging.log_type database field.
1469 $log_action: string for the type of log action (e.g. 'delete', 'block',
1470 'create2'). Corresponds to logging.log_action database field.
1471 $title: Title object that corresponds to logging.log_namespace and
1472 logging.log_title database fields.
1473 $paramArray: Array of parameters that corresponds to logging.log_params field.
1474 Note that only $paramArray[0] appears to contain anything.
1475 &$comment: string that corresponds to logging.log_comment database field, and
1476 which is displayed in the UI.
1477 &$revert: string that is displayed in the UI, similar to $comment.
1478 $time: timestamp of the log entry (added in 1.12)
1480 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1482 $refreshLinks: RefreshLinks object
1484 'MagicWordwgVariableIDs': When definig new magic words IDs.
1485 $variableIDs: array of strings
1487 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1488 executed. Ideally, this hook should only be used to add variables that depend on
1489 the current page/request; static configuration should be added through
1490 ResourceLoaderGetConfigVars instead.
1491 &$vars: variable (or multiple variables) to be added into the output of
1492 Skin::makeVariablesScript
1493 $out: The OutputPage which called the hook, can be used to get the real title.
1495 'MarkPatrolled': Aefore an edit is marked patrolled.
1496 $rcid: ID of the revision to be marked patrolled
1497 $user: the user (object) marking the revision as patrolled
1498 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1499 sysop in order to mark an edit patrolled.
1501 'MarkPatrolledComplete': After an edit is marked patrolled.
1502 $rcid: ID of the revision marked as patrolled
1503 $user: user (object) who marked the edit patrolled
1504 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1505 sysop to patrol the edit.
1507 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1508 something completely different, after the basic globals have been set up, but
1509 before ordinary actions take place.
1511 $article: $wgArticle
1514 $request: $wgRequest
1515 $mediaWiki: The $mediawiki object
1517 'MessagesPreLoad': When loading a message from the database.
1518 $title: title of the message (string)
1519 $message: value (string), change it to the message you want to define
1521 'MessageCacheReplace': When a message page is changed. Useful for updating
1523 $title: name of the page changed.
1524 $text: new contents of the page.
1526 'ModifyExportQuery': Modify the query used by the exporter.
1527 $db: The database object to be queried.
1528 &$tables: Tables in the query.
1529 &$conds: Conditions in the query.
1530 &$opts: Options for the query.
1531 &$join_conds: Join conditions for the query.
1533 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1534 links have been rendered (useful for adding more). Note: this is only run for
1535 the Monobook skin. To add items to the toolbox you should use the
1536 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1538 $tools: array of tools
1540 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1541 and returning it for the skin to output. You can add items to the toolbox while
1542 still letting the skin make final decisions on skin-specific markup conventions
1544 &$sk: The BaseTemplate base skin template
1545 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1546 BaseTemplate::makeListItem for details on the format of individual items
1547 inside of this array.
1549 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1551 $index: Integer; the index of the namespace being checked.
1552 $result: Boolean; whether MediaWiki currently thinks that pages in this
1553 namespace are movable. Hooks may change this value to override the return
1554 value of MWNamespace::isMovable().
1556 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1558 $wikiPage: the WikiPage edited
1559 $rev: the new revision
1560 $baseID: the revision ID this was based off, if any
1561 $user: the editing user
1563 'NormalizeMessageKey': Called before the software gets the text of a message
1564 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1566 &$key: the message being looked up. Change this to something else to change
1567 what message gets displayed (string)
1568 &$useDB: whether or not to look up the message in the database (bool)
1569 &$langCode: the language code to get the message for (string) - or -
1570 whether to use the content language (true) or site language (false) (bool)
1571 &$transform: whether or not to expand variables and templates
1572 in the message (bool)
1574 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1575 return false to omit the line from RecentChanges and Watchlist special pages.
1576 &$changeslist: The OldChangesList instance.
1577 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1578 &$rc: The RecentChange object.
1580 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1581 can alter or append to the array of URLs for search & suggestion formats.
1582 &$urls: array of associative arrays with Url element attributes
1584 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1585 users and/or IP addresses too.
1586 $otherBlockLink: An array with links to other block logs
1587 $ip: The requested IP address or username
1589 'OutputPageBeforeHTML': A page has been processed by the parser and the
1590 resulting HTML is about to be displayed.
1591 $parserOutput: the parserOutput (object) that corresponds to the page
1592 $text: the text that will be displayed, in HTML (string)
1594 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1595 body tag to allow for extensions to add attributes to the body of the page they
1596 might need. Or to allow building extensions to add body classes that aren't of
1597 high enough demand to be included in core.
1598 $out: The OutputPage which called the hook, can be used to get the real title
1599 $sk: The Skin that called OutputPage::headElement
1600 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1602 'OutputPageCheckLastModified': when checking if the page has been modified
1603 since the last visit.
1604 &$modifiedTimes: array of timestamps.
1605 The following keys are set: page, user, epoch
1607 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1608 $out: OutputPage instance (object)
1609 $parserOutput: parserOutput instance being added in $out
1611 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1612 categories. Implementations should return false if they generate the category
1613 links, so the default link generation is skipped.
1614 $out: OutputPage instance (object)
1615 $categories: associative array, keys are category names, values are category
1616 types ("normal" or "hidden")
1617 $links: array, intended to hold the result. Must be an associative array with
1618 category types as keys and arrays of HTML links as values.
1620 'PageContentInsertComplete': After a new article is created.
1621 $wikiPage: WikiPage created
1622 $user: User creating the article
1623 $content: New content as a Content object
1624 $summary: Edit summary/comment
1625 $isMinor: Whether or not the edit was marked as minor
1626 $isWatch: (No longer used)
1627 $section: (No longer used)
1628 $flags: Flags passed to WikiPage::doEditContent()
1629 $revision: New Revision of the article
1631 'PageContentLanguage': Allows changing the language in which the content of a
1632 page is written. Defaults to the wiki content language ($wgContLang).
1633 $title: Title object
1634 &$pageLang: the page content language (either an object or a language code)
1635 $wgLang: the user language
1637 'PageContentSave': Before an article is saved.
1638 $wikiPage: the WikiPage (object) being saved
1639 $user: the user (object) saving the article
1640 $content: the new article content, as a Content object
1641 $summary: the article summary (comment)
1642 $isminor: minor flag
1643 $iswatch: watch flag
1646 'PageContentSaveComplete': After an article has been updated.
1647 $wikiPage: WikiPage modified
1648 $user: User performing the modification
1649 $content: New content, as a Content object
1650 $summary: Edit summary/comment
1651 $isMinor: Whether or not the edit was marked as minor
1652 $isWatch: (No longer used)
1653 $section: (No longer used)
1654 $flags: Flags passed to WikiPage::doEditContent()
1655 $revision: New Revision of the article
1656 $status: Status object about to be returned by doEditContent()
1657 $baseRevId: the rev ID (or false) this edit was based on
1659 'PageHistoryBeforeList': When a history page list is about to be constructed.
1660 $article: the article that the history is loading for
1662 'PageHistoryLineEnding' : Right before the end <li> is added to a history line.
1663 $row: the revision row for this line
1664 $s: the string representing this parsed line
1665 $classes: array containing the <li> element classes
1667 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1670 $queryInfo: the query parameters
1672 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1673 which depends on user options should install this hook and append its values to
1675 $hash: reference to a hash key string which can be modified
1677 'ParserAfterParse': Called from Parser::parse() just after the call to
1678 Parser::internalParse() returns.
1679 $parser: parser object
1680 $text: text being parsed
1681 $stripState: stripState used (object)
1683 'ParserAfterStrip': Called at end of parsing time.
1684 TODO: No more strip, deprecated ?
1685 $parser: parser object
1686 $text: text being parsed
1687 $stripState: stripState used (object)
1689 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1690 $parser: Parser object being used
1691 $text: text that'll be returned
1693 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1694 $parser: Parser object
1695 $text: text to parse
1696 $stripState: StripState instance being used
1698 'ParserBeforeStrip': Called at start of parsing time.
1699 TODO: No more strip, deprecated ?
1700 $parser: parser object
1701 $text: text being parsed
1702 $stripState: stripState used (object)
1704 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1705 $parser: Parser object being used
1708 'ParserClearState': Called at the end of Parser::clearState().
1709 $parser: Parser object being cleared
1711 'ParserCloned': Called when the parser is cloned.
1712 $parser: Newly-cloned Parser object
1714 'ParserFirstCallInit': Called when the parser initialises for the first time.
1715 &$parser: Parser object being cleared
1717 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1719 $parser: Parser object
1720 $varCache: array to store the value in case of multiples calls of the
1722 $index: index (string) of the magic
1723 $ret: value of the magic word (the hook should set it)
1724 $frame: PPFrame object to use for expanding any template variables
1726 'ParserGetVariableValueTs': Use this to change the value of the time for the
1727 {{LOCAL...}} magic word.
1728 $parser: Parser object
1729 $time: actual time (timestamp)
1731 'ParserGetVariableValueVarCache': use this to change the value of the variable
1732 cache or return false to not use it.
1733 $parser: Parser object
1734 $varCache: varaiable cache (array)
1736 'ParserLimitReport': Called at the end of Parser:parse() when the parser will
1737 include comments about size of the text parsed.
1738 $parser: Parser object
1739 $limitReport: text that will be included (without comment tags)
1741 'ParserMakeImageParams': Called before the parser make an image link, use this
1742 to modify the parameters of the image.
1743 $title: title object representing the file
1744 $file: file object that will be used to create the image
1745 &$params: 2-D array of parameters
1746 $parser: Parser object that called the hook
1748 'ParserSectionCreate': Called each time the parser creates a document section
1749 from wikitext. Use this to apply per-section modifications to HTML (like
1750 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1751 can begin in one section and end in another. Make sure your code can handle
1752 that case gracefully. See the EditSectionClearerLink extension for an example.
1753 $parser: the calling Parser instance
1754 $section: the section number, zero-based, but section 0 is usually empty
1755 &$sectionContent: ref to the content of the section. modify this.
1756 $showEditLinks: boolean describing whether this section has an edit link
1758 'ParserTestParser': Called when creating a new instance of Parser in
1759 maintenance/parserTests.inc.
1760 $parser: Parser object created
1762 'ParserTestGlobals': Allows to define globals for parser tests.
1763 &$globals: Array with all the globals which should be set for parser tests.
1764 The arrays keys serve as the globals names, its values are the globals values.
1766 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1767 run. Use when page save hooks require the presence of custom tables to ensure
1768 that tests continue to run properly.
1769 &$tables: array of table names
1771 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1772 my talk page, my contributions" etc).
1773 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1774 &$title: Title object representing the current page
1776 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1777 &$user : User performing the action
1778 $action : Action being performed
1779 &$result : Whether or not the action should be prevented
1780 Change $result and return false to give a definitive answer, otherwise
1781 the built-in rate limiting checks are used, if enabled.
1783 'PlaceNewSection': Override placement of new sections. Return false and put the
1784 merged text into $text to override the default behavior.
1785 $wikipage : WikiPage object
1786 $oldtext : the text of the article before editing
1787 $subject : subject of the new section
1788 &$text : text of the new section
1790 'PreferencesGetLegend': Override the text used for the <legend> of a
1791 preferences section.
1792 $form: the PreferencesForm object. This is a ContextSource as well
1793 $key: the section name
1794 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1796 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1797 AJAX search suggestions. Put results into &$results outparam and return false.
1798 $ns : array of int namespace keys to search in
1799 $search : search term (not guaranteed to be conveniently normalized)
1800 $limit : maximum number of results to return
1801 &$results : out param: array of page names (strings)
1803 'PrefsEmailAudit': Called when user changes their email address.
1804 $user: User (object) changing his email address
1805 $oldaddr: old email address (string)
1806 $newaddr: new email address (string)
1808 'PrefsPasswordAudit': Called when user changes his password.
1809 $user: User (object) changing his passoword
1810 $newPass: new password
1811 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1813 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1815 $article: the title being (un)protected
1816 $output: a string of the form HTML so far
1818 'ProtectionForm::save': Called when a protection form is submitted.
1819 $article: the title being (un)protected
1820 $errorMsg: an html message string of an error or an array of message name and
1823 'ProtectionForm::showLogExtract': Called after the protection log extract is
1825 $article: the page the form is shown for
1826 $out: OutputPage object
1828 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1829 &$obj: RawPage object
1830 &$text: The text that's going to be the output
1832 'RecentChange_save': Called at the end of RecentChange::save().
1833 $recentChange: RecentChange object
1835 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1836 names such as "oldid" that are preserved when using redirecting special pages
1837 such as Special:MyPage and Special:MyTalk.
1838 &$redirectParams: An array of parameters preserved by redirecting special pages.
1840 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
1841 instance. Can be used by an extension override what skin is used in certain
1843 IContextSource $context: The RequestContext the skin is being created for.
1844 &$skin: A variable reference you may set a Skin instance or string key on to
1845 override the skin that will be used for the context.
1847 'ResourceLoaderGetConfigVars': Called at the end of
1848 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1849 configuration variables to JavaScript. Things that depend on the current page
1850 or request state must be added through MakeGlobalVariablesScript instead.
1851 &$vars: array( variable name => value )
1853 'ResourceLoaderGetStartupModules': Run once the startup module is being
1854 generated. This allows you to add modules to the startup module. This hook
1855 should be used sparingly since any module added here will be loaded on all
1856 pages. This hook is useful if you want to make code available to module loader
1859 'ResourceLoaderRegisterModules': Right before modules information is required,
1860 such as when responding to a resource
1861 loader request or generating HTML output.
1862 &$resourceLoader: ResourceLoader object
1864 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
1865 called after the addition of 'qunit' and MediaWiki testing resources.
1866 &testModules: array of JavaScript testing modules. The 'qunit' framework,
1867 included in core, is fed using tests/qunit/QUnitTestResources.php.
1868 &ResourceLoader object
1870 To add a new qunit module named 'myext.tests':
1871 testModules['qunit']['myext.tests'] = array(
1872 'script' => 'extension/myext/tests.js',
1873 'dependencies' => <any module dependency you might have>
1875 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
1876 added to any module.
1878 'RevisionInsertComplete': Called after a revision is inserted into the database.
1879 &$revision: the Revision
1880 $data: the data stored in old_text. The meaning depends on $flags: if external
1881 is set, it's the URL of the revision text in external storage; otherwise,
1882 it's the revision text itself. In either case, if gzip is set, the revision
1884 $flags: a comma-delimited list of strings representing the options used. May
1885 include: utf8 (this will always be set for new revisions); gzip; external.
1887 'SearchUpdate': Prior to search update completion.
1889 $namespace : Page namespace
1891 $text : Current text being indexed
1893 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
1894 the normal operations.
1895 $allSearchTerms : Array of the search terms in all content languages
1896 &$titleResult : Outparam; the value to return. A Title object or null.
1898 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
1899 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
1901 $term : Search term string
1902 &$title : Outparam; set to $title object and return false for a match
1904 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1905 if nothing was found.
1906 $term : Search term string
1907 &$title : Outparam; set to $title object and return false for a match
1909 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
1911 $term : Search term string
1912 &$title : Current Title object that is being returned (null if none found).
1914 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1915 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1916 in the $searchEngine->namespaces array.
1917 $query : Original query.
1918 &$parsed : Resultant query with the prefixes stripped.
1920 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1922 $title : Current Title object being displayed in search results.
1923 &$id: Revision ID (default is false, for latest)
1925 'SearchableNamespaces': An option to modify which namespaces are searchable.
1926 &$arr : Array of namespaces ($nsId => $name) which will be used.
1928 'SeleniumSettings': TODO
1930 'SetupAfterCache': Called in Setup.php, after cache objects are set
1932 'ShowMissingArticle': Called when generating the output for a non-existent page.
1933 $article: The article object corresponding to the page
1935 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1936 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1937 $text: Text being shown
1938 $title: Title of the custom script/stylesheet page
1939 $output: Current OutputPage object
1941 'ShowSearchHitTitle': Customise display of search hit title/link.
1942 &$title: Title to link to
1943 &$text: Text to use for the link
1944 $result: The search result
1945 $terms: The search terms entered
1946 $page: The SpecialSearch object.
1948 'ShowSearchHit': Customize display of search hit.
1949 $searchPage: The SpecialSearch instance.
1950 $result: The SearchResult to show
1951 $terms: Search terms, for highlighting
1952 &$link: HTML of link to the matching page. May be modified.
1953 &$redirect: HTML of redirect info. May be modified.
1954 &$section: HTML of matching section. May be modified.
1955 &$extract: HTML of content extract. May be modified.
1956 &$score: HTML of score. May be modified.
1957 &$size: HTML of page size. May be modified.
1958 &$date: HTML of of page modification date. May be modified.
1959 &$related: HTML of additional info for the matching page. May be modified.
1960 &$html: May be set to the full HTML that should be used to represent the search
1961 hit. Must include the <li> ... </li> tags. Will only be used if the hook
1962 function returned false.
1964 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
1965 allow the normal method of notice selection/rendering to work, or change the
1966 value of $siteNotice and return false to alter it.
1967 &$siteNotice: HTML returned as the sitenotice
1970 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
1971 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
1972 the sitenotice/anonnotice.
1975 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
1977 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
1978 the stock bottom scripts.
1980 'SkinAfterContent': Allows extensions to add text after the page content and
1981 article metadata. This hook should work in all skins. Set the &$data variable to
1982 the text you're going to add.
1983 &$data: (string) Text to be printed out directly (without parsing)
1986 'SkinBuildSidebar': At the end of Skin::buildSidebar().
1988 &$bar: Sidebar contents
1989 Modify $bar to add or modify sidebar portlets.
1991 'SkinCopyrightFooter': Allow for site and per-namespace customization of
1993 $title: displayed page title
1994 $type: 'normal' or 'history' for old/diff views
1995 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
1996 message must be in HTML format, not wikitext!
1997 &$link: overridable HTML link to be passed into the message as $1
1998 &$forContent: overridable flag if copyright footer is shown in content language.
2000 'SkinGetPoweredBy': TODO
2001 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2002 the MediaWiki icon but plain text instead.
2005 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2006 &$subpages: Subpage links HTML
2008 $out: OutputPage object
2009 If false is returned $subpages will be used instead of the HTML
2010 subPageSubtitle() generates.
2011 If true is returned, $subpages will be ignored and the rest of
2012 subPageSubtitle() will run.
2014 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2016 $sktemplate: SkinTemplate object
2017 $nav_urls: array of tabs
2019 To alter the structured navigation links in SkinTemplates, there are three
2020 hooks called in different spots:
2022 'SkinTemplateNavigation': Called on content pages after the tabs have been
2023 added, but before variants have been added.
2024 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2025 tab is added but before variants have been added.
2026 'SkinTemplateNavigation::Universal': Called on both content and special pages
2027 after variants have been added.
2028 &$sktemplate: SkinTemplate object
2029 &$links: Structured navigation links. This is used to alter the navigation for
2030 skins which use buildNavigationUrls such as Vector.
2032 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2034 &$sktemplate: SkinTemplate object
2035 &$tpl: Template engine object
2037 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2038 $sktemplate: SkinTemplate object
2039 $res: set to true to prevent active tabs
2041 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2042 You can either create your own array, or alter the parameters for
2044 &$sktemplate: The SkinTemplate instance.
2045 $title: Title instance for the page.
2046 $message: Visible label of tab.
2047 $selected: Whether this is a selected tab.
2048 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2049 &$classes: Array of CSS classes to apply.
2050 &$query: Query string to add to link.
2052 &$result: Complete assoc. array if you want to return true.
2054 'SkinTemplateTabs': TODO
2056 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2057 been rendered (useful for adding more).
2058 $sk: The QuickTemplate based skin template running the hook.
2059 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2060 extensions that add support for BaseTemplateToolbox should watch for this
2061 dummy parameter with "$dummy=false" in their code and return without echoing
2062 any HTML to avoid creating duplicate toolbox items.
2064 'SoftwareInfo': Called by Special:Version for returning information about the
2066 $software: The array of software in format 'name' => 'version'. See
2067 SpecialVersion::softwareInformation().
2069 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2070 $id: User identifier
2072 'SpecialListusersDefaultQuery': Called right before the end of
2073 UsersPager::getDefaultQuery().
2074 $pager: The UsersPager instance
2075 $query: The query array to be returned
2077 'SpecialListusersFormatRow': Called right before the end of
2078 UsersPager::formatRow().
2079 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2080 $row: Database row object
2082 'SpecialListusersHeader': Called before closing the <fieldset> in
2083 UsersPager::getPageHeader().
2084 $pager: The UsersPager instance
2085 $out: The header HTML
2087 'SpecialListusersHeaderForm': Called before adding the submit button in
2088 UsersPager::getPageHeader().
2089 $pager: The UsersPager instance
2090 $out: The header HTML
2092 'SpecialListusersQueryInfo': Called right before the end of.
2093 UsersPager::getQueryInfo()
2094 $pager: The UsersPager instance
2095 $query: The query array to be returned
2097 'SpecialMovepageAfterMove': Called after moving a page.
2098 $movePage: MovePageForm object
2099 $oldTitle: old title (object)
2100 $newTitle: new title (object)
2102 'SpecialNewpagesConditions': Called when building sql query for
2104 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2105 $opts: FormOptions object containing special page options
2106 &$conds: array of WHERE conditionals for query
2107 &tables: array of tables to be queried
2108 &$fields: array of columns to select
2109 &$join_conds: join conditions for the tables
2111 'SpecialNewPagesFilters': Called after building form options at NewPages.
2112 $special: the special page object
2113 &$filters: associative array of filter definitions. The keys are the HTML
2114 name/URL parameters. Each key maps to an associative array with a 'msg'
2115 (message key) and a 'default' value.
2117 'SpecialPage_initList': Called when setting up SpecialPage::$mList, use this
2118 hook to remove a core special page.
2119 $list: list (array) of core special pages
2121 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2122 $special: the SpecialPage object
2123 $subPage: the subpage string or null if no subpage was specified
2125 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2126 $special: the SpecialPage object
2127 $subPage: the subpage string or null if no subpage was specified
2129 'SpecialPasswordResetOnSubmit': When executing a form submission on
2130 Special:PasswordReset.
2131 $users: array of User objects.
2132 $data: array of data submitted by the user
2133 &$error: string, error code (message key) used to describe to error (out
2134 parameter). The hook needs to return false when setting this, otherwise it
2135 will have no effect.
2137 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2138 use this to change some selection criteria or substitute a different title.
2139 &$randstr: The random number from wfRandom()
2140 &$isRedir: Boolean, whether to select a redirect or non-redirect
2141 &$namespaces: An array of namespace indexes to get the title from
2142 &$extra: An array of extra SQL statements
2143 &$title: If the hook returns false, a Title object to use instead of the
2144 result from the normal query
2146 'SpecialRecentChangesFilters': Called after building form options at
2148 $special: the special page object
2149 &$filters: associative array of filter definitions. The keys are the HTML
2150 name/URL parameters. Each key maps to an associative array with a 'msg'
2151 (message key) and a 'default' value.
2153 'SpecialRecentChangesPanel': Called when building form options in
2154 SpecialRecentChanges.
2155 &$extraOpts: array of added items, to which can be added
2156 $opts: FormOptions for this request
2158 'SpecialRecentChangesQuery': Called when building SQL query for
2159 SpecialRecentChanges and SpecialRecentChangesLinked.
2160 &$conds: array of WHERE conditionals for query
2161 &$tables: array of tables to be queried
2162 &$join_conds: join conditions for the tables
2163 $opts: FormOptions for this request
2164 &$query_options: array of options for the database request
2165 &$select: Array of columns to select
2167 'SpecialSearchCreateLink': Called when making the message to create a page or
2168 go to the existing page.
2169 $t: title object searched for
2170 &$params: an array of the default message name and page title (as parameter)
2172 'SpecialSearchGo': Valled when user clicked the "Go".
2173 &$title: title object generated from the text entered by the user
2174 &$term: the search term entered by the user
2176 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2177 target doesn't exist.
2178 &$title: title object generated from the text entered by the user
2180 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2181 the advanced form, a.k.a. power search box.
2182 &$showSections: an array to add values with more options to
2183 $term: the search term (not a title object)
2184 $opts: an array of hidden options (containing 'redirs' and 'profile')
2186 'SpecialSearchProfiles': Allows modification of search profiles.
2187 &$profiles: profiles, which can be modified.
2189 'SpecialSearchProfileForm': Allows modification of search profile forms.
2190 $search: special page object
2191 &$form: String: form html
2192 $profile: String: current search profile
2193 $term: String: search term
2194 $opts: Array: key => value of hidden options for inclusion in custom forms
2196 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2197 $search: SpecialSearch special page object
2198 $profile: String: current search profile
2199 $engine: the search engine
2201 'SpecialSearchResults': Called before search result display when there are
2203 $term: string of search term
2204 &$titleMatches: empty or SearchResultSet object
2205 &$textMatches: empty or SearchResultSet object
2207 'SpecialSearchNoResults': Called before search result display when there are no
2209 $term: string of search term
2211 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2212 &$extraStats: Array to save the new stats
2213 ( $extraStats['<name of statistic>'] => <value>; )
2215 'SpecialUploadComplete': Called after successfully uploading a file from
2217 $form: The SpecialUpload object
2219 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2220 use this to change the tables headers.
2221 $extTypes: associative array of extensions types
2223 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2224 $wgVersion: Current $wgVersion for you to use
2225 &$versionUrl: Raw url to link to (eg: release notes)
2227 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2228 $special: the special page object
2229 &$filters: associative array of filter definitions. The keys are the HTML
2230 name/URL parameters. Each key maps to an associative array with a 'msg'
2231 (message key) and a 'default' value.
2233 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2234 &$conds: array of WHERE conditionals for query
2235 &$tables: array of tables to be queried
2236 &$join_conds: join conditions for the tables
2237 &$fields: array of query fields
2239 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2240 URL for a title when we have no other parameters on the URL. Gives a chance for
2241 extensions that alter page view behavior radically to abort that redirect or
2243 $request: WebRequest
2244 $title: Title of the currently found title obj
2245 $output: OutputPage object
2247 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2248 rendered (by ThumbnailImage:toHtml method).
2249 $thumbnail: the ThumbnailImage object
2250 &$attribs: image attibute array
2251 &$linkAttribs: image link attribute array
2253 'TitleArrayFromResult': Called when creating an TitleArray object from a
2255 &$titleArray: set this to an object to override the default object returned
2256 $res: database result used to create the object
2258 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2259 that can be applied.
2260 $title: The title in question.
2261 &$types: The types of protection available.
2263 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2264 $title: Title object that is being checked
2265 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2266 Hooks may change this value to override the return value of
2267 Title::isCssOrJsPage().
2269 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2270 overriding default behaviour for determining if a page exists. If $isKnown is
2271 kept as null, regular checks happen. If it's a boolean, this value is returned
2272 by the isKnown method.
2273 $title: Title object that is being checked
2274 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2276 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2277 that this hook is not called for interwiki pages or pages in immovable
2278 namespaces: for these, isMovable() always returns false.
2279 $title: Title object that is being checked
2280 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2281 Hooks may change this value to override the return value of
2284 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2285 be handled by seperate handler (via ArticleViewCustom).
2286 $title: Title object that is being checked
2287 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2288 Hooks may change this value to override the return value of
2289 Title::isWikitextPage()
2291 'TitleMoveComplete': After moving an article (title).
2294 $user: user who did the move
2295 $pageid: database ID of the page that's been moved
2296 $redirid: database ID of the created redirect
2298 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2299 adding the default error message if nothing allows the user to read the page. If
2300 a handler wants a title to *not* be whitelisted, it should also return false.
2301 $title: Title object being checked against
2302 $user: Current user object
2303 &$whitelisted: Boolean value of whether this title is whitelisted
2305 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2306 PageArchive object has been created but before any further processing is done.
2307 &$archive: PageArchive object
2308 $title: Title object of the page that we're viewing
2310 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2311 PageArchive object has been created but before any further processing is done.
2312 &$archive: PageArchive object
2313 $title: Title object of the page that we're viewing
2315 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2316 the site is not in read-only mode, that the Title object is not null and after
2317 a PageArchive object has been constructed but before performing any further
2319 &$archive: PageArchive object
2320 $title: Title object of the page that we're about to undelete
2322 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2323 $title: title object related to the revision
2324 $rev: revision (object) that will be viewed
2326 'UnknownAction': An unknown "action" has occured (useful for defining your own
2328 $action: action name
2329 $article: article "acted on"
2331 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2332 &$files: list of files
2334 'UnwatchArticle': Before a watch is removed from an article.
2335 $user: user watching
2336 $page: WikiPage object to be removed
2338 'UnwatchArticleComplete': After a watch is removed from an article.
2339 $user: user that watched
2340 $page: WikiPage object that was watched
2342 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2343 $formattedPageStatus: list of valid page states
2345 'UploadForm:initial': Before the upload form is generated. You might set the
2346 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2347 text (HTML) either before or after the editform.
2348 $form: UploadForm object
2350 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2351 poke at member variables like $mUploadDescription before the file is saved. Do
2352 not use this hook to break upload processing. This will return the user to a
2353 blank form with no error message; use UploadVerification and UploadVerifyFile
2355 $form: UploadForm object
2357 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2358 $type: (string) the requested upload type
2359 &$className: the class name of the Upload instance to be created
2361 'UploadComplete': when Upload completes an upload.
2362 &$upload: an UploadBase child instance
2364 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2366 $descriptor: (array) the HTMLForm descriptor
2368 'UploadFormSourceDescriptors': after the standard source inputs have been
2369 added to the descriptor
2370 $descriptor: (array) the HTMLForm descriptor
2372 'UploadVerification': Additional chances to reject an uploaded file. Consider
2373 using UploadVerifyFile instead.
2374 string $saveName: destination file name
2375 string $tempName: filesystem path to the temporary file for checks
2376 string &$error: output: message key for message to show if upload canceled by
2377 returning false. May also be an array, where the first element is the message
2378 key and the remaining elements are used as parameters to the message.
2380 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2381 in most cases over UploadVerification.
2382 object $upload: an instance of UploadBase, with all info about the upload
2383 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2384 will typically only apply for specific mime types.
2385 object &$error: output: true if the file is valid. Otherwise, an indexed array
2386 representing the problem with the file, where the first element is the message
2387 key and the remaining elements are used as parameters to the message.
2389 'UploadComplete': Upon completion of a file upload.
2390 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2391 $uploadBase->getLocalFile().
2393 'User::mailPasswordInternal': before creation and mailing of a user's new
2395 $user: the user who sent the message out
2396 $ip: IP of the user who sent the message out
2397 $u: the account whose new password will be set
2399 'UserAddGroup': Called when adding a group; return false to override
2400 stock group addition.
2401 $user: the user object that is to have a group added
2402 &$group: the group to add, can be modified
2404 'UserArrayFromResult': Called when creating an UserArray object from a database
2406 &$userArray: set this to an object to override the default object returned
2407 $res: database result used to create the object
2409 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2410 want to display an error message, try getUserPermissionsErrors.
2411 $title: Title object being checked against
2412 $user : Current user object
2413 $action: Action being checked
2414 $result: Pointer to result returned if hook returns false. If null is returned,
2415 userCan checks are continued by internal code.
2417 'UserCanSendEmail': To override User::canSendEmail() permission check.
2418 $user: User (object) whose permission is being checked
2419 &$canSend: bool set on input, can override on output
2421 'UserClearNewTalkNotification': Called when clearing the "You have new
2422 messages!" message, return false to not delete it.
2423 $user: User (object) that'll clear the message
2425 'UserComparePasswords': Called when checking passwords, return false to
2426 override the default password checks.
2427 &$hash: String of the password hash (from the database)
2428 &$password: String of the plaintext password the user entered
2429 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2431 &$result: If the hook returns false, this Boolean value will be checked to
2432 determine if the password was valid
2434 'UserCreateForm': change to manipulate the login form
2435 $template: SimpleTemplate instance for the form
2437 'UserCryptPassword': Called when hashing a password, return false to implement
2438 your own hashing method.
2439 &$password: String of the plaintext password to encrypt
2440 &$salt: String of the password salt or Boolean false if no salt is provided
2441 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2443 &$hash: If the hook returns false, this String will be used as the hash
2445 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2446 $user: User to get groups for
2447 &$groups: Current effective groups
2449 'UserGetAllRights': After calculating a list of all available rights.
2450 &$rights: Array of rights, which may be added to.
2452 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2453 before returning the options to the caller. Warning: This hook is called for
2454 every call to User::getDefaultOptions(), which means it's potentially called
2455 dozens or hundreds of times. You may want to cache the results of non-trivial
2456 operations in your hook function for this reason.
2457 &$defaultOptions: Array of preference keys and their default values.
2459 'UserGetEmail': Called when getting an user email address.
2461 &$email: email, change this to override local email
2463 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2464 email authentification.
2466 &$timestamp: timestamp, change this to override local email authentification
2469 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2470 &$groups: List of implicit (automatically-assigned) groups
2472 'UserGetLanguageObject': Called when getting user's interface language object.
2474 &$code: Langauge code that will be used to create the object
2476 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2477 &$reservedUsernames: $wgReservedUsernames
2479 'UserGetRights': Called in User::getRights().
2480 $user: User to get rights for
2481 &$rights: Current rights
2483 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2484 specific block exemptions).
2485 $user: User in question
2486 $title: Title of the page in question
2487 &$blocked: Out-param, whether or not the user is blocked from that page.
2488 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2489 to edit their own user talk pages.
2491 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2493 $ip: User's IP address
2494 &$blocked: Whether the user is blocked, to be modified by the hook
2496 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2497 environmental means; occurs after session is loaded.
2498 $user: user object being loaded
2500 'UserLoadDefaults': Called when loading a default user.
2504 'UserLoadFromDatabase': Called when loading a user from the database.
2506 &$s: database query object
2508 'UserLoadFromSession': Called to authenticate users on external/environmental
2509 means; occurs before session is loaded.
2510 $user: user object being loaded
2511 &$result: set this to a boolean value to abort the normal authentification
2514 'UserLoadOptions': When user options/preferences are being loaded from the
2517 &$options: Options, can be modified.
2519 'UserLoginComplete': After a user has logged in.
2520 $user: the user object that was created on login
2521 $inject_html: Any HTML to inject after the "logged in" message.
2523 'UserLoginForm': change to manipulate the login form
2524 $template: SimpleTemplate instance for the form
2526 'UserLogout': Before a user logs out.
2527 $user: the user object that is about to be logged out
2529 'UserLogoutComplete': After a user has logged out.
2530 $user: the user object _after_ logout (won't have name, ID, etc.)
2531 $inject_html: Any HTML to inject after the "logged out" message.
2532 $oldName: name of the user before logout (string)
2534 'UserRemoveGroup': Called when removing a group; return false to override stock
2536 $user: the user object that is to have a group removed
2537 &$group: the group to be removed, can be modified
2539 'UserRights': After a user's group memberships are changed.
2540 $user : User object that was changed
2541 $add : Array of strings corresponding to groups added
2542 $remove: Array of strings corresponding to groups removed
2544 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2546 $user: user retrieving new talks messages
2547 $talks: array of new talks page(s)
2549 'UserSaveSettings': Called when saving user settings.
2552 'UserSaveOptions': Called just before saving user preferences/options.
2554 &$options: Options, modifiable
2556 'UserSetCookies': Called when setting user cookies.
2558 &$session: session array, will be added to $_SESSION
2559 &$cookies: cookies array mapping cookie name to its value
2561 'UserSetEmail': Called when changing user email address.
2563 &$email: new email, change this to override new email address
2565 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2566 email authentification.
2568 &$timestamp: new timestamp, change this to override local email
2569 authentification timestamp
2571 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2572 "Foobar (Talk | Contribs | Block)".
2573 $userId: User id of the current user
2574 $userText: User name of the current user
2575 &$items: Array of user tool links as HTML fragments
2577 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2578 used to alter the SQL query which gets the list of wanted pages.
2579 &$wantedPages: WantedPagesPage object
2580 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2582 'WatchArticle': Before a watch is added to an article.
2583 $user: user that will watch
2584 $page: WikiPage object to be watched
2586 'WatchArticleComplete': After a watch is added to an article.
2587 $user: user that watched
2588 $page: WikiPage object watched
2590 'WatchlistEditorBuildRemoveLine': when building remove lines in
2591 Special:Watchlist/edit.
2592 &$tools: array of extra links
2593 $title: Title object
2594 $redirect: whether the page is a redirect
2597 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2599 $router: The PathRouter instance
2601 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2602 dumps. One, and only one hook should set this, and return false.
2603 &$tables: Database tables to use in the SELECT query
2604 &$opts: Options to use for the query
2605 &$join: Join conditions
2607 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2608 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2609 specific to a content model should be provided by the respective Content's
2610 getDeletionUpdates() method.
2612 $content: the Content to generate updates for
2613 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2615 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2616 run a MediaWiki cli script.
2617 &$script: MediaWiki cli script path
2618 &$parameters: Array of arguments and options to the script
2619 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2622 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2623 query pages to be updated with maintenance/updateSpecialPages.php.
2624 $query: $wgQueryPages itself
2626 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2627 extra metadata to be added.
2628 $obj: The XmlDumpWriter object.
2629 &$out: The output string.
2630 $row: The database row for the page.
2631 $title: The title of the page.
2633 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2635 $obj: The XmlDumpWriter object.
2636 &$out: The text being output.
2637 $row: The database row for the revision.
2638 $text: The revision text.
2640 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2641 to add additional tags to extract.
2642 &$items: Array containing information on which items to extract. See XMPInfo for
2643 details on the format.
2645 'XMPGetResults': Called just before returning the results array of parsing xmp
2646 data. Can be used to post-process the results.
2647 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2648 is an array of metadata tags returned (each tag is either a value, or an array
2651 More hooks might be available but undocumented, you can execute
2652 'php maintenance/findHooks.php' to find hidden ones.