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.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortMove': Allows to abort moving an article (title).
266 $user: user who is doing the move
268 $reason: the reason for the move (added in 1.13)
270 'AbortNewAccount': Return false to cancel explicit account creation.
271 $user: the User object about to be created (read-only, incomplete)
272 &$msg: out parameter: HTML to display on abort
273 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
274 Create the object with Status::newFatal() to ensure proper API error messages
275 are returned when creating account through API clients.
277 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
278 $targetUser: the user whom to send talk page email notification
279 $title: the page title
281 'SendWatchlistEmailNotification': Return true to send watchlist email notification
282 $targetUser: the user whom to send watchlist email notification
283 $title: the page title
284 $enotif: EmailNotification object
286 'AbortChangePassword': Return false to cancel password change.
287 $user: the User object to which the password change is occuring
288 $mOldpass: the old password provided by the user
289 $newpass: the new password provided by the user
290 &$abortMsg: the message identifier for abort reason
292 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
293 $name: name of the action
294 &$form: HTMLForm object
295 $article: Article object
297 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
298 Allows to change the fields on the form that will be generated.
299 $name: name of the action
300 &$fields: HTMLForm descriptor array
301 $article: Article object
303 'AddNewAccount': After a user account is created.
304 $user: the User object that was created. (Parameter added in 1.7)
305 $byEmail: true when account was created "by email" (added in 1.12)
307 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
308 $apiModule: the ApiCreateAccount module calling
309 $loginForm: the LoginForm used
311 'AddNewAccountApiResult': Modify API output when creating a new account via API.
312 $apiModule: the ApiCreateAccount module calling
313 $loginForm: the LoginForm used
314 &$result: associative array for API result data
316 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
317 ob_end_flush() which will send the buffered output to the client. This allows
318 for last-minute modification of the output within the buffer by using
320 &$output: OutputPage object
322 'AfterImportPage': When a page import is completed.
323 $title: Title under which the revisions were imported
324 $origTitle: Title provided by the XML file
325 $revCount: Number of revisions in the XML file
326 $sRevCount: Number of successfully imported revisions
327 $pageInfo: associative array of page information
329 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
330 before OutputPage::sendCacheControl() and final ob_end_flush() which
331 will send the buffered output to the client. This allows for last-minute
332 modification of the output within the buffer by using ob_get_clean().
333 $output: The OutputPage object where output() was called
335 'AjaxAddScript': Called in output page just before the initialisation
336 of the javascript ajax engine. The hook is only called when ajax
337 is enabled ( $wgUseAjax = true; ).
338 &$output: OutputPage object
340 'AlternateEdit': Before checking if a user can edit a page and before showing
341 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
342 $editPage: the EditPage object
344 'AlternateEditPreview': Before generating the preview of the page when editing
345 ( EditPage::getPreviewText() ).
346 $editPage: the EditPage object
347 &$content: the Content object for the text field from the edit page
348 &$previewHTML: Text to be placed into the page for the preview
349 &$parserOutput: the ParserOutput object for the preview
350 return false and set $previewHTML and $parserOutput to output custom page
353 'AlternateUserMailer': Called before mail is sent so that mail could be logged
354 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
355 the regular method of sending mail. Return a string to return a php-mail-error
356 message containing the error. Returning true will continue with sending email
358 $headers: Associative array of headers for the email
359 $to: MailAddress object or array
361 $subject: Subject of the email
362 $body: Body of the message
364 'APIAfterExecute': After calling the execute() method of an API module. Use
365 this to extend core API modules.
366 &$module: Module object
368 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
369 &$main: ApiMain object
371 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
372 authenticate and authorize API clients before executing the module. Return
373 false and set a message to cancel the request.
374 $module: Module object
376 &$message: API usage message to die with, as a message key or array
377 as accepted by ApiBase::dieUsageMsg.
379 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
380 processing request parameters. Return false to let the request fail, returning
381 an error message or an <edit result="Failure"> tag if $resultArr was filled.
382 $editPage : the EditPage object
383 $text : the new text of the article (has yet to be saved)
384 &$resultArr : data in this array will be added to the API result
386 'APIGetAllowedParams': Use this hook to modify a module's parameters.
387 &$module: ApiBase Module object
388 &$params: Array of parameters
389 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
391 'APIGetDescription': Use this hook to modify a module's description.
392 &$module: ApiBase Module object
393 &$desc: Array of descriptions
395 'APIGetParamDescription': Use this hook to modify a module's parameter
397 &$module: ApiBase Module object
398 &$desc: Array of parameter descriptions
400 'APIGetResultProperties': Use this hook to modify the properties in a module's
402 &$module: ApiBase Module object
403 &$properties: Array of properties
405 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
407 $module: ApiBase Module object
408 &$possibleErrors: Array of possible errors
410 'APIQueryAfterExecute': After calling the execute() method of an
411 action=query submodule. Use this to extend core API modules.
412 &$module: Module object
414 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
415 an action=query submodule. Use this to extend core API modules.
416 &$module: Module object
417 &$resultPageSet: ApiPageSet object
419 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
420 token has an action, which will be used in the intoken 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($pageid, $title), where $pageid is the page ID of the
424 page the token is requested for and $title is the associated Title object. In
425 the hook, just add your callback to the $tokenFunctions array and return true
426 (returning false makes no sense).
427 $tokenFunctions: array(action => callback)
429 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
430 Every token has an action, which will be used in the rvtoken parameter and in
431 the output (actiontoken="..."), and a callback function which should return the
432 token, or false if the user isn't allowed to obtain it. The prototype of the
433 callback function is func($pageid, $title, $rev), where $pageid is the page ID
434 of the page associated to the revision the token is requested for, $title the
435 associated Title object and $rev the associated Revision object. In the hook,
436 just add your callback to the $tokenFunctions array and return true (returning
437 false makes no sense).
438 $tokenFunctions: array(action => callback)
440 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
441 list=recentchanges. Every token has an action, which will be used in the rctoken
442 parameter and in the output (actiontoken="..."), and a callback function which
443 should return the token, or false if the user isn't allowed to obtain it. The
444 prototype of the callback function is func($pageid, $title, $rc), where $pageid
445 is the page ID of the page associated to the revision the token is requested
446 for, $title the associated Title object and $rc the associated RecentChange
447 object. In the hook, just add your callback to the $tokenFunctions array and
448 return true (returning false makes no sense).
449 $tokenFunctions: array(action => callback)
451 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
452 sites general information.
453 $module: the current ApiQuerySiteInfo module
454 &$results: array of results, add things here
456 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
457 sites statistics information.
458 &$results: array of results, add things here
460 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
461 token has an action, which will be used in the ustoken parameter and in the
462 output (actiontoken="..."), and a callback function which should return the
463 token, or false if the user isn't allowed to obtain it. The prototype of the
464 callback function is func($user) where $user is the User object. In the hook,
465 just add your callback to the $tokenFunctions array and return true (returning
466 false makes no sense).
467 $tokenFunctions: array(action => callback)
469 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
470 an exception is thrown during API action execution.
471 $apiMain: Calling ApiMain instance.
472 $e: Exception object.
474 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
475 should have its own entry in the $apis array and have a unique name, passed as
476 key for the array that represents the service data. In this data array, the
477 key-value-pair identified by the apiLink key is required.
478 &$apis: array of services
480 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
482 &$tokenTypes: supported token types in format 'type' => callback function
483 used to retrieve this type of tokens.
485 'Article::MissingArticleConditions': Before fetching deletion & move log entries
486 to display a message of a non-existing page being deleted/moved, give extensions
487 a chance to hide their (unrelated) log entries.
488 &$conds: Array of query conditions (all of which have to be met; conditions will
489 AND in the final query)
490 $logTypes: Array of log types being queried
492 'ArticleAfterFetchContent': After fetching content of an article from the
493 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
494 $article: the article (object) being loaded from the database
495 &$content: the content (string) of the article
497 'ArticleAfterFetchContentObject': After fetching content of an article from the
499 $article: the article (object) being loaded from the database
500 &$content: the content of the article, as a Content object
502 'ArticleConfirmDelete': Before writing the confirmation form for article
504 $article: the article (object) being deleted
505 $output: the OutputPage object
506 &$reason: the reason (string) the article is being deleted
508 'ArticleContentOnDiff': Before showing the article content below a diff. Use
509 this to change the content in this area or how it is loaded.
510 $diffEngine: the DifferenceEngine
511 $output: the OutputPage object
513 'ArticleDelete': Before an article is deleted.
514 $wikiPage: the WikiPage (object) being deleted
515 $user: the user (object) deleting the article
516 $reason: the reason (string) the article is being deleted
517 $error: if the deletion was prohibited, the (raw HTML) error message to display
519 $status: Status object, modify this to throw an error. Overridden by $error
522 'ArticleDeleteComplete': After an article is deleted.
523 $wikiPage: the WikiPage that was deleted
524 $user: the user that deleted the article
525 $reason: the reason the article was deleted
526 $id: id of the article that was deleted
527 $content: the Content of the deleted page
528 $logEntry: the ManualLogEntry used to record the deletion
530 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
532 &$wikiPage: WikiPage (object) of the user talk page
533 $recipient: User (object) who's talk page was edited
535 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
536 article has been changed.
537 $wikiPage: the WikiPage (object)
538 $editInfo: data holder that includes the parser output ($editInfo->output) for
539 that page after the change
540 $changed: bool for if the page was changed
542 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
543 recentchanges table, return false to not delete old entries.
544 $wikiPage: WikiPage (object) being modified
546 'ArticleFromTitle': when creating an article object from a title object using
547 Wiki::articleFromTitle().
548 $title: Title (object) used to create the article object
549 $article: Article (object) that will be returned
550 $context: IContextSource (object)
552 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
553 PageContentInsertComplete.
554 $wikiPage: WikiPage created
555 $user: User creating the article
557 $summary: Edit summary/comment
558 $isMinor: Whether or not the edit was marked as minor
559 $isWatch: (No longer used)
560 $section: (No longer used)
561 $flags: Flags passed to WikiPage::doEditContent()
562 $revision: New Revision of the article
564 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
565 $targetTitle: target title (object)
566 $destTitle: destination title (object)
568 'ArticlePageDataAfter': After loading data of an article from the database.
569 $wikiPage: WikiPage (object) whose data were loaded
570 $row: row (object) returned from the database server
572 'ArticlePageDataBefore': Before loading data of an article from the database.
573 $wikiPage: WikiPage (object) that data will be loaded
574 $fields: fields (array) to load from the database
576 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
577 $wikiPage: the WikiPage being saved
578 $popts: parser options to be used for pre-save transformation
580 'ArticleProtect': Before an article is protected.
581 $wikiPage: the WikiPage being protected
582 $user: the user doing the protection
583 $protect: boolean whether this is a protect or an unprotect
584 $reason: Reason for protect
585 $moveonly: boolean whether this is for move only or not
587 'ArticleProtectComplete': After an article is protected.
588 $wikiPage: the WikiPage that was protected
589 $user: the user who did the protection
590 $protect: boolean whether it was a protect or an unprotect
591 $reason: Reason for protect
592 $moveonly: boolean whether it was for move only or not
594 'ArticlePurge': Before executing "&action=purge".
595 $wikiPage: WikiPage (object) to purge
597 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
598 revisions of an article.
599 &$title: Title object of the article
601 'ArticleRevisionUndeleted': After an article revision is restored.
602 $title: the article title
603 $revision: the revision
604 $oldPageID: the page ID of the revision when archived (may be null)
606 'ArticleRollbackComplete': After an article rollback is completed.
607 $wikiPage: the WikiPage that was edited
608 $user: the user who did the rollback
609 $revision: the revision the page was reverted back to
610 $current: the reverted revision
612 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
614 $wikiPage: the WikiPage (object) being saved
615 $user: the user (object) saving the article
616 $text: the new article text
617 $summary: the article summary (comment)
622 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
623 PageContentSaveComplete instead.
624 $wikiPage: WikiPage modified
625 $user: User performing the modification
627 $summary: Edit summary/comment
628 $isMinor: Whether or not the edit was marked as minor
629 $isWatch: (No longer used)
630 $section: (No longer used)
631 $flags: Flags passed to WikiPage::doEditContent()
632 $revision: New Revision of the article
633 $status: Status object about to be returned by doEditContent()
634 $baseRevId: the rev ID (or false) this edit was based on
636 'ArticleUndelete': When one or more revisions of an article are restored.
637 $title: Title corresponding to the article restored
638 $create: Whether or not the restoration caused the page to be created (i.e. it
639 didn't exist before).
640 $comment: The comment associated with the undeletion.
642 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
643 $pageArchive: the PageArchive object
644 &$logEntry: ManualLogEntry object
645 $user: User who is performing the log action
647 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
648 the user is redirected back to the page.
649 &$article: the article
650 &$sectionanchor: The section anchor link (e.g. "#overview" )
651 &$extraq: Extra query parameters which can be added via hooked functions
653 'ArticleViewFooter': After showing the footer section of an ordinary page view
654 $article: Article object
655 $patrolFooterShown: boolean whether patrol footer is shown
657 'ArticleViewHeader': Before the parser cache is about to be tried for article
659 &$article: the article
660 &$pcache: whether to try the parser cache or not
661 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
662 object to both indicate that the output is done and what parser output was used.
664 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
665 redirect was followed.
666 $article: target article (object)
668 'ArticleViewCustom': Allows to output the text of the article in a different
669 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
670 that it is preferable to implement proper handing for a custom data type using
671 the ContentHandler facility.
672 $text: text of the page
673 $title: title of the page
674 $output: reference to $wgOut
676 'ArticleContentViewCustom': Allows to output the text of the article in a
677 different format than wikitext. Note that it is preferable to implement proper
678 handing for a custom data type using the ContentHandler facility.
679 $content: content of the page, as a Content object
680 $title: title of the page
681 $output: reference to $wgOut
683 'AuthPluginAutoCreate': Called when creating a local account for an user logged
684 in from an external authentication method.
685 $user: User object created locally
687 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
688 Gives a chance for an extension to set it programmatically to a variable class.
689 &$auth: the $wgAuth object, probably a stub
691 'AutopromoteCondition': Check autopromote condition for user.
692 $type: condition type
695 $result: result of checking autopromote condition
697 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
701 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
702 certain title are fetched.
704 $title: title of the page to which backlinks are sought
705 &$conds: query conditions
707 'BadImage': When checking against the bad image list. Change $bad and return
708 false to override. If an image is "bad", it is not rendered inline in wiki
709 pages or galleries in category pages.
710 $name: Image name being checked
711 &$bad: Whether or not the image is "bad"
713 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
714 custom HTML after the section. Any uses of the hook need to handle escaping.
715 $template BaseTemplate
716 $portlet: string portlet name
719 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
720 "noarticletext-nopermission" at Article::showMissingArticle().
721 $article: article object
723 'BeforeInitialize': Before anything is initialized in
724 MediaWiki::performRequest().
725 &$title: Title being used for request
727 &$output: OutputPage object
729 $request: WebRequest object
730 $mediaWiki: Mediawiki object
732 'BeforePageDisplay': Prior to outputting a page.
733 &$out: OutputPage object
736 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
737 override how the redirect is output by modifying, or by returning false and
738 taking over the output.
739 $out: OutputPage object
740 &$redirect: URL, modifiable
741 &$code: HTTP code (eg '301' or '302'), modifiable
743 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
744 $parser: Parser object
746 &$options: array of options to RepoGroup::findFile
747 &$descQuery: query string to add to thumbnail URL
749 FIXME: Where does the below sentence fit in?
750 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
752 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
753 $parser: Parser object
754 $title: title of the template
755 &$skip: skip this template and link it?
756 &$id: the id of the revision being parsed
758 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
759 &$parser: Parser object
760 &$ig: ImageGallery object
762 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
764 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
765 to a newly created user account.
766 &$injected_html: Any HTML to inject after the "logged in" message of a newly
769 'BitmapHandlerTransform': before a file is transformed, gives extension the
770 possibility to transform it themselves
771 $handler: BitmapHandler
773 &$scalerParams: Array with scaler parameters
774 &$mto: null, set to a MediaTransformOutput
776 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
777 normalizations have been performed, except for the $wgMaxImageArea check.
779 &$params: Array of parameters
780 &$checkImageAreaHookResult: null, set to true or false to override the
781 $wgMaxImageArea check result.
783 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
785 $block: Block object (which is set to be autoblocking)
786 &$blockIds: Array of block IDs of the autoblock
788 'BlockIp': Before an IP address or user is blocked.
789 $block: the Block object about to be saved
790 $user: the user _doing_ the block (not the one being blocked)
791 &$reason: if the hook is aborted, the error message to be returned in an array
793 'BlockIpComplete': After an IP address or user is blocked.
794 $block: the Block object that was saved
795 $user: the user who did the block (not the one being blocked)
797 'BookInformation': Before information output on Special:Booksources.
798 $isbn: ISBN to show information for
799 $output: OutputPage object in use
801 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
802 to be able to access the wiki via HTTPS.
803 $ip: The IP address in human-readable form
804 &$canDo: This reference should be set to false if the client may not be able
807 'CanonicalNamespaces': For extensions adding their own namespaces or altering
809 Note that if you need to specify namespace protection or content model for
810 a namespace that is added in a CanonicalNamespaces hook handler, you
811 should do so by altering $wgNamespaceProtection and
812 $wgNamespaceContentModels outside the handler, in top-level scope. The
813 point at which the CanonicalNamespaces hook fires is too late for altering
814 these variables. This applies even if the namespace addition is
815 conditional; it is permissible to declare a content model and protection
816 for a namespace and then decline to actually register it.
817 &$namespaces: Array of namespace numbers with corresponding canonical names
819 'CategoryAfterPageAdded': After a page is added to a category.
820 $category: Category that page was added to
821 $wikiPage: WikiPage that was added
823 'CategoryAfterPageRemoved': After a page is removed from a category.
824 $category: Category that page was removed from
825 $wikiPage: WikiPage that was removed
827 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
828 $catpage: CategoryPage instance
830 'ChangePasswordForm': For extensions that need to add a field to the
831 ChangePassword form via the Preferences form.
832 &$extraFields: An array of arrays that hold fields like would be passed to the
835 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
836 &$changesList: ChangesList instance.
837 &$articlelink: HTML of link to article (already filled-in).
838 &$s: HTML of row that is being constructed.
839 &$rc: RecentChange instance.
840 $unpatrolled: Whether or not we are showing unpatrolled changes.
841 $watched: Whether or not the change is watched by the user.
843 'ChangesListInitRows': Batch process change list rows prior to rendering.
844 $changesList: ChangesList instance
845 $rows: The data that will be rendered. May be a ResultWrapper instance or
848 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
849 $special: ChangesListSpecialPage instance
850 &$filters: associative array of filter definitions. The keys are the HTML
851 name/URL parameters. Each key maps to an associative array with a 'msg'
852 (message key) and a 'default' value.
854 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
855 $name: name of the special page, e.g. 'Watchlist'
856 &$tables: array of tables to be queried
857 &$fields: array of columns to select
858 &$conds: array of WHERE conditionals for query
859 &$query_options: array of options for the database request
860 &$join_conds: join conditions for the tables
861 $opts: FormOptions for this request
863 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
864 $collationName: Name of the collation in question
865 &$collationObject: Null. Replace with a subclass of the Collation class that
866 implements the collation given in $collationName.
868 'ConfirmEmailComplete': Called after a user's email has been confirmed
870 $user: user (object) whose email is being confirmed
872 'ContentHandlerDefaultModelFor': Called when the default content model is determined
873 for a given title. May be used to assign a different model for that title.
874 $title: the Title in question
875 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
877 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
878 content model name, but no entry for that model exists in $wgContentHandlers.
879 $modeName: the requested content model name
880 &$handler: set this to a ContentHandler object, if desired.
882 'ContentModelCanBeUsedOn': Called to determine whether that content model can
883 be used on a given page. This is especially useful to prevent some content models
884 to be used in some special location.
885 $contentModel: ID of the content model in question
886 $title: the Title in question.
887 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
888 Handler functions that modify $ok should generally return false to prevent further
889 hooks from further modifying $ok.
891 'ContentGetParserOutput': Customize parser output for a given content object,
892 called by AbstractContent::getParserOutput. May be used to override the normal
893 model-specific rendering of page content.
894 $content: The Content to render
895 $title: Title of the page, as context
896 $revId: The revision ID, as context
897 $options: ParserOptions for rendering. To avoid confusing the parser cache,
898 the output can only depend on parameters provided to this hook function, not on global state.
899 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
900 generation of HTML may be skipped, but other information should still be present in the
902 &$output: ParserOutput, to manipulate or replace
904 'ConvertContent': Called by AbstractContent::convert when a conversion to another
905 content model is requested.
906 $content: The Content object to be converted.
907 $toModel: The ID of the content model to convert to.
908 $lossy: boolean indicating whether lossy conversion is allowed.
909 &$result: Output parameter, in case the handler function wants to provide a
910 converted Content object. Note that $result->getContentModel() must return $toModel.
911 Handler functions that modify $result should generally return false to further
912 attempts at conversion.
914 'ContribsPager::getQueryInfo': Before the contributions query is about to run
915 &$pager: Pager object for contributions
916 &$queryInfo: The query for the contribs Pager
918 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
919 &$data: an array of results of all contribs queries
920 $pager: The ContribsPager object hooked into
921 $offset: Index offset, inclusive
922 $limit: Exact query limit
923 $descending: Query direction, false for ascending, true for descending
925 'ContributionsLineEnding': Called before a contributions HTML line is finished
926 $page: SpecialPage object for contributions
928 $row: the DB row for this line
929 &$classes: the classes to add to the surrounding <li>
931 'ContributionsToolLinks': Change tool links above Special:Contributions
933 $title: User page title
934 &$tools: Array of tool links
936 'CustomEditor': When invoking the page editor
937 $article: Article being edited
938 $user: User performing the edit
940 Return true to allow the normal editor to be used, or false
941 if implementing a custom editor, e.g. for a special namespace,
944 'DatabaseOraclePostInit': Called after initialising an Oracle database
945 &$db: the DatabaseOracle object
947 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
948 $title: the diff page title (nullable)
949 &$oldId: the actual old Id to use in the diff
950 &$newId: the actual new Id to use in the diff (0 means current)
951 $old: the ?old= param value from the url
952 $new: the ?new= param value from the url
954 'DiffRevisionTools': Override or extend the revision tools available from the
955 diff view, i.e. undo, etc.
956 $newRev: Revision object of the "new" revision
957 &$links: Array of HTML links
958 $oldRev: Revision object of the "old" revision (may be null)
960 'DiffViewHeader': Called before diff display
961 $diff: DifferenceEngine object that's calling
962 $oldRev: Revision object of the "old" revision (may be null/invalid)
963 $newRev: Revision object of the "new" revision
965 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
967 $article: article (object) being viewed
968 $oldid: oldid (int) being viewed
970 'DoEditSectionLink': Override the HTML generated for section edit links
971 $skin: Skin object rendering the UI
972 $title: Title object for the title being linked to (may not be the same as
973 the page title, if the section is included from a template)
974 $section: The designation of the section being pointed to, to be included in
975 the link, like "§ion=$section"
976 $tooltip: The default tooltip. Escape before using.
977 By default, this is wrapped in the 'editsectionhint' message.
978 &$result: The HTML to return, prefilled with the default plus whatever other
979 changes earlier hooks have made
980 $lang: The language code to use for the link in the wfMessage function
982 'EditFilter': Perform checks on an edit
983 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
984 $text: Contents of the edit box
985 $section: Section being edited
986 &$error: Error message to return
987 $summary: Edit summary for page
989 'EditFilterMerged': Post-section-merge edit filter.
990 DEPRECATED, use EditFilterMergedContent instead.
991 $editor: EditPage instance (object)
992 $text: content of the edit box
993 &$error: error message to return
994 $summary: Edit summary for page
996 'EditFilterMergedContent': Post-section-merge edit filter.
997 This may be triggered by the EditPage or any other facility that modifies page content.
998 Use the $status object to indicate whether the edit should be allowed, and to provide
999 a reason for disallowing it. Return false to abort the edit, and true to continue.
1000 Returning true if $status->isOK() returns false means "don't save but continue user
1001 interaction", e.g. show the edit form.
1002 $context: object implementing the IContextSource interface.
1003 $content: content of the edit box, as a Content object.
1004 $status: Status object to represent errors, etc.
1005 $summary: Edit summary for page
1006 $user: the User object representing the user whois performing the edit.
1007 $minoredit: whether the edit was marked as minor by the user.
1009 'EditFormPreloadText': Allows population of the edit form when creating
1011 &$text: Text to preload with
1012 &$title: Title object representing the page being created
1014 'EditFormInitialText': Allows modifying the edit form when editing existing
1016 $editPage: EditPage object
1018 'EditPage::attemptSave': Called before an article is
1019 saved, that is before WikiPage::doEditContent() is called
1020 $editpage_Obj: the current EditPage object
1022 'EditPage::importFormData': allow extensions to read additional data
1024 $editpage: EditPage instance
1025 $request: Webrequest
1026 return value is ignored (should always return true)
1028 'EditPage::showEditForm:fields': allows injection of form field into edit form
1029 $editor: the EditPage instance for reference
1030 $out: an OutputPage instance to write to
1031 return value is ignored (should always return true)
1033 'EditPage::showEditForm:initial': before showing the edit form
1034 $editor: EditPage instance (object)
1035 $out: an OutputPage instance to write to
1037 Return false to halt editing; you'll need to handle error messages, etc.
1038 yourself. Alternatively, modifying $error and returning true will cause the
1039 contents of $error to be echoed at the top of the edit form as wikitext.
1040 Return true without altering $error to allow the edit to proceed.
1042 'EditPage::showReadOnlyForm:initial: similar to EditPage::showEditForm:initial
1043 but for the readonly 'view source' variant of the edit form.
1044 $editor: EditPage instance (object)
1045 &$out: an OutputPage instance to write to
1046 return value is ignored (should alway return true)
1048 'EditPage::showStandardInputs:options': allows injection of form fields into
1049 the editOptions area
1050 $editor: EditPage instance (object)
1051 $out: an OutputPage instance to write to
1052 &$tabindex: HTML tabindex of the last edit check/button
1053 return value is ignored (should always be true)
1055 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1056 when there's an edit conflict. Return false to halt normal diff output; in
1057 this case you're responsible for computing and outputting the entire "conflict"
1058 part, i.e., the "difference between revisions" and "your text" headers and
1060 &$editor: EditPage instance
1061 &$out: OutputPage instance
1063 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1064 textarea in the edit form.
1065 &$editpage: The current EditPage object
1066 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1067 &$tabindex: HTML tabindex of the last edit check/button
1069 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1071 &$editpage: The current EditPage object
1072 &$checks: Array of edit checks like "watch this page"/"minor edit"
1073 &$tabindex: HTML tabindex of the last edit check/button
1075 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1076 textarea in the edit form.
1077 &$toolbar: The toolbar HTMl
1079 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1080 contribution/copyright notice.
1081 $title: title of page being edited
1082 &$msg: localization message name, overridable. Default is either
1083 'copyrightwarning' or 'copyrightwarning2'.
1085 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1086 modifying the wikitext that will be used in "Show changes". Note that it is
1087 preferable to implement diff handling for different data types using the
1088 ContentHandler facility.
1089 $editPage: EditPage object
1090 &$newtext: wikitext that will be used as "your version"
1092 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1093 "Show changes". Note that it is preferable to implement diff handling for
1094 different data types using the ContentHandler facility.
1095 $editPage: EditPage object
1096 &$newtext: wikitext that will be used as "your version"
1098 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1099 Allow modifying the wikitext that will be previewed. Note that it is preferable
1100 to implement previews for different data types using the ContentHandler
1102 $editPage: EditPage object
1103 &$toparse: wikitext that will be parsed
1105 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1106 previewed. Note that it is preferable to implement previews for different data
1107 types using the ContentHandler facility.
1108 $editPage: EditPage object
1109 &$content: Content object to be previewed (may be replaced by hook function)
1111 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1112 &$editpage: The current EditPage object
1113 &$res: the HTML of the error text
1115 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1116 of terms of service summary link that might exist separately from the copyright
1118 $title: title of page being edited
1119 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1121 'EmailConfirmed': When checking that the user's email address is "confirmed".
1122 $user: User being checked
1123 $confirmed: Whether or not the email address is confirmed
1124 This runs before the other checks, such as anonymity and the real check; return
1125 true to allow those checks to occur, and false if checking is done.
1127 'EmailUser': Before sending email from one user to another.
1128 $to: address of receiving user
1129 $from: address of sending user
1130 $subject: subject of the mail
1131 $text: text of the mail
1133 'EmailUserCC': Before sending the copy of the email to the author.
1134 $to: address of receiving user
1135 $from: address of sending user
1136 $subject: subject of the mail
1137 $text: text of the mail
1139 'EmailUserComplete': After sending email from one user to another.
1140 $to: address of receiving user
1141 $from: address of sending user
1142 $subject: subject of the mail
1143 $text: text of the mail
1145 'EmailUserForm': After building the email user form object.
1146 $form: HTMLForm object
1148 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1150 $user: The user who is trying to email another user.
1151 $editToken: The user's edit token.
1152 &$hookErr: Out-param for the error. Passed as the parameters to
1153 OutputPage::showErrorPage.
1155 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1157 $ip: The ip address of the user
1159 'ExtensionTypes': Called when generating the extensions credits, use this to
1160 change the tables headers.
1161 &$extTypes: associative array of extensions types
1163 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1164 thumbnail file name.
1165 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1166 $thumbname: the base name of the thumbnail file
1167 &$params: the currently extracted params (has source name, temp or archived zone)
1169 'FetchChangesList': When fetching the ChangesList derivative for a particular
1171 $user: User the list is being fetched for
1172 &$skin: Skin object to be used with the list
1173 &$list: List object (defaults to NULL, change it to an object instance and
1174 return false override the list derivative used)
1176 'FileDeleteComplete': When a file is deleted.
1177 $file: reference to the deleted file
1178 $oldimage: in case of the deletion of an old image, the name of the old file
1179 $article: in case all revisions of the file are deleted a reference to the
1180 WikiFilePage associated with the file.
1181 $user: user who performed the deletion
1184 'FileTransformed': When a file is transformed and moved into storage.
1185 $file: reference to the File object
1186 $thumb: the MediaTransformOutput object
1187 $tmpThumbPath: The temporary file system path of the transformed file
1188 $thumbPath: The permanent storage path of the transformed file
1190 'FileUpload': When a file upload occurs.
1191 $file : Image object representing the file that was uploaded
1192 $reupload : Boolean indicating if there was a previously another image there or
1194 $hasDescription : Boolean indicating that there was already a description page
1195 and a new one from the comment wasn't created (since 1.17)
1197 'FileUndeleteComplete': When a file is undeleted
1198 $title: title object to the file
1199 $fileVersions: array of undeleted versions. Empty if all versions were restored
1200 $user: user who performed the undeletion
1203 'FormatAutocomments': When an autocomment is formatted by the Linker.
1204 &$comment: Reference to the accumulated comment. Initially null, when set the
1205 default code will be skipped.
1206 $pre: Initial part of the parsed comment before the call to the hook.
1207 $auto: The extracted part of the parsed comment before the call to the hook.
1208 $post: The final part of the parsed comment before the call to the hook.
1209 $title: An optional title object used to links to sections. Can be null.
1210 $local: Boolean indicating whether section links should refer to local page.
1212 'GalleryGetModes': Get list of classes that can render different modes of a
1214 $modeArray: An associative array mapping mode names to classes that implement
1215 that mode. It is expected all registered classes are a subclass of
1218 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1220 &$user: user to promote.
1221 &$promote: groups that will be added.
1223 'GetBlockedStatus': after loading blocking status of an user from the database
1224 $user: user (object) being checked
1226 'GetCacheVaryCookies': Get cookies that should vary cache options.
1227 $out: OutputPage object
1228 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1229 that have to vary cache options
1231 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1233 $title: Title object of page
1234 $url: string value as output (out parameter, can modify)
1235 $query: query options passed to Title::getCanonicalURL()
1237 'GetDefaultSortkey': Override the default sortkey for a page.
1238 $title: Title object that we need to get a sortkey for
1239 &$sortkey: Sortkey to use.
1241 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1242 underscore) magic words. Called by MagicWord.
1243 &$doubleUnderscoreIDs: array of strings
1245 'GetExtendedMetadata': Get extended file metadata for the API
1246 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1247 'value' => prop value, 'source' => 'name of hook' ).
1248 $file: File object of file in question
1249 $context: RequestContext (including language to use)
1250 $single: Only extract the current language; if false, the prop value should
1251 be in the metadata multi-language array format:
1252 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1253 &$maxCacheTime: how long the results can be cached
1255 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1256 $title: Title object of page
1257 $url: string value as output (out parameter, can modify)
1258 $query: query options passed to Title::getFullURL()
1260 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1261 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1263 &$output: string for the output timestamp
1264 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1265 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1266 $user: User whose preferences are being used to make timestamp
1267 $lang: Language that will be used to render the timestamp
1269 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1270 $title: Title object of page
1271 $url: string value as output (out parameter, can modify)
1272 $query: query options passed to Title::getInternalURL()
1274 'GetIP': modify the ip of the current user (called only once).
1275 &$ip: string holding the ip as determined so far
1277 'GetLinkColours': modify the CSS class of an array of page links.
1278 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1280 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1282 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1283 working with internal urls (non-interwiki) then it may be preferable to work
1284 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1285 be buggy for internal urls on render if you do not re-implement the horrible
1286 hack that Title::getLocalURL uses in your own extension.
1287 $title: Title object of page
1288 &$url: string value as output (out parameter, can modify)
1289 $query: query options passed to Title::getLocalURL()
1291 'GetLocalURL::Internal': Modify local URLs to internal pages.
1292 $title: Title object of page
1293 &$url: string value as output (out parameter, can modify)
1294 $query: query options passed to Title::getLocalURL()
1296 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1297 without any fancy queries or variants.
1298 $title: Title object of page
1299 &$url: string value as output (out parameter, can modify)
1301 'GetLogTypesOnUser': Add log types where the target is a userpage
1302 &$types: Array of log types
1304 'GetMetadataVersion': Modify the image metadata version currently in use. This
1305 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1306 that need to have versioned metadata should add an element to the end of the
1307 version array of the form 'handler_name=version'. Most media handlers won't need
1308 to do this unless they broke backwards compatibility with a previous version of
1309 the media handler metadata output.
1310 &$version: Array of version strings
1312 'GetNewMessagesAlert': Disable or modify the new messages alert
1313 &$newMessagesAlert: An empty string by default. If the user has new talk page
1314 messages, this should be populated with an alert message to that effect
1315 $newtalks: An empty array if the user has no new messages or an array containing
1316 links and revisions if there are new messages (See User::getNewMessageLinks)
1317 $user: The user object of the user who is loading the page
1318 $out: OutputPage object (to check what type of page the user is on)
1320 'GetPreferences': Modify user preferences.
1321 $user: User whose preferences are being modified.
1322 &$preferences: Preferences description array, to be fed to an HTMLForm object
1324 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1325 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1327 &$output: string for the output timestamp
1328 &$diff: DateInterval representing the difference between the timestamps
1329 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1330 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1331 $user: User whose preferences are being used to make timestamp
1332 $lang: Language that will be used to render the timestamp
1334 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1335 checked for. Use instead of userCan for most cases. Return false if the user
1336 can't do it, and populate $result with the reason in the form of
1337 array( messagename, param1, param2, ... ). For consistency, error messages
1338 should be plain text with no special coloring, bolding, etc. to show that
1339 they're errors; presenting them properly to the user as errors is done by the
1341 $title: Title object being checked against
1342 $user : Current user object
1343 $action: Action being checked
1344 $result: User permissions error to add. If none, return true.
1346 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1347 called only if expensive checks are enabled. Add a permissions error when
1348 permissions errors are checked for. Return false if the user can't do it, and
1349 populate $result with the reason in the form of array( messagename, param1,
1350 param2, ... ). For consistency, error messages should be plain text with no
1351 special coloring, bolding, etc. to show that they're errors; presenting them
1352 properly to the user as errors is done by the caller.
1354 $title: Title object being checked against
1355 $user : Current user object
1356 $action: Action being checked
1357 $result: User permissions error to add. If none, return true.
1359 'GitViewers': Called when generating the list of git viewers for
1360 Special:Version, use this to change the list.
1361 &$extTypes: associative array of repo URLS to viewer URLs.
1363 'HistoryRevisionTools': Override or extend the revision tools available from the
1364 page history view, i.e. undo, rollback, etc.
1365 $rev: Revision object
1366 &$links: Array of HTML links
1368 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1369 image insertion. You can skip the default logic entirely by returning false, or
1370 just modify a few things using call-by-reference.
1372 &$title: Title object of the image
1373 &$file: File object, or false if it doesn't exist
1374 &$frameParams: Various parameters with special meanings; see documentation in
1375 includes/Linker.php for Linker::makeImageLink
1376 &$handlerParams: Various parameters with special meanings; see documentation in
1377 includes/Linker.php for Linker::makeImageLink
1378 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1379 &$res: Final HTML output, used if you return false
1382 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1383 the image on an image page.
1384 $imagePage: ImagePage object ($this)
1387 'ImagePageAfterImageLinks': Called after the image links section on an image
1389 $imagePage: ImagePage object ($this)
1390 &$html: HTML for the hook to add
1392 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1394 $line: the HTML of the history line
1395 $css: the line CSS class
1397 'ImagePageFindFile': Called when fetching the file associated with an image
1399 $page: ImagePage object
1401 &$displayFile: displayed File object
1403 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1404 $page: ImagePage object
1405 &$toc: Array of <li> strings
1407 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1409 &$title: the Title object of the file as it would appear for the upload page
1410 &$path: the original file and path name when img_auth was invoked by the the web
1412 &$name: the name only component of the file
1413 &$result: The location to pass back results of the hook routine (only used if
1415 $result[0]=The index of the header message
1416 $result[1]=The index of the body text message
1417 $result[2 through n]=Parameters passed to body text message. Please note the
1418 header message cannot receive/use parameters.
1420 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1421 $reader: XMLReader object
1422 $logInfo: Array of information
1423 Return false to stop further processing of the tag
1425 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1426 $reader: XMLReader object
1427 $pageInfo: Array of information
1428 Return false to stop further processing of the tag
1430 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1431 $reader: XMLReader object
1432 $pageInfo: Array of page information
1433 $revisionInfo: Array of revision information
1434 Return false to stop further processing of the tag
1436 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1437 $reader: XMLReader object
1438 Return false to stop further processing of the tag
1440 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1441 $reader: XMLReader object
1442 $revisionInfo: Array of information
1443 Return false to stop further processing of the tag
1445 'InfoAction': When building information to display on the action=info page.
1446 $context: IContextSource object
1447 &$pageInfo: Array of information
1449 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1450 $title: Title object for the current page
1451 $request: WebRequest
1452 $ignoreRedirect: boolean to skip redirect check
1453 $target: Title/string of redirect target
1454 $article: Article object
1456 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1457 Return true without providing an interwiki to continue interwiki search.
1458 $prefix: interwiki prefix we are looking for.
1459 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1460 iw_trans and optionally iw_api and iw_wikiid.
1462 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1463 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1464 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1465 template/parser function execution which respect nowiki and HTML-comments.
1466 &$parser: Parser object
1467 &$text: string containing partially parsed text
1468 &$stripState: Parser's internal StripState object
1470 'InternalParseBeforeLinks': during Parser's internalParse method before links
1471 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1472 &$parser: Parser object
1473 &$text: string containing partially parsed text
1474 &$stripState: Parser's internal StripState object
1476 'InvalidateEmailComplete': Called after a user's email has been invalidated
1478 $user: user (object) whose email is being invalidated
1480 'IRCLineURL': When constructing the URL to use in an IRC notification.
1481 Callee may modify $url and $query, URL will be constructed as $url . $query
1482 &$url: URL to index.php
1483 &$query: Query string
1484 $rc: RecentChange object that triggered url generation
1486 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1487 $article: article (object) being checked
1489 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1491 $result: Change this value to override the result of wfIsTrustedProxy()
1493 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1494 $url: URL used to upload from
1495 &$allowed: Boolean indicating if uploading is allowed for given URL
1497 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1498 instance to return false if the domain name doesn't match your organization.
1499 $addr: The e-mail address entered by the user
1500 &$result: Set this and return false to override the internal checks
1502 'isValidPassword': Override the result of User::isValidPassword()
1503 $password: The password entered by the user
1504 &$result: Set this and return false to override the internal checks
1505 $user: User the password is being validated for
1507 'Language::getMessagesFileName':
1508 $code: The language code or the language we're looking for a messages file for
1509 &$file: The messages file path, you can override this to change the location.
1511 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1512 remove namespaces. Do not use this hook to add namespaces. Use
1513 CanonicalNamespaces for that.
1514 &$namespaces: Array of namespaces indexed by their numbers
1516 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1517 $wgExtensionMessagesFiles instead.
1518 Use this to define synonyms of magic words depending of the language
1519 $magicExtensions: associative array of magic words synonyms
1520 $lang: language code (string)
1522 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1523 listed in $wgExtensionMessagesFiles instead.
1524 Use to define aliases of special pages names depending of the language
1525 $specialPageAliases: associative array of magic words synonyms
1526 $lang: language code (string)
1528 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1529 &$names: array of language code => language name
1530 $code language of the preferred translations
1532 'LanguageLinks': Manipulate a page's language links. This is called
1533 in various places to allow extensions to define the effective language
1535 $title: The page's Title.
1536 &$links: Associative array mapping language codes to prefixed links of the
1537 form "language:title".
1538 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1539 Currently unused, but planned to provide support for marking individual
1540 language links in the UI, e.g. for featured articles.
1542 'LinkBegin': Used when generating internal and interwiki links in
1543 Linker::link(), before processing starts. Return false to skip default
1544 processing and return $ret. See documentation for Linker::link() for details on
1545 the expected meanings of parameters.
1546 $skin: the Skin object
1547 $target: the Title that the link is pointing to
1548 &$html: the contents that the <a> tag should have (raw HTML); null means
1550 &$customAttribs: the HTML attributes that the <a> tag should have, in
1551 associative array form, with keys and values unescaped. Should be merged with
1552 default values, with a value of false meaning to suppress the attribute.
1553 &$query: the query string to add to the generated URL (the bit after the "?"),
1554 in associative array form, with keys and values unescaped.
1555 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1556 &$ret: the value to return if your hook returns false.
1558 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1559 just before the function returns a value. If you return true, an <a> element
1560 with HTML attributes $attribs and contents $html will be returned. If you
1561 return false, $ret will be returned.
1562 $skin: the Skin object
1563 $target: the Title object that the link is pointing to
1564 $options: the options. Will always include either 'known' or 'broken', and may
1565 include 'noclasses'.
1566 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1567 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1568 associative array form.
1569 &$ret: the value to return if your hook returns false.
1571 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1573 &$url: the image url
1574 &$alt: the image's alt text
1575 &$img: the new image HTML (if returning false)
1577 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1580 &$text: the link text
1581 &$link: the new link HTML (if returning false)
1582 &$attribs: the attributes to be applied.
1583 $linkType: The external link type
1585 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1587 $title: the Title object that the link is pointing to
1588 $file: the File object or false if broken link
1589 &$html: the link text
1590 &$attribs: the attributes to be applied
1591 &$ret: the value to return if your hook returns false
1593 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1595 &$linksUpdate: the LinksUpdate object
1597 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1598 each link table insert. For example, pagelinks, imagelinks, externallinks.
1599 $linksUpdate: LinksUpdate object
1600 $table: the table to insert links to
1601 $insertions: an array of links to insert
1603 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1604 including delete and insert, has completed for all link tables
1605 &$linksUpdate: the LinksUpdate object
1607 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1608 &$linksUpdate: the LinksUpdate object
1610 'ListDefinedTags': When trying to find all defined tags.
1611 &$tags: The list of tags.
1613 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1614 &updater: A DatabaseUpdater subclass
1616 'LocalFile::getHistory': Called before file history query performed.
1617 $file: the File object
1619 $fields: select fields
1621 $opts: query options
1622 $join_conds: JOIN conditions
1624 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1625 $file: the File object
1626 $archiveName: name of an old file version or false if it's the current one
1628 'LocalisationCacheRecache': Called when loading the localisation data into
1630 $cache: The LocalisationCache object
1631 $code: language code
1632 &$alldata: The localisation data from core and extensions
1633 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1635 'LocalisationChecksBlacklist': When fetching the blacklist of
1636 localisation checks.
1637 &$blacklist: array of checks to blacklist. See the bottom of
1638 maintenance/language/checkLanguage.inc for the format of this variable.
1640 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1641 Returning false will prevent the string from being added to the OutputPage.
1642 &$s: html string to show for the log extract
1643 $types: String or Array Log types to show
1644 $page: String or Title The page title to show log entries for
1645 $user: String The user who made the log entries
1646 $param: Associative Array with the following additional options:
1647 - lim Integer Limit of items to show, default is 50
1648 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1649 - showIfEmpty boolean Set to false if you don't want any output in case the
1650 loglist is empty if set to true (default), "No matching items in log" is
1651 displayed if loglist is empty
1652 - msgKey Array If you want a nice box with a message, set this to the key of
1653 the message. First element is the message key, additional optional elements
1654 are parameters for the key that are processed with
1655 wfMessage()->params()->parseAsBlock()
1656 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1658 - wrap String Wrap the message in html (usually something like
1659 "<div ...>$1</div>").
1660 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1662 'LoginAuthenticateAudit': A login attempt for a valid user account either
1663 succeeded or failed. No return data is accepted; this hook is for auditing only.
1664 $user: the User object being authenticated against
1665 $password: the password being submitted and found wanting
1666 $retval: a LoginForm class constant with authenticateUserData() return
1667 value (SUCCESS, WRONG_PASS, etc.).
1669 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1670 Use this hook to change the Message that will be output on Special:ChangePassword.
1671 &$msg: Message object that will be shown to the user
1672 $username: Username of the user who's password was expired.
1674 'LogLine': Processes a single log entry on Special:Log.
1675 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1676 logging.log_type database field.
1677 $log_action: string for the type of log action (e.g. 'delete', 'block',
1678 'create2'). Corresponds to logging.log_action database field.
1679 $title: Title object that corresponds to logging.log_namespace and
1680 logging.log_title database fields.
1681 $paramArray: Array of parameters that corresponds to logging.log_params field.
1682 Note that only $paramArray[0] appears to contain anything.
1683 &$comment: string that corresponds to logging.log_comment database field, and
1684 which is displayed in the UI.
1685 &$revert: string that is displayed in the UI, similar to $comment.
1686 $time: timestamp of the log entry (added in 1.12)
1688 'LonelyPagesQuery': Allow extensions to modify the query used by
1689 Special:LonelyPages.
1690 &$tables: tables to join in the query
1691 &$conds: conditions for the query
1692 &$joinConds: join conditions for the query
1694 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1696 $refreshLinks: RefreshLinks object
1698 'MagicWordwgVariableIDs': When defining new magic words IDs.
1699 $variableIDs: array of strings
1701 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1702 executed. Ideally, this hook should only be used to add variables that depend on
1703 the current page/request; static configuration should be added through
1704 ResourceLoaderGetConfigVars instead.
1705 &$vars: variable (or multiple variables) to be added into the output of
1706 Skin::makeVariablesScript
1707 $out: The OutputPage which called the hook, can be used to get the real title.
1709 'MarkPatrolled': Before an edit is marked patrolled.
1710 $rcid: ID of the revision to be marked patrolled
1711 $user: the user (object) marking the revision as patrolled
1712 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1713 sysop in order to mark an edit patrolled.
1715 'MarkPatrolledComplete': After an edit is marked patrolled.
1716 $rcid: ID of the revision marked as patrolled
1717 $user: user (object) who marked the edit patrolled
1718 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1719 sysop to patrol the edit.
1721 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1722 something completely different, after the basic globals have been set up, but
1723 before ordinary actions take place.
1725 $article: Article on which the action will be performed
1726 $title: Title on which the action will be performed
1728 $request: $wgRequest
1729 $mediaWiki: The $mediawiki object
1731 'MessagesPreLoad': When loading a message from the database.
1732 $title: title of the message (string)
1733 $message: value (string), change it to the message you want to define
1735 'MessageCache::get': When fetching a message. Can be used to override the key
1736 for customisations. Given and returned message key must be in special format:
1737 1) first letter must be in lower case according to the content language.
1738 2) spaces must be replaced with underscores
1739 &$key: message key (string)
1741 'MessageCacheReplace': When a message page is changed. Useful for updating
1743 $title: name of the page changed.
1744 $text: new contents of the page.
1746 'ModifyExportQuery': Modify the query used by the exporter.
1747 $db: The database object to be queried.
1748 &$tables: Tables in the query.
1749 &$conds: Conditions in the query.
1750 &$opts: Options for the query.
1751 &$join_conds: Join conditions for the query.
1753 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1754 links have been rendered (useful for adding more). Note: this is only run for
1755 the Monobook skin. To add items to the toolbox you should use the
1756 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1758 $tools: array of tools
1760 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1761 and returning it for the skin to output. You can add items to the toolbox while
1762 still letting the skin make final decisions on skin-specific markup conventions
1764 &$sk: The BaseTemplate base skin template
1765 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1766 BaseTemplate::makeListItem for details on the format of individual items
1767 inside of this array.
1769 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1771 $index: Integer; the index of the namespace being checked.
1772 $result: Boolean; whether MediaWiki currently thinks that pages in this
1773 namespace are movable. Hooks may change this value to override the return
1774 value of MWNamespace::isMovable().
1776 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1778 $wikiPage: the WikiPage edited
1779 $rev: the new revision
1780 $baseID: the revision ID this was based off, if any
1781 $user: the editing user
1783 'NormalizeMessageKey': Called before the software gets the text of a message
1784 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1786 &$key: the message being looked up. Change this to something else to change
1787 what message gets displayed (string)
1788 &$useDB: whether or not to look up the message in the database (bool)
1789 &$langCode: the language code to get the message for (string) - or -
1790 whether to use the content language (true) or site language (false) (bool)
1791 &$transform: whether or not to expand variables and templates
1792 in the message (bool)
1794 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1795 return false to omit the line from RecentChanges and Watchlist special pages.
1796 &$changeslist: The OldChangesList instance.
1797 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1798 &$rc: The RecentChange object.
1799 &$classes: array of css classes for the <li> element
1801 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1802 can alter or append to the array of URLs for search & suggestion formats.
1803 &$urls: array of associative arrays with Url element attributes
1805 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1806 users and/or IP addresses too.
1807 $otherBlockLink: An array with links to other block logs
1808 $ip: The requested IP address or username
1810 'OutputPageBeforeHTML': A page has been processed by the parser and the
1811 resulting HTML is about to be displayed.
1812 $parserOutput: the parserOutput (object) that corresponds to the page
1813 $text: the text that will be displayed, in HTML (string)
1815 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1816 body tag to allow for extensions to add attributes to the body of the page they
1817 might need. Or to allow building extensions to add body classes that aren't of
1818 high enough demand to be included in core.
1819 $out: The OutputPage which called the hook, can be used to get the real title
1820 $sk: The Skin that called OutputPage::headElement
1821 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1823 'OutputPageCheckLastModified': when checking if the page has been modified
1824 since the last visit.
1825 &$modifiedTimes: array of timestamps.
1826 The following keys are set: page, user, epoch
1828 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1829 $out: OutputPage instance (object)
1830 $parserOutput: parserOutput instance being added in $out
1832 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1833 categories. Implementations should return false if they generate the category
1834 links, so the default link generation is skipped.
1835 $out: OutputPage instance (object)
1836 $categories: associative array, keys are category names, values are category
1837 types ("normal" or "hidden")
1838 $links: array, intended to hold the result. Must be an associative array with
1839 category types as keys and arrays of HTML links as values.
1841 'PageContentInsertComplete': After a new article is created.
1842 $wikiPage: WikiPage created
1843 $user: User creating the article
1844 $content: New content as a Content object
1845 $summary: Edit summary/comment
1846 $isMinor: Whether or not the edit was marked as minor
1847 $isWatch: (No longer used)
1848 $section: (No longer used)
1849 $flags: Flags passed to WikiPage::doEditContent()
1850 $revision: New Revision of the article
1852 'PageContentLanguage': Allows changing the language in which the content of a
1853 page is written. Defaults to the wiki content language ($wgContLang).
1854 $title: Title object
1855 &$pageLang: the page content language (either an object or a language code)
1856 $wgLang: the user language
1858 'PageContentSave': Before an article is saved.
1859 $wikiPage: the WikiPage (object) being saved
1860 $user: the user (object) saving the article
1861 $content: the new article content, as a Content object
1862 $summary: the article summary (comment)
1863 $isminor: minor flag
1864 $iswatch: watch flag
1867 'PageContentSaveComplete': After an article has been updated.
1868 $wikiPage: WikiPage modified
1869 $user: User performing the modification
1870 $content: New content, as a Content object
1871 $summary: Edit summary/comment
1872 $isMinor: Whether or not the edit was marked as minor
1873 $isWatch: (No longer used)
1874 $section: (No longer used)
1875 $flags: Flags passed to WikiPage::doEditContent()
1876 $revision: New Revision of the article (can be null for edits that change nothing)
1877 $status: Status object about to be returned by doEditContent()
1878 $baseRevId: the rev ID (or false) this edit was based on
1880 'PageHistoryBeforeList': When a history page list is about to be constructed.
1881 $article: the article that the history is loading for
1882 $context: RequestContext object
1884 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1885 $row: the revision row for this line
1886 $s: the string representing this parsed line
1887 $classes: array containing the <li> element classes
1889 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1892 $queryInfo: the query parameters
1894 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1895 which depends on user options should install this hook and append its values to
1897 &$confstr: reference to a hash key string which can be modified
1898 $user: User (object) requesting the page
1900 'ParserAfterParse': Called from Parser::parse() just after the call to
1901 Parser::internalParse() returns.
1902 $parser: parser object
1903 $text: text being parsed
1904 $stripState: stripState used (object)
1906 'ParserAfterStrip': Called at end of parsing time.
1907 TODO: No more strip, deprecated ?
1908 $parser: parser object
1909 $text: text being parsed
1910 $stripState: stripState used (object)
1912 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1913 $parser: Parser object being used
1914 $text: text that will be returned
1916 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1917 $parser: Parser object
1918 $text: text to parse
1919 $stripState: StripState instance being used
1921 'ParserBeforeStrip': Called at start of parsing time.
1922 TODO: No more strip, deprecated ?
1923 $parser: parser object
1924 $text: text being parsed
1925 $stripState: stripState used (object)
1927 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1928 $parser: Parser object being used
1931 'ParserClearState': Called at the end of Parser::clearState().
1932 $parser: Parser object being cleared
1934 'ParserCloned': Called when the parser is cloned.
1935 $parser: Newly-cloned Parser object
1937 'ParserFirstCallInit': Called when the parser initialises for the first time.
1938 &$parser: Parser object being cleared
1940 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1942 $parser: Parser object
1943 $varCache: array to store the value in case of multiples calls of the
1945 $index: index (string) of the magic
1946 $ret: value of the magic word (the hook should set it)
1947 $frame: PPFrame object to use for expanding any template variables
1949 'ParserGetVariableValueTs': Use this to change the value of the time for the
1950 {{LOCAL...}} magic word.
1951 $parser: Parser object
1952 $time: actual time (timestamp)
1954 'ParserGetVariableValueVarCache': use this to change the value of the variable
1955 cache or return false to not use it.
1956 $parser: Parser object
1957 $varCache: variable cache (array)
1959 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
1960 ParserLimitReportFormat instead.
1961 Called at the end of Parser:parse() when the parser will
1962 include comments about size of the text parsed.
1963 $parser: Parser object
1964 &$limitReport: text that will be included (without comment tags)
1966 'ParserLimitReportFormat': Called for each row in the parser limit report that
1967 needs formatting. If nothing handles this hook, the default is to use "$key" to
1968 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
1970 $key: Key for the limit report item (string)
1971 &$value: Value of the limit report item
1972 &$report: String onto which to append the data
1973 $isHTML: If true, $report is an HTML table with two columns; if false, it's
1974 text intended for display in a monospaced font.
1975 $localize: If false, $report should be output in English.
1977 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
1978 include comments about size of the text parsed. Hooks should use
1979 $output->setLimitReportData() to populate data. Functions for this hook should
1980 not use $wgLang; do that in ParserLimitReportFormat instead.
1981 $parser: Parser object
1982 $output: ParserOutput object
1984 'ParserMakeImageParams': Called before the parser make an image link, use this
1985 to modify the parameters of the image.
1986 $title: title object representing the file
1987 $file: file object that will be used to create the image
1988 &$params: 2-D array of parameters
1989 $parser: Parser object that called the hook
1991 'ParserSectionCreate': Called each time the parser creates a document section
1992 from wikitext. Use this to apply per-section modifications to HTML (like
1993 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1994 can begin in one section and end in another. Make sure your code can handle
1995 that case gracefully. See the EditSectionClearerLink extension for an example.
1996 $parser: the calling Parser instance
1997 $section: the section number, zero-based, but section 0 is usually empty
1998 &$sectionContent: ref to the content of the section. modify this.
1999 $showEditLinks: boolean describing whether this section has an edit link
2001 'ParserTestParser': Called when creating a new instance of Parser in
2002 tests/parser/parserTest.inc.
2003 $parser: Parser object created
2005 'ParserTestGlobals': Allows to define globals for parser tests.
2006 &$globals: Array with all the globals which should be set for parser tests.
2007 The arrays keys serve as the globals names, its values are the globals values.
2009 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2010 run. Use when page save hooks require the presence of custom tables to ensure
2011 that tests continue to run properly.
2012 &$tables: array of table names
2014 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2015 my talk page, my contributions" etc).
2016 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2017 &$title: Title object representing the current page
2018 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2020 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2021 &$user : User performing the action
2022 $action : Action being performed
2023 &$result : Whether or not the action should be prevented
2024 Change $result and return false to give a definitive answer, otherwise
2025 the built-in rate limiting checks are used, if enabled.
2026 $incrBy: Amount to increment counter by
2028 'PlaceNewSection': Override placement of new sections. Return false and put the
2029 merged text into $text to override the default behavior.
2030 $wikipage : WikiPage object
2031 $oldtext : the text of the article before editing
2032 $subject : subject of the new section
2033 &$text : text of the new section
2035 'PreferencesGetLegend': Override the text used for the <legend> of a
2036 preferences section.
2037 $form: the PreferencesForm object. This is a ContextSource as well
2038 $key: the section name
2039 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2041 'PreferencesFormPreSave': Override preferences being saved
2042 $formData: array of user submitted data
2043 $form: PreferencesForm object, also a ContextSource
2044 $user: User object with preferences to be saved set
2045 &$result: boolean indicating success
2047 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2048 AJAX search suggestions. Put results into &$results outparam and return false.
2049 $ns : array of int namespace keys to search in
2050 $search : search term (not guaranteed to be conveniently normalized)
2051 $limit : maximum number of results to return
2052 &$results : out param: array of page names (strings)
2054 'PrefsEmailAudit': Called when user changes their email address.
2055 $user: User (object) changing his email address
2056 $oldaddr: old email address (string)
2057 $newaddr: new email address (string)
2059 'PrefsPasswordAudit': Called when user changes his password.
2060 $user: User (object) changing his password
2061 $newPass: new password
2062 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2064 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2066 $article: the title being (un)protected
2067 $output: a string of the form HTML so far
2069 'ProtectionForm::save': Called when a protection form is submitted.
2070 $article: the Page being (un)protected
2071 &$errorMsg: an html message string of an error or an array of message name and
2073 $reasonstr: a string describing the reason page protection level is altered
2075 'ProtectionForm::showLogExtract': Called after the protection log extract is
2077 $article: the page the form is shown for
2078 $out: OutputPage object
2080 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2081 &$obj: RawPage object
2082 &$text: The text that's going to be the output
2084 'RecentChange_save': Called at the end of RecentChange::save().
2085 $recentChange: RecentChange object
2087 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2088 names such as "oldid" that are preserved when using redirecting special pages
2089 such as Special:MyPage and Special:MyTalk.
2090 &$redirectParams: An array of parameters preserved by redirecting special pages.
2092 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2093 instance. Can be used by an extension override what skin is used in certain
2095 IContextSource $context: The RequestContext the skin is being created for.
2096 &$skin: A variable reference you may set a Skin instance or string key on to
2097 override the skin that will be used for the context.
2099 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2100 $user: The user having their password expiration reset
2101 &$newExpire: The new expiration date
2103 'ResetSessionID': Called from wfResetSessionID
2104 $oldSessionID: old session id
2105 $newSessionID: new session id
2107 'ResourceLoaderGetConfigVars': Called at the end of
2108 ResourceLoaderStartUpModule::getConfig(). Use this to export static
2109 configuration variables to JavaScript. Things that depend on the current page
2110 or request state must be added through MakeGlobalVariablesScript instead.
2111 &$vars: array( variable name => value )
2113 'ResourceLoaderGetStartupModules': DEPRECATED. Run once the startup module is being
2114 generated. This allows you to add modules to the startup module. This hook
2115 should be used sparingly since any module added here will be loaded on all
2116 pages. This hook is useful if you want to make code available to module loader
2119 'ResourceLoaderRegisterModules': Right before modules information is required,
2120 such as when responding to a resource
2121 loader request or generating HTML output.
2122 &$resourceLoader: ResourceLoader object
2124 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2125 called after the addition of 'qunit' and MediaWiki testing resources.
2126 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2127 included in core, is fed using tests/qunit/QUnitTestResources.php.
2128 &ResourceLoader object
2130 To add a new qunit module named 'myext.tests':
2131 testModules['qunit']['myext.tests'] = array(
2132 'script' => 'extension/myext/tests.js',
2133 'dependencies' => <any module dependency you might have>
2135 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2136 added to any module.
2138 'RevisionInsertComplete': Called after a revision is inserted into the database.
2139 &$revision: the Revision
2140 $data: the data stored in old_text. The meaning depends on $flags: if external
2141 is set, it's the URL of the revision text in external storage; otherwise,
2142 it's the revision text itself. In either case, if gzip is set, the revision
2144 $flags: a comma-delimited list of strings representing the options used. May
2145 include: utf8 (this will always be set for new revisions); gzip; external.
2147 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2148 the normal operations.
2149 $allSearchTerms : Array of the search terms in all content languages
2150 &$titleResult : Outparam; the value to return. A Title object or null.
2152 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2153 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2155 $term : Search term string
2156 &$title : Outparam; set to $title object and return false for a match
2158 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2159 if nothing was found.
2160 $term : Search term string
2161 &$title : Outparam; set to $title object and return false for a match
2163 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2165 $term : Search term string
2166 &$title : Current Title object that is being returned (null if none found).
2168 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
2169 $searchEngine : The SearchEngine object. Users of this hooks will be interested
2170 in the $searchEngine->namespaces array.
2171 $query : Original query.
2172 &$parsed : Resultant query with the prefixes stripped.
2174 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2176 $title : Current Title object being displayed in search results.
2177 &$id: Revision ID (default is false, for latest)
2179 'SearchableNamespaces': An option to modify which namespaces are searchable.
2180 &$arr : Array of namespaces ($nsId => $name) which will be used.
2182 'SetupAfterCache': Called in Setup.php, after cache objects are set
2184 'ShowMissingArticle': Called when generating the output for a non-existent page.
2185 $article: The article object corresponding to the page
2187 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2188 DEPRECATED, use the ContentGetParserOutput hook instead!
2189 $text: Text being shown
2190 $title: Title of the custom script/stylesheet page
2191 $output: Current OutputPage object
2193 'ShowSearchHitTitle': Customise display of search hit title/link.
2194 &$title: Title to link to
2195 &$text: Text to use for the link
2196 $result: The search result
2197 $terms: The search terms entered
2198 $page: The SpecialSearch object.
2200 'ShowSearchHit': Customize display of search hit.
2201 $searchPage: The SpecialSearch instance.
2202 $result: The SearchResult to show
2203 $terms: Search terms, for highlighting
2204 &$link: HTML of link to the matching page. May be modified.
2205 &$redirect: HTML of redirect info. May be modified.
2206 &$section: HTML of matching section. May be modified.
2207 &$extract: HTML of content extract. May be modified.
2208 &$score: HTML of score. May be modified.
2209 &$size: HTML of page size. May be modified.
2210 &$date: HTML of of page modification date. May be modified.
2211 &$related: HTML of additional info for the matching page. May be modified.
2212 &$html: May be set to the full HTML that should be used to represent the search
2213 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2214 function returned false.
2216 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2217 allow the normal method of notice selection/rendering to work, or change the
2218 value of $siteNotice and return false to alter it.
2219 &$siteNotice: HTML returned as the sitenotice
2222 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2223 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2224 the sitenotice/anonnotice.
2227 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2229 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2230 the stock bottom scripts.
2232 'SkinAfterContent': Allows extensions to add text after the page content and
2233 article metadata. This hook should work in all skins. Set the &$data variable to
2234 the text you're going to add.
2235 &$data: (string) Text to be printed out directly (without parsing)
2238 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2240 &$bar: Sidebar contents
2241 Modify $bar to add or modify sidebar portlets.
2243 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2245 &$bar: Sidebar content
2246 Modify $bar to add or modify sidebar portlets.
2247 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2249 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2251 $title: displayed page title
2252 $type: 'normal' or 'history' for old/diff views
2253 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2254 message must be in HTML format, not wikitext!
2255 &$link: overridable HTML link to be passed into the message as $1
2256 &$forContent: overridable flag if copyright footer is shown in content language.
2258 'SkinGetPoweredBy': TODO
2259 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2260 the MediaWiki icon but plain text instead.
2263 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2264 &$subpages: Subpage links HTML
2266 $out: OutputPage object
2267 If false is returned $subpages will be used instead of the HTML
2268 subPageSubtitle() generates.
2269 If true is returned, $subpages will be ignored and the rest of
2270 subPageSubtitle() will run.
2272 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2274 $sktemplate: SkinTemplate object
2275 $nav_urls: array of tabs
2277 'SkinTemplateGetLanguageLink': After building the data for a language link from
2278 which the actual html is constructed.
2279 &$languageLink: array containing data about the link. The following keys can be
2280 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2281 $languageLinkTitle: Title object belonging to the external language link
2282 $title: Title object of the page the link belongs to
2284 To alter the structured navigation links in SkinTemplates, there are three
2285 hooks called in different spots:
2287 'SkinTemplateNavigation': Called on content pages after the tabs have been
2288 added, but before variants have been added.
2289 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2290 tab is added but before variants have been added.
2291 'SkinTemplateNavigation::Universal': Called on both content and special pages
2292 after variants have been added.
2293 &$sktemplate: SkinTemplate object
2294 &$links: Structured navigation links. This is used to alter the navigation for
2295 skins which use buildNavigationUrls such as Vector.
2297 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2299 &$sktemplate: SkinTemplate object
2300 &$tpl: Template engine object
2302 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2303 $sktemplate: SkinTemplate object
2304 $res: set to true to prevent active tabs
2306 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2307 You can either create your own array, or alter the parameters for
2309 &$sktemplate: The SkinTemplate instance.
2310 $title: Title instance for the page.
2311 $message: Visible label of tab.
2312 $selected: Whether this is a selected tab.
2313 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2314 &$classes: Array of CSS classes to apply.
2315 &$query: Query string to add to link.
2317 &$result: Complete assoc. array if you want to return true.
2319 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2320 been rendered (useful for adding more).
2321 $sk: The QuickTemplate based skin template running the hook.
2322 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2323 extensions that add support for BaseTemplateToolbox should watch for this
2324 dummy parameter with "$dummy=false" in their code and return without echoing
2325 any HTML to avoid creating duplicate toolbox items.
2327 'SkinVectorStyleModules': Called when defining the list of module styles to be
2328 loaded by the Vector skin.
2329 $skin: SkinVector object
2330 &$styles: Array of module names whose style will be loaded for the skin
2332 'SoftwareInfo': Called by Special:Version for returning information about the
2334 $software: The array of software in format 'name' => 'version'. See
2335 SpecialVersion::softwareInformation().
2337 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2338 $sp: SpecialPage object, for context
2339 &$fields: Current HTMLForm fields
2341 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2342 $id: User id number, only provided for backwards-compatability
2343 $user: User object representing user contributions are being fetched for
2344 $sp: SpecialPage instance, providing context
2346 'SpecialListusersDefaultQuery': Called right before the end of
2347 UsersPager::getDefaultQuery().
2348 $pager: The UsersPager instance
2349 $query: The query array to be returned
2351 'SpecialListusersFormatRow': Called right before the end of
2352 UsersPager::formatRow().
2353 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2354 $row: Database row object
2356 'SpecialListusersHeader': Called before closing the <fieldset> in
2357 UsersPager::getPageHeader().
2358 $pager: The UsersPager instance
2359 $out: The header HTML
2361 'SpecialListusersHeaderForm': Called before adding the submit button in
2362 UsersPager::getPageHeader().
2363 $pager: The UsersPager instance
2364 $out: The header HTML
2366 'SpecialListusersQueryInfo': Called right before the end of.
2367 UsersPager::getQueryInfo()
2368 $pager: The UsersPager instance
2369 $query: The query array to be returned
2371 'SpecialMovepageAfterMove': Called after moving a page.
2372 $movePage: MovePageForm object
2373 $oldTitle: old title (object)
2374 $newTitle: new title (object)
2376 'SpecialNewpagesConditions': Called when building sql query for
2378 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2379 $opts: FormOptions object containing special page options
2380 &$conds: array of WHERE conditionals for query
2381 &tables: array of tables to be queried
2382 &$fields: array of columns to select
2383 &$join_conds: join conditions for the tables
2385 'SpecialNewPagesFilters': Called after building form options at NewPages.
2386 $special: the special page object
2387 &$filters: associative array of filter definitions. The keys are the HTML
2388 name/URL parameters. Each key maps to an associative array with a 'msg'
2389 (message key) and a 'default' value.
2391 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2392 hook to remove a core special page.
2393 $list: list (array) of core special pages
2395 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2396 $special: the SpecialPage object
2397 $subPage: the subpage string or null if no subpage was specified
2399 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2400 $special: the SpecialPage object
2401 $subPage: the subpage string or null if no subpage was specified
2403 'SpecialPasswordResetOnSubmit': When executing a form submission on
2404 Special:PasswordReset.
2405 $users: array of User objects.
2406 $data: array of data submitted by the user
2407 &$error: string, error code (message key) used to describe to error (out
2408 parameter). The hook needs to return false when setting this, otherwise it
2409 will have no effect.
2411 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2412 use this to change some selection criteria or substitute a different title.
2413 &$randstr: The random number from wfRandom()
2414 &$isRedir: Boolean, whether to select a redirect or non-redirect
2415 &$namespaces: An array of namespace indexes to get the title from
2416 &$extra: An array of extra SQL statements
2417 &$title: If the hook returns false, a Title object to use instead of the
2418 result from the normal query
2420 'SpecialRecentChangesFilters': Called after building form options at
2421 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2422 $special: the special page object
2423 &$filters: associative array of filter definitions. The keys are the HTML
2424 name/URL parameters. Each key maps to an associative array with a 'msg'
2425 (message key) and a 'default' value.
2427 'SpecialRecentChangesPanel': Called when building form options in
2428 SpecialRecentChanges.
2429 &$extraOpts: array of added items, to which can be added
2430 $opts: FormOptions for this request
2432 'SpecialRecentChangesQuery': Called when building SQL query for
2433 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2434 ChangesListSpecialPageQuery instead.
2435 &$conds: array of WHERE conditionals for query
2436 &$tables: array of tables to be queried
2437 &$join_conds: join conditions for the tables
2438 $opts: FormOptions for this request
2439 &$query_options: array of options for the database request
2440 &$select: Array of columns to select
2442 'SpecialResetTokensTokens': Called when building token list for
2444 &$tokens: array of token information arrays in the format of
2445 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2447 'SpecialSearchCreateLink': Called when making the message to create a page or
2448 go to the existing page.
2449 $t: title object searched for
2450 &$params: an array of the default message name and page title (as parameter)
2452 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2453 target doesn't exist.
2454 &$title: title object generated from the text entered by the user
2456 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2457 the advanced form, a.k.a. power search box.
2458 &$showSections: an array to add values with more options to
2459 $term: the search term (not a title object)
2460 $opts: an array of hidden options (containing 'redirs' and 'profile')
2462 'SpecialSearchProfiles': Allows modification of search profiles.
2463 &$profiles: profiles, which can be modified.
2465 'SpecialSearchProfileForm': Allows modification of search profile forms.
2466 $search: special page object
2467 &$form: String: form html
2468 $profile: String: current search profile
2469 $term: String: search term
2470 $opts: Array: key => value of hidden options for inclusion in custom forms
2472 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2473 $search: SpecialSearch special page object
2474 $profile: String: current search profile
2475 $engine: the search engine
2477 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2478 on the search results page. Useful for including an external search
2479 provider. To disable the output of MediaWiki search output, return
2481 $specialSearch: SpecialSearch object ($this)
2483 $term: Search term specified by the user
2485 'SpecialSearchResults': Called before search result display when there are
2487 $term: string of search term
2488 &$titleMatches: empty or SearchResultSet object
2489 &$textMatches: empty or SearchResultSet object
2491 'SpecialSearchNoResults': Called before search result display when there are no
2493 $term: string of search term
2495 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2496 &$extraStats: Array to save the new stats
2497 ( $extraStats['<name of statistic>'] => <value>; )
2499 'SpecialUploadComplete': Called after successfully uploading a file from
2501 $form: The SpecialUpload object
2503 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2504 use this to change the tables headers. Deprecated since MediaWiki 1.17, use the
2505 ExtensionTypes hook instead.
2506 $extTypes: associative array of extensions types
2508 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2509 $wgVersion: Current $wgVersion for you to use
2510 &$versionUrl: Raw url to link to (eg: release notes)
2512 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2513 Deprecated, use ChangesListSpecialPageFilters instead.
2514 $special: the special page object
2515 &$filters: associative array of filter definitions. The keys are the HTML
2516 name/URL parameters. Each key maps to an associative array with a 'msg'
2517 (message key) and a 'default' value.
2519 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2520 Deprecated, use ChangesListSpecialPageQuery instead.
2521 &$conds: array of WHERE conditionals for query
2522 &$tables: array of tables to be queried
2523 &$join_conds: join conditions for the tables
2524 &$fields: array of query fields
2525 $opts: A FormOptions object with watchlist options for the current request
2527 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2528 SpecialWatchlist. Allows extensions to register custom values they have
2529 inserted to rc_type so they can be returned as part of the watchlist.
2530 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2532 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2533 URL for a title when we have no other parameters on the URL. Gives a chance for
2534 extensions that alter page view behavior radically to abort that redirect or
2536 $request: WebRequest
2537 $title: Title of the currently found title obj
2538 $output: OutputPage object
2540 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2541 rendered (by ThumbnailImage:toHtml method).
2542 $thumbnail: the ThumbnailImage object
2543 &$attribs: image attribute array
2544 &$linkAttribs: image link attribute array
2546 'TitleArrayFromResult': Called when creating an TitleArray object from a
2548 &$titleArray: set this to an object to override the default object returned
2549 $res: database result used to create the object
2551 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2552 or override the quick permissions check.
2553 $title: The Title object being accessed
2554 $user: The User performing the action
2555 $action: Action being performed
2556 &$errors: Array of errors
2557 $doExpensiveQueries: Whether to do expensive DB queries
2558 $short: Whether to return immediately on first error
2560 'TitleGetEditNotices': Allows extensions to add edit notices
2561 $title: The Title object for the page the edit notices are for
2562 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2563 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2565 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2566 that can be applied.
2567 $title: The title in question.
2568 &$types: The types of protection available.
2570 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2571 $title: Title object that is being checked
2572 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2573 Hooks may change this value to override the return value of
2574 Title::isCssOrJsPage().
2576 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2577 overriding default behavior for determining if a page exists. If $isKnown is
2578 kept as null, regular checks happen. If it's a boolean, this value is returned
2579 by the isKnown method.
2580 $title: Title object that is being checked
2581 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2583 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2584 that this hook is not called for interwiki pages or pages in immovable
2585 namespaces: for these, isMovable() always returns false.
2586 $title: Title object that is being checked
2587 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2588 Hooks may change this value to override the return value of
2591 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2592 be handled by separate handler (via ArticleViewCustom).
2593 $title: Title object that is being checked
2594 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2595 Hooks may change this value to override the return value of
2596 Title::isWikitextPage()
2598 'TitleMove': Before moving an article (title).
2601 $user: user who does the move
2603 'TitleMoveComplete': After moving an article (title).
2606 $user: user who did the move
2607 $pageid: database ID of the page that's been moved
2608 $redirid: database ID of the created redirect
2609 $reason: reason for the move
2611 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2612 adding the default error message if nothing allows the user to read the page. If
2613 a handler wants a title to *not* be whitelisted, it should also return false.
2614 $title: Title object being checked against
2615 $user: Current user object
2616 &$whitelisted: Boolean value of whether this title is whitelisted
2618 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2619 $title: Title object to purge
2620 &$urls: An array of URLs to purge from the caches, to be manipulated.
2622 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2623 PageArchive object has been created but before any further processing is done.
2624 &$archive: PageArchive object
2625 $title: Title object of the page that we're viewing
2627 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2628 PageArchive object has been created but before any further processing is done.
2629 &$archive: PageArchive object
2630 $title: Title object of the page that we're viewing
2632 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2633 the site is not in read-only mode, that the Title object is not null and after
2634 a PageArchive object has been constructed but before performing any further
2636 &$archive: PageArchive object
2637 $title: Title object of the page that we're about to undelete
2639 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2640 $title: title object related to the revision
2641 $rev: revision (object) that will be viewed
2643 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2645 $action: action name
2646 $article: article "acted on"
2648 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2649 &$files: list of files
2651 'UnwatchArticle': Before a watch is removed from an article.
2652 $user: user watching
2653 $page: WikiPage object to be removed
2654 &$status: Status object to be returned if the hook returns false
2656 'UnwatchArticleComplete': After a watch is removed from an article.
2657 $user: user that watched
2658 $page: WikiPage object that was watched
2660 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2661 $formattedPageStatus: list of valid page states
2663 'UploadForm:initial': Before the upload form is generated. You might set the
2664 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2665 text (HTML) either before or after the editform.
2666 $form: UploadForm object
2668 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2669 poke at member variables like $mUploadDescription before the file is saved. Do
2670 not use this hook to break upload processing. This will return the user to a
2671 blank form with no error message; use UploadVerification and UploadVerifyFile
2673 $form: UploadForm object
2675 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2676 $type: (string) the requested upload type
2677 &$className: the class name of the Upload instance to be created
2679 'UploadComplete': when Upload completes an upload.
2680 &$upload: an UploadBase child instance
2682 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2684 $descriptor: (array) the HTMLForm descriptor
2686 'UploadFormSourceDescriptors': after the standard source inputs have been
2687 added to the descriptor
2688 $descriptor: (array) the HTMLForm descriptor
2690 'UploadVerification': Additional chances to reject an uploaded file. Consider
2691 using UploadVerifyFile instead.
2692 string $saveName: destination file name
2693 string $tempName: filesystem path to the temporary file for checks
2694 string &$error: output: message key for message to show if upload canceled by
2695 returning false. May also be an array, where the first element is the message
2696 key and the remaining elements are used as parameters to the message.
2698 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2699 in most cases over UploadVerification.
2700 object $upload: an instance of UploadBase, with all info about the upload
2701 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2702 will typically only apply for specific mime types.
2703 object &$error: output: true if the file is valid. Otherwise, an indexed array
2704 representing the problem with the file, where the first element is the message
2705 key and the remaining elements are used as parameters to the message.
2707 'UploadComplete': Upon completion of a file upload.
2708 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2709 $uploadBase->getLocalFile().
2711 'User::mailPasswordInternal': before creation and mailing of a user's new
2713 $user: the user who sent the message out
2714 $ip: IP of the user who sent the message out
2715 $u: the account whose new password will be set
2717 'UserAddGroup': Called when adding a group; return false to override
2718 stock group addition.
2719 $user: the user object that is to have a group added
2720 &$group: the group to add, can be modified
2722 'UserArrayFromResult': Called when creating an UserArray object from a database
2724 &$userArray: set this to an object to override the default object returned
2725 $res: database result used to create the object
2727 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2728 want to display an error message, try getUserPermissionsErrors.
2729 $title: Title object being checked against
2730 $user : Current user object
2731 $action: Action being checked
2732 $result: Pointer to result returned if hook returns false. If null is returned,
2733 userCan checks are continued by internal code.
2735 'UserCanSendEmail': To override User::canSendEmail() permission check.
2736 $user: User (object) whose permission is being checked
2737 &$canSend: bool set on input, can override on output
2739 'UserClearNewTalkNotification': Called when clearing the "You have new
2740 messages!" message, return false to not delete it.
2741 $user: User (object) that will clear the message
2742 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2744 'UserComparePasswords': Called when checking passwords, return false to
2745 override the default password checks.
2746 &$hash: String of the password hash (from the database)
2747 &$password: String of the plaintext password the user entered
2748 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2750 &$result: If the hook returns false, this Boolean value will be checked to
2751 determine if the password was valid
2753 'UserCreateForm': change to manipulate the login form
2754 $template: SimpleTemplate instance for the form
2756 'UserCryptPassword': Called when hashing a password, return false to implement
2757 your own hashing method.
2758 &$password: String of the plaintext password to encrypt
2759 &$salt: String of the password salt or Boolean false if no salt is provided
2760 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2762 &$hash: If the hook returns false, this String will be used as the hash
2764 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2765 $user: User to get groups for
2766 &$groups: Current effective groups
2768 'UserGetAllRights': After calculating a list of all available rights.
2769 &$rights: Array of rights, which may be added to.
2771 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2772 before returning the options to the caller. Warning: This hook is called for
2773 every call to User::getDefaultOptions(), which means it's potentially called
2774 dozens or hundreds of times. You may want to cache the results of non-trivial
2775 operations in your hook function for this reason.
2776 &$defaultOptions: Array of preference keys and their default values.
2778 'UserGetEmail': Called when getting an user email address.
2780 &$email: email, change this to override local email
2782 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2783 email authentication.
2785 &$timestamp: timestamp, change this to override local email authentication
2788 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2789 &$groups: List of implicit (automatically-assigned) groups
2791 'UserGetLanguageObject': Called when getting user's interface language object.
2793 &$code: Language code that will be used to create the object
2794 $context: RequestContext object
2796 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2797 &$reservedUsernames: $wgReservedUsernames
2799 'UserGetRights': Called in User::getRights().
2800 $user: User to get rights for
2801 &$rights: Current rights
2803 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2804 specific block exemptions).
2805 $user: User in question
2806 $title: Title of the page in question
2807 &$blocked: Out-param, whether or not the user is blocked from that page.
2808 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2809 to edit their own user talk pages.
2811 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2813 $ip: User's IP address
2814 &$blocked: Whether the user is blocked, to be modified by the hook
2816 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2817 false if a UserGetRights hook might remove the named right.
2818 $right: The user right being checked
2820 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2821 environmental means; occurs after session is loaded.
2822 $user: user object being loaded
2824 'UserLoadDefaults': Called when loading a default user.
2828 'UserLoadFromDatabase': Called when loading a user from the database.
2830 &$s: database query object
2832 'UserLoadFromSession': Called to authenticate users on external/environmental
2833 means; occurs before session is loaded.
2834 $user: user object being loaded
2835 &$result: set this to a boolean value to abort the normal authentication
2838 'UserLoadOptions': When user options/preferences are being loaded from the
2841 &$options: Options, can be modified.
2843 'UserLoginComplete': After a user has logged in.
2844 $user: the user object that was created on login
2845 $inject_html: Any HTML to inject after the "logged in" message.
2847 'UserLoginForm': change to manipulate the login form
2848 $template: SimpleTemplate instance for the form
2850 'UserLogout': Before a user logs out.
2851 $user: the user object that is about to be logged out
2853 'UserLogoutComplete': After a user has logged out.
2854 $user: the user object _after_ logout (won't have name, ID, etc.)
2855 $inject_html: Any HTML to inject after the "logged out" message.
2856 $oldName: name of the user before logout (string)
2858 'UserRemoveGroup': Called when removing a group; return false to override stock
2860 $user: the user object that is to have a group removed
2861 &$group: the group to be removed, can be modified
2863 'UserRights': After a user's group memberships are changed.
2864 $user : User object that was changed
2865 $add : Array of strings corresponding to groups added
2866 $remove: Array of strings corresponding to groups removed
2868 'UserRequiresHTTPS': Called to determine whether a user needs
2869 to be switched to HTTPS.
2870 $user: User in question.
2871 &$https: Boolean whether $user should be switched to HTTPS.
2874 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2876 $user: user retrieving new talks messages
2877 $talks: array of new talks page(s)
2879 'UserSaveSettings': Called when saving user settings.
2882 'UserSaveOptions': Called just before saving user preferences/options.
2884 &$options: Options, modifiable
2886 'UserSetCookies': Called when setting user cookies.
2888 &$session: session array, will be added to $_SESSION
2889 &$cookies: cookies array mapping cookie name to its value
2891 'UserSetEmail': Called when changing user email address.
2893 &$email: new email, change this to override new email address
2895 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2896 email authentication.
2898 &$timestamp: new timestamp, change this to override local email
2899 authentication timestamp
2901 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2902 "Foobar (Talk | Contribs | Block)".
2903 $userId: User id of the current user
2904 $userText: User name of the current user
2905 &$items: Array of user tool links as HTML fragments
2907 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2908 FormatMetadata::getExtendedMeta (return false means cache will be
2909 invalidated and GetExtendedMetadata hook called again).
2910 $timestamp: The timestamp metadata was generated
2911 $file: The file the metadata is for
2913 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2914 used to alter the SQL query which gets the list of wanted pages.
2915 &$wantedPages: WantedPagesPage object
2916 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2918 'WatchArticle': Before a watch is added to an article.
2919 $user: user that will watch
2920 $page: WikiPage object to be watched
2921 &$status: Status object to be returned if the hook returns false
2923 'WatchArticleComplete': After a watch is added to an article.
2924 $user: user that watched
2925 $page: WikiPage object watched
2927 'WatchlistEditorBuildRemoveLine': when building remove lines in
2928 Special:Watchlist/edit.
2929 &$tools: array of extra links
2930 $title: Title object
2931 $redirect: whether the page is a redirect
2934 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2936 $router: The PathRouter instance
2938 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
2939 Return false to prevent setting of the cookie.
2940 &$name: Cookie name passed to WebResponse::setcookie()
2941 &$value: Cookie value passed to WebResponse::setcookie()
2942 &$expire: Cookie expiration, as for PHP's setcookie()
2943 $options: Options passed to WebResponse::setcookie()
2945 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
2946 $row: The DB row of the entry.
2947 $title: The Title of the page where the link comes FROM
2948 $target: The Title of the page where the link goes TO
2949 &$props: Array of HTML strings to display after the title.
2951 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2952 dumps. One, and only one hook should set this, and return false.
2953 &$tables: Database tables to use in the SELECT query
2954 &$opts: Options to use for the query
2955 &$join: Join conditions
2957 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2958 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2959 specific to a content model should be provided by the respective Content's
2960 getDeletionUpdates() method.
2962 $content: the Content to generate updates for
2963 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2965 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2966 run a MediaWiki cli script.
2967 &$script: MediaWiki cli script path
2968 &$parameters: Array of arguments and options to the script
2969 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2972 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
2973 to add new query pages to be updated with maintenance/updateSpecialPages.php.
2974 $qp: The list of QueryPages
2976 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2977 extra metadata to be added.
2978 $obj: The XmlDumpWriter object.
2979 &$out: The output string.
2980 $row: The database row for the page.
2981 $title: The title of the page.
2983 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2985 $obj: The XmlDumpWriter object.
2986 &$out: The text being output.
2987 $row: The database row for the revision.
2988 $text: The revision text.
2990 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2991 to add additional tags to extract.
2992 &$items: Array containing information on which items to extract. See XMPInfo for
2993 details on the format.
2995 'XMPGetResults': Called just before returning the results array of parsing xmp
2996 data. Can be used to post-process the results.
2997 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2998 is an array of metadata tags returned (each tag is either a value, or an array
3001 More hooks might be available but undocumented, you can execute
3002 "php maintenance/findHooks.php" to find hidden ones.