3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
254 'AbortLogin': Return false to cancel account login.
255 $user: the User object being authenticated against
256 $password: the password being submitted, not yet checked for validity
257 &$retval: a LoginForm class constant to return from authenticateUserData();
258 default is LoginForm::ABORTED. Note that the client may be using
259 a machine API rather than the HTML user interface.
260 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
262 'AbortMove': Allows to abort moving an article (title).
265 $user: user who is doing the move
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
273 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
274 $targetUser: the user whom to send talk page email notification
275 $title: the page title
277 'AbortChangePassword': Return false to cancel password change.
278 $user: the User object to which the password change is occuring
279 $mOldpass: the old password provided by the user
280 $newpass: the new password provided by the user
281 &$abortMsg: the message identifier for abort reason
283 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
284 $name: name of the action
285 &$form: HTMLForm object
286 $article: Article object
288 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
289 Allows to change the fields on the form that will be generated.
290 $name: name of the action
291 &$fields: HTMLForm descriptor array
292 $article: Article object
294 'AddNewAccount': After a user account is created.
295 $user: the User object that was created. (Parameter added in 1.7)
296 $byEmail: true when account was created "by email" (added in 1.12)
298 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
299 $apiModule: the ApiCreateAccount module calling
300 $loginForm: the LoginForm used
302 'AddNewAccountApiResult': Modify API output when creating a new account via API.
303 $apiModule: the ApiCreateAccount module calling
304 $loginForm: the LoginForm used
305 &$result: associative array for API result data
307 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
308 ob_end_flush() which will send the buffered output to the client. This allows
309 for last-minute modification of the output within the buffer by using
311 &$output: OutputPage object
313 'AfterImportPage': When a page import is completed.
314 $title: Title under which the revisions were imported
315 $origTitle: Title provided by the XML file
316 $revCount: Number of revisions in the XML file
317 $sRevCount: Number of successfully imported revisions
318 $pageInfo: associative array of page information
320 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
321 before OutputPage::sendCacheControl() and final ob_end_flush() which
322 will send the buffered output to the client. This allows for last-minute
323 modification of the output within the buffer by using ob_get_clean().
324 $output: The OutputPage object where output() was called
326 'AjaxAddScript': Called in output page just before the initialisation
327 of the javascript ajax engine. The hook is only called when ajax
328 is enabled ( $wgUseAjax = true; ).
329 &$output: OutputPage object
331 'AlternateEdit': Before checking if a user can edit a page and before showing
332 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
333 $editPage: the EditPage object
335 'AlternateEditPreview': Before generating the preview of the page when editing
336 ( EditPage::getPreviewText() ).
337 $editPage: the EditPage object
338 &$content: the Content object for the text field from the edit page
339 &$previewHTML: Text to be placed into the page for the preview
340 &$parserOutput: the ParserOutput object for the preview
341 return false and set $previewHTML and $parserOutput to output custom page
344 'AlternateUserMailer': Called before mail is sent so that mail could be logged
345 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
346 the regular method of sending mail. Return a string to return a php-mail-error
347 message containing the error. Returning true will continue with sending email
349 $headers: Associative array of headers for the email
350 $to: MailAddress object or array
352 $subject: Subject of the email
353 $body: Body of the message
355 'APIAfterExecute': After calling the execute() method of an API module. Use
356 this to extend core API modules.
357 &$module: Module object
359 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
360 &$main: ApiMain object
362 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
363 authenticate and authorize API clients before executing the module. Return
364 false and set a message to cancel the request.
365 $module: Module object
367 &$message: API usage message to die with, as a message key or array
368 as accepted by ApiBase::dieUsageMsg.
370 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
371 processing request parameters. Return false to let the request fail, returning
372 an error message or an <edit result="Failure"> tag if $resultArr was filled.
373 $editPage : the EditPage object
374 $text : the new text of the article (has yet to be saved)
375 &$resultArr : data in this array will be added to the API result
377 'APIGetAllowedParams': Use this hook to modify a module's parameters.
378 &$module: ApiBase Module object
379 &$params: Array of parameters
380 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
382 'APIGetDescription': Use this hook to modify a module's description.
383 &$module: ApiBase Module object
384 &$desc: Array of descriptions
386 'APIGetParamDescription': Use this hook to modify a module's parameter
388 &$module: ApiBase Module object
389 &$desc: Array of parameter descriptions
391 'APIGetResultProperties': Use this hook to modify the properties in a module's
393 &$module: ApiBase Module object
394 &$properties: Array of properties
396 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
398 $module: ApiBase Module object
399 &$possibleErrors: Array of possible errors
401 'APIQueryAfterExecute': After calling the execute() method of an
402 action=query submodule. Use this to extend core API modules.
403 &$module: Module object
405 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
406 an action=query submodule. Use this to extend core API modules.
407 &$module: Module object
408 &$resultPageSet: ApiPageSet object
410 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
411 token has an action, which will be used in the intoken parameter and in the
412 output (actiontoken="..."), and a callback function which should return the
413 token, or false if the user isn't allowed to obtain it. The prototype of the
414 callback function is func($pageid, $title), where $pageid is the page ID of the
415 page the token is requested for and $title is the associated Title object. In
416 the hook, just add your callback to the $tokenFunctions array and return true
417 (returning false makes no sense).
418 $tokenFunctions: array(action => callback)
420 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
421 Every token has an action, which will be used in the rvtoken parameter and in
422 the output (actiontoken="..."), and a callback function which should return the
423 token, or false if the user isn't allowed to obtain it. The prototype of the
424 callback function is func($pageid, $title, $rev), where $pageid is the page ID
425 of the page associated to the revision the token is requested for, $title the
426 associated Title object and $rev the associated Revision object. In the hook,
427 just add your callback to the $tokenFunctions array and return true (returning
428 false makes no sense).
429 $tokenFunctions: array(action => callback)
431 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
432 list=recentchanges. Every token has an action, which will be used in the rctoken
433 parameter and in the output (actiontoken="..."), and a callback function which
434 should return the token, or false if the user isn't allowed to obtain it. The
435 prototype of the callback function is func($pageid, $title, $rc), where $pageid
436 is the page ID of the page associated to the revision the token is requested
437 for, $title the associated Title object and $rc the associated RecentChange
438 object. In the hook, just add your callback to the $tokenFunctions array and
439 return true (returning false makes no sense).
440 $tokenFunctions: array(action => callback)
442 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
443 sites general information.
444 $module: the current ApiQuerySiteInfo module
445 &$results: array of results, add things here
447 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
448 sites statistics information.
449 &$results: array of results, add things here
451 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
452 token has an action, which will be used in the ustoken parameter and in the
453 output (actiontoken="..."), and a callback function which should return the
454 token, or false if the user isn't allowed to obtain it. The prototype of the
455 callback function is func($user) where $user is the User object. In the hook,
456 just add your callback to the $tokenFunctions array and return true (returning
457 false makes no sense).
458 $tokenFunctions: array(action => callback)
460 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
461 an exception is thrown during API action execution.
462 $apiMain: Calling ApiMain instance.
463 $e: Exception object.
465 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
466 should have its own entry in the $apis array and have a unique name, passed as
467 key for the array that represents the service data. In this data array, the
468 key-value-pair identified by the apiLink key is required.
469 &$apis: array of services
471 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
473 &$tokenTypes: supported token types in format 'type' => callback function
474 used to retrieve this type of tokens.
476 'Article::MissingArticleConditions': Before fetching deletion & move log entries
477 to display a message of a non-existing page being deleted/moved, give extensions
478 a chance to hide their (unrelated) log entries.
479 &$conds: Array of query conditions (all of which have to be met; conditions will
480 AND in the final query)
481 $logTypes: Array of log types being queried
483 'ArticleAfterFetchContent': After fetching content of an article from the
484 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
485 $article: the article (object) being loaded from the database
486 &$content: the content (string) of the article
488 'ArticleAfterFetchContentObject': After fetching content of an article from the
490 $article: the article (object) being loaded from the database
491 &$content: the content of the article, as a Content object
493 'ArticleConfirmDelete': Before writing the confirmation form for article
495 $article: the article (object) being deleted
496 $output: the OutputPage object
497 &$reason: the reason (string) the article is being deleted
499 'ArticleContentOnDiff': Before showing the article content below a diff. Use
500 this to change the content in this area or how it is loaded.
501 $diffEngine: the DifferenceEngine
502 $output: the OutputPage object
504 'ArticleDelete': Before an article is deleted.
505 $wikiPage: the WikiPage (object) being deleted
506 $user: the user (object) deleting the article
507 $reason: the reason (string) the article is being deleted
508 $error: if the deletion was prohibited, the (raw HTML) error message to display
510 $status: Status object, modify this to throw an error. Overridden by $error
513 'ArticleDeleteComplete': After an article is deleted.
514 $wikiPage: the WikiPage that was deleted
515 $user: the user that deleted the article
516 $reason: the reason the article was deleted
517 $id: id of the article that was deleted
518 $content: the Content of the deleted page
519 $logEntry: the ManualLogEntry used to record the deletion
521 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
523 &$wikiPage: WikiPage (object) of the user talk page
524 $recipient: User (object) who's talk page was edited
526 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
527 article has been changed.
528 $wikiPage: the WikiPage (object)
529 $editInfo: data holder that includes the parser output ($editInfo->output) for
530 that page after the change
531 $changed: bool for if the page was changed
533 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
534 recentchanges table, return false to not delete old entries.
535 $wikiPage: WikiPage (object) being modified
537 'ArticleFromTitle': when creating an article object from a title object using
538 Wiki::articleFromTitle().
539 $title: Title (object) used to create the article object
540 $article: Article (object) that will be returned
542 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
543 PageContentInsertComplete.
544 $wikiPage: WikiPage created
545 $user: User creating the article
547 $summary: Edit summary/comment
548 $isMinor: Whether or not the edit was marked as minor
549 $isWatch: (No longer used)
550 $section: (No longer used)
551 $flags: Flags passed to WikiPage::doEditContent()
552 $revision: New Revision of the article
554 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
555 $targetTitle: target title (object)
556 $destTitle: destination title (object)
558 'ArticlePageDataAfter': After loading data of an article from the database.
559 $wikiPage: WikiPage (object) whose data were loaded
560 $row: row (object) returned from the database server
562 'ArticlePageDataBefore': Before loading data of an article from the database.
563 $wikiPage: WikiPage (object) that data will be loaded
564 $fields: fields (array) to load from the database
566 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
567 $wikiPage: the WikiPage being saved
568 $popts: parser options to be used for pre-save transformation
570 'ArticleProtect': Before an article is protected.
571 $wikiPage: the WikiPage being protected
572 $user: the user doing the protection
573 $protect: boolean whether this is a protect or an unprotect
574 $reason: Reason for protect
575 $moveonly: boolean whether this is for move only or not
577 'ArticleProtectComplete': After an article is protected.
578 $wikiPage: the WikiPage that was protected
579 $user: the user who did the protection
580 $protect: boolean whether it was a protect or an unprotect
581 $reason: Reason for protect
582 $moveonly: boolean whether it was for move only or not
584 'ArticlePurge': Before executing "&action=purge".
585 $wikiPage: WikiPage (object) to purge
587 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
588 revisions of an article.
589 &$title: Title object of the article
591 'ArticleRevisionUndeleted': After an article revision is restored.
592 $title: the article title
593 $revision: the revision
594 $oldPageID: the page ID of the revision when archived (may be null)
596 'ArticleRollbackComplete': After an article rollback is completed.
597 $wikiPage: the WikiPage that was edited
598 $user: the user who did the rollback
599 $revision: the revision the page was reverted back to
600 $current: the reverted revision
602 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
604 $wikiPage: the WikiPage (object) being saved
605 $user: the user (object) saving the article
606 $text: the new article text
607 $summary: the article summary (comment)
612 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
613 PageContentSaveComplete instead.
614 $wikiPage: WikiPage modified
615 $user: User performing the modification
617 $summary: Edit summary/comment
618 $isMinor: Whether or not the edit was marked as minor
619 $isWatch: (No longer used)
620 $section: (No longer used)
621 $flags: Flags passed to WikiPage::doEditContent()
622 $revision: New Revision of the article
623 $status: Status object about to be returned by doEditContent()
624 $baseRevId: the rev ID (or false) this edit was based on
626 'ArticleUndelete': When one or more revisions of an article are restored.
627 $title: Title corresponding to the article restored
628 $create: Whether or not the restoration caused the page to be created (i.e. it
629 didn't exist before).
630 $comment: The comment associated with the undeletion.
632 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
633 $pageArchive: the PageArchive object
634 &$logEntry: ManualLogEntry object
635 $user: User who is performing the log action
637 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
638 the user is redirected back to the page.
639 &$article: the article
640 &$sectionanchor: The section anchor link (e.g. "#overview" )
641 &$extraq: Extra query parameters which can be added via hooked functions
643 'ArticleViewFooter': After showing the footer section of an ordinary page view
644 $article: Article object
645 $patrolFooterShown: boolean whether patrol footer is shown
647 'ArticleViewHeader': Before the parser cache is about to be tried for article
649 &$article: the article
650 &$pcache: whether to try the parser cache or not
651 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
652 object to both indicate that the output is done and what parser output was used.
654 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
655 redirect was followed.
656 $article: target article (object)
658 'ArticleViewCustom': Allows to output the text of the article in a different
659 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
660 that it is preferable to implement proper handing for a custom data type using
661 the ContentHandler facility.
662 $text: text of the page
663 $title: title of the page
664 $output: reference to $wgOut
666 'ArticleContentViewCustom': Allows to output the text of the article in a
667 different format than wikitext. Note that it is preferable to implement proper
668 handing for a custom data type using the ContentHandler facility.
669 $content: content of the page, as a Content object
670 $title: title of the page
671 $output: reference to $wgOut
673 'AuthPluginAutoCreate': Called when creating a local account for an user logged
674 in from an external authentication method.
675 $user: User object created locally
677 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
678 Gives a chance for an extension to set it programmatically to a variable class.
679 &$auth: the $wgAuth object, probably a stub
681 'AutopromoteCondition': Check autopromote condition for user.
682 $type: condition type
685 $result: result of checking autopromote condition
687 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
691 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
692 certain title are fetched.
694 $title: title of the page to which backlinks are sought
695 &$conds: query conditions
697 'BadImage': When checking against the bad image list. Change $bad and return
698 false to override. If an image is "bad", it is not rendered inline in wiki
699 pages or galleries in category pages.
700 $name: Image name being checked
701 &$bad: Whether or not the image is "bad"
703 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
704 "noarticletext-nopermission" at Article::showMissingArticle().
705 $article: article object
707 'BeforeInitialize': Before anything is initialized in
708 MediaWiki::performRequest().
709 &$title: Title being used for request
711 &$output: OutputPage object
713 $request: WebRequest object
714 $mediaWiki: Mediawiki object
716 'BeforePageDisplay': Prior to outputting a page.
717 &$out: OutputPage object
720 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
721 override how the redirect is output by modifying, or by returning false and
722 taking over the output.
723 $out: OutputPage object
724 &$redirect: URL, modifiable
725 &$code: HTTP code (eg '301' or '302'), modifiable
727 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
728 $parser: Parser object
730 &$options: array of options to RepoGroup::findFile
731 &$descQuery: query string to add to thumbnail URL
733 FIXME: Where does the below sentence fit in?
734 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
736 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
737 $parser: Parser object
738 $title: title of the template
739 &$skip: skip this template and link it?
740 &$id: the id of the revision being parsed
742 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
743 &$parser: Parser object
744 &$ig: ImageGallery object
746 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
748 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
749 to a newly created user account.
750 &$injected_html: Any HTML to inject after the "logged in" message of a newly
753 'BitmapHandlerTransform': before a file is transformed, gives extension the
754 possibility to transform it themselves
755 $handler: BitmapHandler
757 &$scalerParams: Array with scaler parameters
758 &$mto: null, set to a MediaTransformOutput
760 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
761 normalizations have been performed, except for the $wgMaxImageArea check.
763 &$params: Array of parameters
764 &$checkImageAreaHookResult: null, set to true or false to override the
765 $wgMaxImageArea check result.
767 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
769 $block: Block object (which is set to be autoblocking)
770 &$blockIds: Array of block IDs of the autoblock
772 'BlockIp': Before an IP address or user is blocked.
773 $block: the Block object about to be saved
774 $user: the user _doing_ the block (not the one being blocked)
776 'BlockIpComplete': After an IP address or user is blocked.
777 $block: the Block object that was saved
778 $user: the user who did the block (not the one being blocked)
780 'BookInformation': Before information output on Special:Booksources.
781 $isbn: ISBN to show information for
782 $output: OutputPage object in use
784 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
785 to be able to access the wiki via HTTPS.
786 $ip: The IP address in human-readable form
787 &$canDo: This reference should be set to false if the client may not be able
790 'CanonicalNamespaces': For extensions adding their own namespaces or altering
792 Note that if you need to specify namespace protection or content model for
793 a namespace that is added in a CanonicalNamespaces hook handler, you
794 should do so by altering $wgNamespaceProtection and
795 $wgNamespaceContentModels outside the handler, in top-level scope. The
796 point at which the CanonicalNamespaces hook fires is too late for altering
797 these variables. This applies even if the namespace addition is
798 conditional; it is permissible to declare a content model and protection
799 for a namespace and then decline to actually register it.
800 &$namespaces: Array of namespace numbers with corresponding canonical names
802 'CategoryAfterPageAdded': After a page is added to a category.
803 $category: Category that page was added to
804 $wikiPage: WikiPage that was added
806 'CategoryAfterPageRemoved': After a page is removed from a category.
807 $category: Category that page was removed from
808 $wikiPage: WikiPage that was removed
810 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
811 $catpage: CategoryPage instance
813 'ChangePasswordForm': For extensions that need to add a field to the
814 ChangePassword form via the Preferences form.
815 &$extraFields: An array of arrays that hold fields like would be passed to the
818 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
819 &$changesList: ChangesList instance.
820 &$articlelink: HTML of link to article (already filled-in).
821 &$s: HTML of row that is being constructed.
822 &$rc: RecentChange instance.
823 $unpatrolled: Whether or not we are showing unpatrolled changes.
824 $watched: Whether or not the change is watched by the user.
826 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
827 $collationName: Name of the collation in question
828 &$collationObject: Null. Replace with a subclass of the Collation class that
829 implements the collation given in $collationName.
831 'ConfirmEmailComplete': Called after a user's email has been confirmed
833 $user: user (object) whose email is being confirmed
835 'ContentHandlerDefaultModelFor': Called when the default content model is determined
836 for a given title. May be used to assign a different model for that title.
837 $title: the Title in question
838 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
840 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
841 content model name, but no entry for that model exists in $wgContentHandlers.
842 $modeName: the requested content model name
843 &$handler: set this to a ContentHandler object, if desired.
845 'ConvertContent': Called by AbstractContent::convert when a conversion to another
846 content model is requested.
847 $content: The Content object to be converted.
848 $toModel: The ID of the content model to convert to.
849 $lossy: boolean indicating whether lossy conversion is allowed.
850 &$result: Output parameter, in case the handler function wants to provide a
851 converted Content object. Note that $result->getContentModel() must return $toModel.
852 Handler functions that modify $result should generally return false to further
853 attempts at conversion.
855 'ContribsPager::getQueryInfo': Before the contributions query is about to run
856 &$pager: Pager object for contributions
857 &$queryInfo: The query for the contribs Pager
859 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
860 &$data: an array of results of all contribs queries
861 $pager: The ContribsPager object hooked into
862 $offset: Index offset, inclusive
863 $limit: Exact query limit
864 $descending: Query direction, false for ascending, true for descending
866 'ContributionsLineEnding': Called before a contributions HTML line is finished
867 $page: SpecialPage object for contributions
869 $row: the DB row for this line
870 &$classes: the classes to add to the surrounding <li>
872 'ContributionsToolLinks': Change tool links above Special:Contributions
874 $title: User page title
875 &$tools: Array of tool links
877 'CustomEditor': When invoking the page editor
878 $article: Article being edited
879 $user: User performing the edit
881 Return true to allow the normal editor to be used, or false
882 if implementing a custom editor, e.g. for a special namespace,
885 'DatabaseOraclePostInit': Called after initialising an Oracle database
886 &$db: the DatabaseOracle object
888 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
889 $title: the diff page title (nullable)
890 &$oldId: the actual old Id to use in the diff
891 &$newId: the actual new Id to use in the diff (0 means current)
892 $old: the ?old= param value from the url
893 $new: the ?new= param value from the url
895 'DiffRevisionTools': Override or extend the revision tools available from the
896 diff view, i.e. undo, etc.
897 $rev: Revision object
898 &$links: Array of HTML links
900 'DiffViewHeader': Called before diff display
901 $diff: DifferenceEngine object that's calling
902 $oldRev: Revision object of the "old" revision (may be null/invalid)
903 $newRev: Revision object of the "new" revision
905 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
907 $article: article (object) being viewed
908 $oldid: oldid (int) being viewed
910 'DoEditSectionLink': Override the HTML generated for section edit links
911 $skin: Skin object rendering the UI
912 $title: Title object for the title being linked to (may not be the same as
913 the page title, if the section is included from a template)
914 $section: The designation of the section being pointed to, to be included in
915 the link, like "§ion=$section"
916 $tooltip: The default tooltip. Escape before using.
917 By default, this is wrapped in the 'editsectionhint' message.
918 &$result: The HTML to return, prefilled with the default plus whatever other
919 changes earlier hooks have made
920 $lang: The language code to use for the link in the wfMessage function
922 'EditFilter': Perform checks on an edit
923 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
924 $text: Contents of the edit box
925 $section: Section being edited
926 &$error: Error message to return
927 $summary: Edit summary for page
929 'EditFilterMerged': Post-section-merge edit filter.
930 DEPRECATED, use EditFilterMergedContent instead.
931 $editor: EditPage instance (object)
932 $text: content of the edit box
933 &$error: error message to return
934 $summary: Edit summary for page
936 'EditFilterMergedContent': Post-section-merge edit filter.
937 This may be triggered by the EditPage or any other facility that modifies page content.
938 Use the $status object to indicate whether the edit should be allowed, and to provide
939 a reason for disallowing it. Return false to abort the edit, and true to continue.
940 Returning true if $status->isOK() returns false means "don't save but continue user
941 interaction", e.g. show the edit form.
942 $context: object implementing the IContextSource interface.
943 $content: content of the edit box, as a Content object.
944 $status: Status object to represent errors, etc.
945 $summary: Edit summary for page
946 $user: the User object representing the user whois performing the edit.
947 $minoredit: whether the edit was marked as minor by the user.
949 'EditFormPreloadText': Allows population of the edit form when creating
951 &$text: Text to preload with
952 &$title: Title object representing the page being created
954 'EditFormInitialText': Allows modifying the edit form when editing existing
956 $editPage: EditPage object
958 'EditPage::attemptSave': Called before an article is
959 saved, that is before WikiPage::doEditContent() is called
960 $editpage_Obj: the current EditPage object
962 'EditPage::importFormData': allow extensions to read additional data
964 $editpage: EditPage instance
966 return value is ignored (should always return true)
968 'EditPage::showEditForm:fields': allows injection of form field into edit form
969 $editor: the EditPage instance for reference
970 $out: an OutputPage instance to write to
971 return value is ignored (should always return true)
973 'EditPage::showEditForm:initial': before showing the edit form
974 $editor: EditPage instance (object)
975 $out: an OutputPage instance to write to
977 Return false to halt editing; you'll need to handle error messages, etc.
978 yourself. Alternatively, modifying $error and returning true will cause the
979 contents of $error to be echoed at the top of the edit form as wikitext.
980 Return true without altering $error to allow the edit to proceed.
982 'EditPage::showStandardInputs:options': allows injection of form fields into
984 $editor: EditPage instance (object)
985 $out: an OutputPage instance to write to
986 &$tabindex: HTML tabindex of the last edit check/button
987 return value is ignored (should always be true)
989 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
990 when there's an edit conflict. Return false to halt normal diff output; in
991 this case you're responsible for computing and outputting the entire "conflict"
992 part, i.e., the "difference between revisions" and "your text" headers and
994 &$editor: EditPage instance
995 &$out: OutputPage instance
997 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
998 textarea in the edit form.
999 &$editpage: The current EditPage object
1000 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1001 &$tabindex: HTML tabindex of the last edit check/button
1003 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1005 &$editpage: The current EditPage object
1006 &$checks: Array of edit checks like "watch this page"/"minor edit"
1007 &$tabindex: HTML tabindex of the last edit check/button
1009 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1010 textarea in the edit form.
1011 &$toolbar: The toolbar HTMl
1013 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1014 contribution/copyright notice.
1015 $title: title of page being edited
1016 &$msg: localization message name, overridable. Default is either
1017 'copyrightwarning' or 'copyrightwarning2'.
1019 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1020 modifying the wikitext that will be used in "Show changes". Note that it is
1021 preferable to implement diff handling for different data types using the
1022 ContentHandler facility.
1023 $editPage: EditPage object
1024 &$newtext: wikitext that will be used as "your version"
1026 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1027 "Show changes". Note that it is preferable to implement diff handling for
1028 different data types using the ContentHandler facility.
1029 $editPage: EditPage object
1030 &$newtext: wikitext that will be used as "your version"
1032 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1033 Allow modifying the wikitext that will be previewed. Note that it is preferable
1034 to implement previews for different data types using the ContentHandler
1036 $editPage: EditPage object
1037 &$toparse: wikitext that will be parsed
1039 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1040 previewed. Note that it is preferable to implement previews for different data
1041 types using the ContentHandler facility.
1042 $editPage: EditPage object
1043 &$content: Content object to be previewed (may be replaced by hook function)
1045 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1046 &$editpage: The current EditPage object
1047 &$res: the HTML of the error text
1049 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1050 of terms of service summary link that might exist separately from the copyright
1052 $title: title of page being edited
1053 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1055 'EmailConfirmed': When checking that the user's email address is "confirmed".
1056 $user: User being checked
1057 $confirmed: Whether or not the email address is confirmed
1058 This runs before the other checks, such as anonymity and the real check; return
1059 true to allow those checks to occur, and false if checking is done.
1061 'EmailUser': Before sending email from one user to another.
1062 $to: address of receiving user
1063 $from: address of sending user
1064 $subject: subject of the mail
1065 $text: text of the mail
1067 'EmailUserCC': Before sending the copy of the email to the author.
1068 $to: address of receiving user
1069 $from: address of sending user
1070 $subject: subject of the mail
1071 $text: text of the mail
1073 'EmailUserComplete': After sending email from one user to another.
1074 $to: address of receiving user
1075 $from: address of sending user
1076 $subject: subject of the mail
1077 $text: text of the mail
1079 'EmailUserForm': After building the email user form object.
1080 $form: HTMLForm object
1082 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1084 $user: The user who is trying to email another user.
1085 $editToken: The user's edit token.
1086 &$hookErr: Out-param for the error. Passed as the parameters to
1087 OutputPage::showErrorPage.
1089 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1091 $ip: The ip address of the user
1093 'ExtensionTypes': Called when generating the extensions credits, use this to
1094 change the tables headers.
1095 &$extTypes: associative array of extensions types
1097 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1098 thumbnail file name.
1099 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1100 $thumbname: the base name of the thumbnail file
1101 &$params: the currently extracted params (has source name, temp or archived zone)
1103 'FetchChangesList': When fetching the ChangesList derivative for a particular
1105 $user: User the list is being fetched for
1106 &$skin: Skin object to be used with the list
1107 &$list: List object (defaults to NULL, change it to an object instance and
1108 return false override the list derivative used)
1110 'FileDeleteComplete': When a file is deleted.
1111 $file: reference to the deleted file
1112 $oldimage: in case of the deletion of an old image, the name of the old file
1113 $article: in case all revisions of the file are deleted a reference to the
1114 WikiFilePage associated with the file.
1115 $user: user who performed the deletion
1118 'FileTransformed': When a file is transformed and moved into storage.
1119 $file: reference to the File object
1120 $thumb: the MediaTransformOutput object
1121 $tmpThumbPath: The temporary file system path of the transformed file
1122 $thumbPath: The permanent storage path of the transformed file
1124 'FileUpload': When a file upload occurs.
1125 $file : Image object representing the file that was uploaded
1126 $reupload : Boolean indicating if there was a previously another image there or
1128 $hasDescription : Boolean indicating that there was already a description page
1129 and a new one from the comment wasn't created (since 1.17)
1131 'FileUndeleteComplete': When a file is undeleted
1132 $title: title object to the file
1133 $fileVersions: array of undeleted versions. Empty if all versions were restored
1134 $user: user who performed the undeletion
1137 'FormatAutocomments': When an autocomment is formatted by the Linker.
1138 &$comment: Reference to the accumulated comment. Initially null, when set the
1139 default code will be skipped.
1140 $pre: Initial part of the parsed comment before the call to the hook.
1141 $auto: The extracted part of the parsed comment before the call to the hook.
1142 $post: The final part of the parsed comment before the call to the hook.
1143 $title: An optional title object used to links to sections. Can be null.
1144 $local: Boolean indicating whether section links should refer to local page.
1146 'GalleryGetModes': Get list of classes that can render different modes of a
1148 $modeArray: An associative array mapping mode names to classes that implement
1149 that mode. It is expected all registered classes are a subclass of
1152 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1154 &$user: user to promote.
1155 &$promote: groups that will be added.
1157 'GetBlockedStatus': after loading blocking status of an user from the database
1158 $user: user (object) being checked
1160 'GetCacheVaryCookies': Get cookies that should vary cache options.
1161 $out: OutputPage object
1162 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1163 that have to vary cache options
1165 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1167 $title: Title object of page
1168 $url: string value as output (out parameter, can modify)
1169 $query: query options passed to Title::getCanonicalURL()
1171 'GetDefaultSortkey': Override the default sortkey for a page.
1172 $title: Title object that we need to get a sortkey for
1173 &$sortkey: Sortkey to use.
1175 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1176 underscore) magic words. Called by MagicWord.
1177 &$doubleUnderscoreIDs: array of strings
1179 'GetExtendedMetadata': Get extended file metadata for the API
1180 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1181 'value' => prop value, 'source' => 'name of hook' ).
1182 $file: File object of file in question
1183 $context: RequestContext (including language to use)
1184 $single: Only extract the current language; if false, the prop value should
1185 be in the metadata multi-language array format:
1186 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1187 &$maxCacheTime: how long the results can be cached
1189 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1190 $title: Title object of page
1191 $url: string value as output (out parameter, can modify)
1192 $query: query options passed to Title::getFullURL()
1194 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1195 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1197 &$output: string for the output timestamp
1198 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1199 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1200 $user: User whose preferences are being used to make timestamp
1201 $lang: Language that will be used to render the timestamp
1203 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1204 $title: Title object of page
1205 $url: string value as output (out parameter, can modify)
1206 $query: query options passed to Title::getInternalURL()
1208 'GetIP': modify the ip of the current user (called only once).
1209 &$ip: string holding the ip as determined so far
1211 'GetLinkColours': modify the CSS class of an array of page links.
1212 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1214 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1216 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1217 working with internal urls (non-interwiki) then it may be preferable to work
1218 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1219 be buggy for internal urls on render if you do not re-implement the horrible
1220 hack that Title::getLocalURL uses in your own extension.
1221 $title: Title object of page
1222 &$url: string value as output (out parameter, can modify)
1223 $query: query options passed to Title::getLocalURL()
1225 'GetLocalURL::Internal': Modify local URLs to internal pages.
1226 $title: Title object of page
1227 &$url: string value as output (out parameter, can modify)
1228 $query: query options passed to Title::getLocalURL()
1230 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1231 without any fancy queries or variants.
1232 $title: Title object of page
1233 &$url: string value as output (out parameter, can modify)
1235 'GetLogTypesOnUser': Add log types where the target is a userpage
1236 &$types: Array of log types
1238 'GetMetadataVersion': Modify the image metadata version currently in use. This
1239 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1240 that need to have versioned metadata should add an element to the end of the
1241 version array of the form 'handler_name=version'. Most media handlers won't need
1242 to do this unless they broke backwards compatibility with a previous version of
1243 the media handler metadata output.
1244 &$version: Array of version strings
1246 'GetNewMessagesAlert': Disable or modify the new messages alert
1247 &$newMessagesAlert: An empty string by default. If the user has new talk page
1248 messages, this should be populated with an alert message to that effect
1249 $newtalks: An empty array if the user has no new messages or an array containing
1250 links and revisions if there are new messages (See User::getNewMessageLinks)
1251 $user: The user object of the user who is loading the page
1252 $out: OutputPage object (to check what type of page the user is on)
1254 'GetPreferences': Modify user preferences.
1255 $user: User whose preferences are being modified.
1256 &$preferences: Preferences description array, to be fed to an HTMLForm object
1258 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1259 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1261 &$output: string for the output timestamp
1262 &$diff: DateInterval representing the difference between the timestamps
1263 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1264 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1265 $user: User whose preferences are being used to make timestamp
1266 $lang: Language that will be used to render the timestamp
1268 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1269 checked for. Use instead of userCan for most cases. Return false if the user
1270 can't do it, and populate $result with the reason in the form of
1271 array( messagename, param1, param2, ... ). For consistency, error messages
1272 should be plain text with no special coloring, bolding, etc. to show that
1273 they're errors; presenting them properly to the user as errors is done by the
1275 $title: Title object being checked against
1276 $user : Current user object
1277 $action: Action being checked
1278 $result: User permissions error to add. If none, return true.
1280 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1281 called only if expensive checks are enabled. Add a permissions error when
1282 permissions errors are checked for. Return false if the user can't do it, and
1283 populate $result with the reason in the form of array( messagename, param1,
1284 param2, ... ). For consistency, error messages should be plain text with no
1285 special coloring, bolding, etc. to show that they're errors; presenting them
1286 properly to the user as errors is done by the caller.
1288 $title: Title object being checked against
1289 $user : Current user object
1290 $action: Action being checked
1291 $result: User permissions error to add. If none, return true.
1293 'GitViewers': Called when generating the list of git viewers for
1294 Special:Version, use this to change the list.
1295 &$extTypes: associative array of repo URLS to viewer URLs.
1297 'HistoryRevisionTools': Override or extend the revision tools available from the
1298 page history view, i.e. undo, rollback, etc.
1299 $rev: Revision object
1300 &$links: Array of HTML links
1302 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1303 image insertion. You can skip the default logic entirely by returning false, or
1304 just modify a few things using call-by-reference.
1306 &$title: Title object of the image
1307 &$file: File object, or false if it doesn't exist
1308 &$frameParams: Various parameters with special meanings; see documentation in
1309 includes/Linker.php for Linker::makeImageLink
1310 &$handlerParams: Various parameters with special meanings; see documentation in
1311 includes/Linker.php for Linker::makeImageLink
1312 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1313 &$res: Final HTML output, used if you return false
1316 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1317 the image on an image page.
1318 $imagePage: ImagePage object ($this)
1321 'ImagePageAfterImageLinks': Called after the image links section on an image
1323 $imagePage: ImagePage object ($this)
1324 &$html: HTML for the hook to add
1326 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1328 $line: the HTML of the history line
1329 $css: the line CSS class
1331 'ImagePageFindFile': Called when fetching the file associated with an image
1333 $page: ImagePage object
1335 &$displayFile: displayed File object
1337 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1338 $page: ImagePage object
1339 &$toc: Array of <li> strings
1341 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1343 &$title: the Title object of the file as it would appear for the upload page
1344 &$path: the original file and path name when img_auth was invoked by the the web
1346 &$name: the name only component of the file
1347 &$result: The location to pass back results of the hook routine (only used if
1349 $result[0]=The index of the header message
1350 $result[1]=The index of the body text message
1351 $result[2 through n]=Parameters passed to body text message. Please note the
1352 header message cannot receive/use parameters.
1354 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1355 $reader: XMLReader object
1356 $logInfo: Array of information
1357 Return false to stop further processing of the tag
1359 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1360 $reader: XMLReader object
1361 $pageInfo: Array of information
1362 Return false to stop further processing of the tag
1364 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1365 $reader: XMLReader object
1366 $pageInfo: Array of page information
1367 $revisionInfo: Array of revision information
1368 Return false to stop further processing of the tag
1370 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1371 $reader: XMLReader object
1372 Return false to stop further processing of the tag
1374 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1375 $reader: XMLReader object
1376 $revisionInfo: Array of information
1377 Return false to stop further processing of the tag
1379 'InfoAction': When building information to display on the action=info page.
1380 $context: IContextSource object
1381 &$pageInfo: Array of information
1383 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1384 $title: Title object for the current page
1385 $request: WebRequest
1386 $ignoreRedirect: boolean to skip redirect check
1387 $target: Title/string of redirect target
1388 $article: Article object
1390 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1391 Return true without providing an interwiki to continue interwiki search.
1392 $prefix: interwiki prefix we are looking for.
1393 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1394 iw_trans and optionally iw_api and iw_wikiid.
1396 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1397 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1398 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1399 template/parser function execution which respect nowiki and HTML-comments.
1400 &$parser: Parser object
1401 &$text: string containing partially parsed text
1402 &$stripState: Parser's internal StripState object
1404 'InternalParseBeforeLinks': during Parser's internalParse method before links
1405 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1406 &$parser: Parser object
1407 &$text: string containing partially parsed text
1408 &$stripState: Parser's internal StripState object
1410 'InvalidateEmailComplete': Called after a user's email has been invalidated
1412 $user: user (object) whose email is being invalidated
1414 'IRCLineURL': When constructing the URL to use in an IRC notification.
1415 Callee may modify $url and $query, URL will be constructed as $url . $query
1416 &$url: URL to index.php
1417 &$query: Query string
1419 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1420 $article: article (object) being checked
1422 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1424 $result: Change this value to override the result of wfIsTrustedProxy()
1426 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1427 $url: URL used to upload from
1428 &$allowed: Boolean indicating if uploading is allowed for given URL
1430 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1431 instance to return false if the domain name doesn't match your organization.
1432 $addr: The e-mail address entered by the user
1433 &$result: Set this and return false to override the internal checks
1435 'isValidPassword': Override the result of User::isValidPassword()
1436 $password: The password entered by the user
1437 &$result: Set this and return false to override the internal checks
1438 $user: User the password is being validated for
1440 'Language::getMessagesFileName':
1441 $code: The language code or the language we're looking for a messages file for
1442 &$file: The messages file path, you can override this to change the location.
1444 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1445 remove namespaces. Do not use this hook to add namespaces. Use
1446 CanonicalNamespaces for that.
1447 &$namespaces: Array of namespaces indexed by their numbers
1449 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1450 $wgExtensionMessagesFiles instead.
1451 Use this to define synonyms of magic words depending of the language
1452 $magicExtensions: associative array of magic words synonyms
1453 $lang: language code (string)
1455 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1456 listed in $wgExtensionMessagesFiles instead.
1457 Use to define aliases of special pages names depending of the language
1458 $specialPageAliases: associative array of magic words synonyms
1459 $lang: language code (string)
1461 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1462 &$names: array of language code => language name
1463 $code language of the preferred translations
1465 'LanguageLinks': Manipulate a page's language links. This is called
1466 in various places to allow extensions to define the effective language
1468 $title: The page's Title.
1469 &$links: Associative array mapping language codes to prefixed links of the
1470 form "language:title".
1471 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1472 Currently unused, but planned to provide support for marking individual
1473 language links in the UI, e.g. for featured articles.
1475 'LinkBegin': Used when generating internal and interwiki links in
1476 Linker::link(), before processing starts. Return false to skip default
1477 processing and return $ret. See documentation for Linker::link() for details on
1478 the expected meanings of parameters.
1479 $skin: the Skin object
1480 $target: the Title that the link is pointing to
1481 &$html: the contents that the <a> tag should have (raw HTML); null means
1483 &$customAttribs: the HTML attributes that the <a> tag should have, in
1484 associative array form, with keys and values unescaped. Should be merged with
1485 default values, with a value of false meaning to suppress the attribute.
1486 &$query: the query string to add to the generated URL (the bit after the "?"),
1487 in associative array form, with keys and values unescaped.
1488 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1489 &$ret: the value to return if your hook returns false.
1491 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1492 just before the function returns a value. If you return true, an <a> element
1493 with HTML attributes $attribs and contents $html will be returned. If you
1494 return false, $ret will be returned.
1495 $skin: the Skin object
1496 $target: the Title object that the link is pointing to
1497 $options: the options. Will always include either 'known' or 'broken', and may
1498 include 'noclasses'.
1499 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1500 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1501 associative array form.
1502 &$ret: the value to return if your hook returns false.
1504 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1506 &$url: the image url
1507 &$alt: the image's alt text
1508 &$img: the new image HTML (if returning false)
1510 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1513 &$text: the link text
1514 &$link: the new link HTML (if returning false)
1515 &$attribs: the attributes to be applied.
1516 $linkType: The external link type
1518 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1520 &$linksUpdate: the LinksUpdate object
1522 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1523 each link table insert. For example, pagelinks, imagelinks, externallinks.
1524 $linksUpdate: LinksUpdate object
1525 $table: the table to insert links to
1526 $insertions: an array of links to insert
1528 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1529 including delete and insert, has completed for all link tables
1530 &$linksUpdate: the LinksUpdate object
1532 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1533 &$linksUpdate: the LinksUpdate object
1535 'ListDefinedTags': When trying to find all defined tags.
1536 &$tags: The list of tags.
1538 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1539 &updater: A DatabaseUpdater subclass
1541 'LocalFile::getHistory': Called before file history query performed.
1542 $file: the File object
1544 $fields: select fields
1546 $opts: query options
1547 $join_conds: JOIN conditions
1549 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1550 $file: the File object
1551 $archiveName: name of an old file version or false if it's the current one
1553 'LocalisationCacheRecache': Called when loading the localisation data into
1555 $cache: The LocalisationCache object
1556 $code: language code
1557 &$alldata: The localisation data from core and extensions
1558 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1560 'LocalisationChecksBlacklist': When fetching the blacklist of
1561 localisation checks.
1562 &$blacklist: array of checks to blacklist. See the bottom of
1563 maintenance/language/checkLanguage.inc for the format of this variable.
1565 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1566 Returning false will prevent the string from being added to the OutputPage.
1567 &$s: html string to show for the log extract
1568 $types: String or Array Log types to show
1569 $page: String or Title The page title to show log entries for
1570 $user: String The user who made the log entries
1571 $param: Associative Array with the following additional options:
1572 - lim Integer Limit of items to show, default is 50
1573 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1574 - showIfEmpty boolean Set to false if you don't want any output in case the
1575 loglist is empty if set to true (default), "No matching items in log" is
1576 displayed if loglist is empty
1577 - msgKey Array If you want a nice box with a message, set this to the key of
1578 the message. First element is the message key, additional optional elements
1579 are parameters for the key that are processed with
1580 wfMessage()->params()->parseAsBlock()
1581 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1583 - wrap String Wrap the message in html (usually something like
1584 "<div ...>$1</div>").
1585 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1587 'LoginAuthenticateAudit': A login attempt for a valid user account either
1588 succeeded or failed. No return data is accepted; this hook is for auditing only.
1589 $user: the User object being authenticated against
1590 $password: the password being submitted and found wanting
1591 $retval: a LoginForm class constant with authenticateUserData() return
1592 value (SUCCESS, WRONG_PASS, etc.).
1594 'LogLine': Processes a single log entry on Special:Log.
1595 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1596 logging.log_type database field.
1597 $log_action: string for the type of log action (e.g. 'delete', 'block',
1598 'create2'). Corresponds to logging.log_action database field.
1599 $title: Title object that corresponds to logging.log_namespace and
1600 logging.log_title database fields.
1601 $paramArray: Array of parameters that corresponds to logging.log_params field.
1602 Note that only $paramArray[0] appears to contain anything.
1603 &$comment: string that corresponds to logging.log_comment database field, and
1604 which is displayed in the UI.
1605 &$revert: string that is displayed in the UI, similar to $comment.
1606 $time: timestamp of the log entry (added in 1.12)
1608 'LonelyPagesQuery': Allow extensions to modify the query used by
1609 Special:LonelyPages.
1610 &$tables: tables to join in the query
1611 &$conds: conditions for the query
1612 &$joinConds: join conditions for the query
1614 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1616 $refreshLinks: RefreshLinks object
1618 'MagicWordwgVariableIDs': When defining new magic words IDs.
1619 $variableIDs: array of strings
1621 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1622 executed. Ideally, this hook should only be used to add variables that depend on
1623 the current page/request; static configuration should be added through
1624 ResourceLoaderGetConfigVars instead.
1625 &$vars: variable (or multiple variables) to be added into the output of
1626 Skin::makeVariablesScript
1627 $out: The OutputPage which called the hook, can be used to get the real title.
1629 'MarkPatrolled': Before an edit is marked patrolled.
1630 $rcid: ID of the revision to be marked patrolled
1631 $user: the user (object) marking the revision as patrolled
1632 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1633 sysop in order to mark an edit patrolled.
1635 'MarkPatrolledComplete': After an edit is marked patrolled.
1636 $rcid: ID of the revision marked as patrolled
1637 $user: user (object) who marked the edit patrolled
1638 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1639 sysop to patrol the edit.
1641 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1642 something completely different, after the basic globals have been set up, but
1643 before ordinary actions take place.
1645 $article: Article on which the action will be performed
1646 $title: Title on which the action will be performed
1648 $request: $wgRequest
1649 $mediaWiki: The $mediawiki object
1651 'MessagesPreLoad': When loading a message from the database.
1652 $title: title of the message (string)
1653 $message: value (string), change it to the message you want to define
1655 'MessageCacheReplace': When a message page is changed. Useful for updating
1657 $title: name of the page changed.
1658 $text: new contents of the page.
1660 'ModifyExportQuery': Modify the query used by the exporter.
1661 $db: The database object to be queried.
1662 &$tables: Tables in the query.
1663 &$conds: Conditions in the query.
1664 &$opts: Options for the query.
1665 &$join_conds: Join conditions for the query.
1667 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1668 links have been rendered (useful for adding more). Note: this is only run for
1669 the Monobook skin. To add items to the toolbox you should use the
1670 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1672 $tools: array of tools
1674 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1675 and returning it for the skin to output. You can add items to the toolbox while
1676 still letting the skin make final decisions on skin-specific markup conventions
1678 &$sk: The BaseTemplate base skin template
1679 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1680 BaseTemplate::makeListItem for details on the format of individual items
1681 inside of this array.
1683 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1685 $index: Integer; the index of the namespace being checked.
1686 $result: Boolean; whether MediaWiki currently thinks that pages in this
1687 namespace are movable. Hooks may change this value to override the return
1688 value of MWNamespace::isMovable().
1690 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1692 $wikiPage: the WikiPage edited
1693 $rev: the new revision
1694 $baseID: the revision ID this was based off, if any
1695 $user: the editing user
1697 'NormalizeMessageKey': Called before the software gets the text of a message
1698 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1700 &$key: the message being looked up. Change this to something else to change
1701 what message gets displayed (string)
1702 &$useDB: whether or not to look up the message in the database (bool)
1703 &$langCode: the language code to get the message for (string) - or -
1704 whether to use the content language (true) or site language (false) (bool)
1705 &$transform: whether or not to expand variables and templates
1706 in the message (bool)
1708 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1709 return false to omit the line from RecentChanges and Watchlist special pages.
1710 &$changeslist: The OldChangesList instance.
1711 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1712 &$rc: The RecentChange object.
1713 &$classes: array of css classes for the <li> element
1715 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1716 can alter or append to the array of URLs for search & suggestion formats.
1717 &$urls: array of associative arrays with Url element attributes
1719 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1720 users and/or IP addresses too.
1721 $otherBlockLink: An array with links to other block logs
1722 $ip: The requested IP address or username
1724 'OutputPageBeforeHTML': A page has been processed by the parser and the
1725 resulting HTML is about to be displayed.
1726 $parserOutput: the parserOutput (object) that corresponds to the page
1727 $text: the text that will be displayed, in HTML (string)
1729 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1730 body tag to allow for extensions to add attributes to the body of the page they
1731 might need. Or to allow building extensions to add body classes that aren't of
1732 high enough demand to be included in core.
1733 $out: The OutputPage which called the hook, can be used to get the real title
1734 $sk: The Skin that called OutputPage::headElement
1735 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1737 'OutputPageCheckLastModified': when checking if the page has been modified
1738 since the last visit.
1739 &$modifiedTimes: array of timestamps.
1740 The following keys are set: page, user, epoch
1742 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1743 $out: OutputPage instance (object)
1744 $parserOutput: parserOutput instance being added in $out
1746 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1747 categories. Implementations should return false if they generate the category
1748 links, so the default link generation is skipped.
1749 $out: OutputPage instance (object)
1750 $categories: associative array, keys are category names, values are category
1751 types ("normal" or "hidden")
1752 $links: array, intended to hold the result. Must be an associative array with
1753 category types as keys and arrays of HTML links as values.
1755 'PageContentInsertComplete': After a new article is created.
1756 $wikiPage: WikiPage created
1757 $user: User creating the article
1758 $content: New content as a Content object
1759 $summary: Edit summary/comment
1760 $isMinor: Whether or not the edit was marked as minor
1761 $isWatch: (No longer used)
1762 $section: (No longer used)
1763 $flags: Flags passed to WikiPage::doEditContent()
1764 $revision: New Revision of the article
1766 'PageContentLanguage': Allows changing the language in which the content of a
1767 page is written. Defaults to the wiki content language ($wgContLang).
1768 $title: Title object
1769 &$pageLang: the page content language (either an object or a language code)
1770 $wgLang: the user language
1772 'PageContentSave': Before an article is saved.
1773 $wikiPage: the WikiPage (object) being saved
1774 $user: the user (object) saving the article
1775 $content: the new article content, as a Content object
1776 $summary: the article summary (comment)
1777 $isminor: minor flag
1778 $iswatch: watch flag
1781 'PageContentSaveComplete': After an article has been updated.
1782 $wikiPage: WikiPage modified
1783 $user: User performing the modification
1784 $content: New content, as a Content object
1785 $summary: Edit summary/comment
1786 $isMinor: Whether or not the edit was marked as minor
1787 $isWatch: (No longer used)
1788 $section: (No longer used)
1789 $flags: Flags passed to WikiPage::doEditContent()
1790 $revision: New Revision of the article
1791 $status: Status object about to be returned by doEditContent()
1792 $baseRevId: the rev ID (or false) this edit was based on
1794 'PageHistoryBeforeList': When a history page list is about to be constructed.
1795 $article: the article that the history is loading for
1796 $context: RequestContext object
1798 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1799 $row: the revision row for this line
1800 $s: the string representing this parsed line
1801 $classes: array containing the <li> element classes
1803 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1806 $queryInfo: the query parameters
1808 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1809 which depends on user options should install this hook and append its values to
1811 &$confstr: reference to a hash key string which can be modified
1812 $user: User (object) requesting the page
1814 'ParserAfterParse': Called from Parser::parse() just after the call to
1815 Parser::internalParse() returns.
1816 $parser: parser object
1817 $text: text being parsed
1818 $stripState: stripState used (object)
1820 'ParserAfterStrip': Called at end of parsing time.
1821 TODO: No more strip, deprecated ?
1822 $parser: parser object
1823 $text: text being parsed
1824 $stripState: stripState used (object)
1826 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1827 $parser: Parser object being used
1828 $text: text that will be returned
1830 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1831 $parser: Parser object
1832 $text: text to parse
1833 $stripState: StripState instance being used
1835 'ParserBeforeStrip': Called at start of parsing time.
1836 TODO: No more strip, deprecated ?
1837 $parser: parser object
1838 $text: text being parsed
1839 $stripState: stripState used (object)
1841 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1842 $parser: Parser object being used
1845 'ParserClearState': Called at the end of Parser::clearState().
1846 $parser: Parser object being cleared
1848 'ParserCloned': Called when the parser is cloned.
1849 $parser: Newly-cloned Parser object
1851 'ParserFirstCallInit': Called when the parser initialises for the first time.
1852 &$parser: Parser object being cleared
1854 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1856 $parser: Parser object
1857 $varCache: array to store the value in case of multiples calls of the
1859 $index: index (string) of the magic
1860 $ret: value of the magic word (the hook should set it)
1861 $frame: PPFrame object to use for expanding any template variables
1863 'ParserGetVariableValueTs': Use this to change the value of the time for the
1864 {{LOCAL...}} magic word.
1865 $parser: Parser object
1866 $time: actual time (timestamp)
1868 'ParserGetVariableValueVarCache': use this to change the value of the variable
1869 cache or return false to not use it.
1870 $parser: Parser object
1871 $varCache: variable cache (array)
1873 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
1874 ParserLimitReportFormat instead.
1875 Called at the end of Parser:parse() when the parser will
1876 include comments about size of the text parsed.
1877 $parser: Parser object
1878 &$limitReport: text that will be included (without comment tags)
1880 'ParserLimitReportFormat': Called for each row in the parser limit report that
1881 needs formatting. If nothing handles this hook, the default is to use "$key" to
1882 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
1884 $key: Key for the limit report item (string)
1885 &$value: Value of the limit report item
1886 &$report: String onto which to append the data
1887 $isHTML: If true, $report is an HTML table with two columns; if false, it's
1888 text intended for display in a monospaced font.
1889 $localize: If false, $report should be output in English.
1891 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
1892 include comments about size of the text parsed. Hooks should use
1893 $output->setLimitReportData() to populate data. Functions for this hook should
1894 not use $wgLang; do that in ParserLimitReportFormat instead.
1895 $parser: Parser object
1896 $output: ParserOutput object
1898 'ParserMakeImageParams': Called before the parser make an image link, use this
1899 to modify the parameters of the image.
1900 $title: title object representing the file
1901 $file: file object that will be used to create the image
1902 &$params: 2-D array of parameters
1903 $parser: Parser object that called the hook
1905 'ParserSectionCreate': Called each time the parser creates a document section
1906 from wikitext. Use this to apply per-section modifications to HTML (like
1907 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1908 can begin in one section and end in another. Make sure your code can handle
1909 that case gracefully. See the EditSectionClearerLink extension for an example.
1910 $parser: the calling Parser instance
1911 $section: the section number, zero-based, but section 0 is usually empty
1912 &$sectionContent: ref to the content of the section. modify this.
1913 $showEditLinks: boolean describing whether this section has an edit link
1915 'ParserTestParser': Called when creating a new instance of Parser in
1916 tests/parser/parserTest.inc.
1917 $parser: Parser object created
1919 'ParserTestGlobals': Allows to define globals for parser tests.
1920 &$globals: Array with all the globals which should be set for parser tests.
1921 The arrays keys serve as the globals names, its values are the globals values.
1923 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1924 run. Use when page save hooks require the presence of custom tables to ensure
1925 that tests continue to run properly.
1926 &$tables: array of table names
1928 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1929 my talk page, my contributions" etc).
1930 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1931 &$title: Title object representing the current page
1932 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
1934 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1935 &$user : User performing the action
1936 $action : Action being performed
1937 &$result : Whether or not the action should be prevented
1938 Change $result and return false to give a definitive answer, otherwise
1939 the built-in rate limiting checks are used, if enabled.
1940 $incrBy: Amount to increment counter by
1942 'PlaceNewSection': Override placement of new sections. Return false and put the
1943 merged text into $text to override the default behavior.
1944 $wikipage : WikiPage object
1945 $oldtext : the text of the article before editing
1946 $subject : subject of the new section
1947 &$text : text of the new section
1949 'PreferencesGetLegend': Override the text used for the <legend> of a
1950 preferences section.
1951 $form: the PreferencesForm object. This is a ContextSource as well
1952 $key: the section name
1953 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1955 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1956 AJAX search suggestions. Put results into &$results outparam and return false.
1957 $ns : array of int namespace keys to search in
1958 $search : search term (not guaranteed to be conveniently normalized)
1959 $limit : maximum number of results to return
1960 &$results : out param: array of page names (strings)
1962 'PrefsEmailAudit': Called when user changes their email address.
1963 $user: User (object) changing his email address
1964 $oldaddr: old email address (string)
1965 $newaddr: new email address (string)
1967 'PrefsPasswordAudit': Called when user changes his password.
1968 $user: User (object) changing his password
1969 $newPass: new password
1970 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1972 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1974 $article: the title being (un)protected
1975 $output: a string of the form HTML so far
1977 'ProtectionForm::save': Called when a protection form is submitted.
1978 $article: the Page being (un)protected
1979 &$errorMsg: an html message string of an error or an array of message name and
1981 $reasonstr: a string describing the reason page protection level is altered
1983 'ProtectionForm::showLogExtract': Called after the protection log extract is
1985 $article: the page the form is shown for
1986 $out: OutputPage object
1988 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1989 &$obj: RawPage object
1990 &$text: The text that's going to be the output
1992 'RecentChange_save': Called at the end of RecentChange::save().
1993 $recentChange: RecentChange object
1995 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1996 names such as "oldid" that are preserved when using redirecting special pages
1997 such as Special:MyPage and Special:MyTalk.
1998 &$redirectParams: An array of parameters preserved by redirecting special pages.
2000 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2001 instance. Can be used by an extension override what skin is used in certain
2003 IContextSource $context: The RequestContext the skin is being created for.
2004 &$skin: A variable reference you may set a Skin instance or string key on to
2005 override the skin that will be used for the context.
2007 'ResetSessionID': Called from wfResetSessionID
2008 $oldSessionID: old session id
2009 $newSessionID: new session id
2011 'ResourceLoaderGetConfigVars': Called at the end of
2012 ResourceLoaderStartUpModule::getConfig(). Use this to export static
2013 configuration variables to JavaScript. Things that depend on the current page
2014 or request state must be added through MakeGlobalVariablesScript instead.
2015 &$vars: array( variable name => value )
2017 'ResourceLoaderGetStartupModules': Run once the startup module is being
2018 generated. This allows you to add modules to the startup module. This hook
2019 should be used sparingly since any module added here will be loaded on all
2020 pages. This hook is useful if you want to make code available to module loader
2023 'ResourceLoaderRegisterModules': Right before modules information is required,
2024 such as when responding to a resource
2025 loader request or generating HTML output.
2026 &$resourceLoader: ResourceLoader object
2028 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2029 called after the addition of 'qunit' and MediaWiki testing resources.
2030 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2031 included in core, is fed using tests/qunit/QUnitTestResources.php.
2032 &ResourceLoader object
2034 To add a new qunit module named 'myext.tests':
2035 testModules['qunit']['myext.tests'] = array(
2036 'script' => 'extension/myext/tests.js',
2037 'dependencies' => <any module dependency you might have>
2039 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2040 added to any module.
2042 'RevisionInsertComplete': Called after a revision is inserted into the database.
2043 &$revision: the Revision
2044 $data: the data stored in old_text. The meaning depends on $flags: if external
2045 is set, it's the URL of the revision text in external storage; otherwise,
2046 it's the revision text itself. In either case, if gzip is set, the revision
2048 $flags: a comma-delimited list of strings representing the options used. May
2049 include: utf8 (this will always be set for new revisions); gzip; external.
2051 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2052 the normal operations.
2053 $allSearchTerms : Array of the search terms in all content languages
2054 &$titleResult : Outparam; the value to return. A Title object or null.
2056 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2057 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2059 $term : Search term string
2060 &$title : Outparam; set to $title object and return false for a match
2062 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2063 if nothing was found.
2064 $term : Search term string
2065 &$title : Outparam; set to $title object and return false for a match
2067 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2069 $term : Search term string
2070 &$title : Current Title object that is being returned (null if none found).
2072 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
2073 $searchEngine : The SearchEngine object. Users of this hooks will be interested
2074 in the $searchEngine->namespaces array.
2075 $query : Original query.
2076 &$parsed : Resultant query with the prefixes stripped.
2078 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2080 $title : Current Title object being displayed in search results.
2081 &$id: Revision ID (default is false, for latest)
2083 'SearchableNamespaces': An option to modify which namespaces are searchable.
2084 &$arr : Array of namespaces ($nsId => $name) which will be used.
2086 'SetupAfterCache': Called in Setup.php, after cache objects are set
2088 'ShowMissingArticle': Called when generating the output for a non-existent page.
2089 $article: The article object corresponding to the page
2091 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2092 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
2093 $text: Text being shown
2094 $title: Title of the custom script/stylesheet page
2095 $output: Current OutputPage object
2097 'ShowSearchHitTitle': Customise display of search hit title/link.
2098 &$title: Title to link to
2099 &$text: Text to use for the link
2100 $result: The search result
2101 $terms: The search terms entered
2102 $page: The SpecialSearch object.
2104 'ShowSearchHit': Customize display of search hit.
2105 $searchPage: The SpecialSearch instance.
2106 $result: The SearchResult to show
2107 $terms: Search terms, for highlighting
2108 &$link: HTML of link to the matching page. May be modified.
2109 &$redirect: HTML of redirect info. May be modified.
2110 &$section: HTML of matching section. May be modified.
2111 &$extract: HTML of content extract. May be modified.
2112 &$score: HTML of score. May be modified.
2113 &$size: HTML of page size. May be modified.
2114 &$date: HTML of of page modification date. May be modified.
2115 &$related: HTML of additional info for the matching page. May be modified.
2116 &$html: May be set to the full HTML that should be used to represent the search
2117 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2118 function returned false.
2120 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2121 allow the normal method of notice selection/rendering to work, or change the
2122 value of $siteNotice and return false to alter it.
2123 &$siteNotice: HTML returned as the sitenotice
2126 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2127 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2128 the sitenotice/anonnotice.
2131 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2133 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2134 the stock bottom scripts.
2136 'SkinAfterContent': Allows extensions to add text after the page content and
2137 article metadata. This hook should work in all skins. Set the &$data variable to
2138 the text you're going to add.
2139 &$data: (string) Text to be printed out directly (without parsing)
2142 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2144 &$bar: Sidebar contents
2145 Modify $bar to add or modify sidebar portlets.
2147 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2149 $title: displayed page title
2150 $type: 'normal' or 'history' for old/diff views
2151 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2152 message must be in HTML format, not wikitext!
2153 &$link: overridable HTML link to be passed into the message as $1
2154 &$forContent: overridable flag if copyright footer is shown in content language.
2156 'SkinGetPoweredBy': TODO
2157 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2158 the MediaWiki icon but plain text instead.
2161 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2162 &$subpages: Subpage links HTML
2164 $out: OutputPage object
2165 If false is returned $subpages will be used instead of the HTML
2166 subPageSubtitle() generates.
2167 If true is returned, $subpages will be ignored and the rest of
2168 subPageSubtitle() will run.
2170 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2172 $sktemplate: SkinTemplate object
2173 $nav_urls: array of tabs
2175 To alter the structured navigation links in SkinTemplates, there are three
2176 hooks called in different spots:
2178 'SkinTemplateNavigation': Called on content pages after the tabs have been
2179 added, but before variants have been added.
2180 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2181 tab is added but before variants have been added.
2182 'SkinTemplateNavigation::Universal': Called on both content and special pages
2183 after variants have been added.
2184 &$sktemplate: SkinTemplate object
2185 &$links: Structured navigation links. This is used to alter the navigation for
2186 skins which use buildNavigationUrls such as Vector.
2188 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2190 &$sktemplate: SkinTemplate object
2191 &$tpl: Template engine object
2193 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2194 $sktemplate: SkinTemplate object
2195 $res: set to true to prevent active tabs
2197 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2198 You can either create your own array, or alter the parameters for
2200 &$sktemplate: The SkinTemplate instance.
2201 $title: Title instance for the page.
2202 $message: Visible label of tab.
2203 $selected: Whether this is a selected tab.
2204 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2205 &$classes: Array of CSS classes to apply.
2206 &$query: Query string to add to link.
2208 &$result: Complete assoc. array if you want to return true.
2210 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2211 been rendered (useful for adding more).
2212 $sk: The QuickTemplate based skin template running the hook.
2213 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2214 extensions that add support for BaseTemplateToolbox should watch for this
2215 dummy parameter with "$dummy=false" in their code and return without echoing
2216 any HTML to avoid creating duplicate toolbox items.
2218 'SoftwareInfo': Called by Special:Version for returning information about the
2220 $software: The array of software in format 'name' => 'version'. See
2221 SpecialVersion::softwareInformation().
2223 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2224 $sp: SpecialPage object, for context
2225 &$fields: Current HTMLForm fields
2227 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2228 $id: User id number, only provided for backwards-compatability
2229 $user: User object representing user contributions are being fetched for
2230 $sp: SpecialPage instance, providing context
2232 'SpecialListusersDefaultQuery': Called right before the end of
2233 UsersPager::getDefaultQuery().
2234 $pager: The UsersPager instance
2235 $query: The query array to be returned
2237 'SpecialListusersFormatRow': Called right before the end of
2238 UsersPager::formatRow().
2239 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2240 $row: Database row object
2242 'SpecialListusersHeader': Called before closing the <fieldset> in
2243 UsersPager::getPageHeader().
2244 $pager: The UsersPager instance
2245 $out: The header HTML
2247 'SpecialListusersHeaderForm': Called before adding the submit button in
2248 UsersPager::getPageHeader().
2249 $pager: The UsersPager instance
2250 $out: The header HTML
2252 'SpecialListusersQueryInfo': Called right before the end of.
2253 UsersPager::getQueryInfo()
2254 $pager: The UsersPager instance
2255 $query: The query array to be returned
2257 'SpecialMovepageAfterMove': Called after moving a page.
2258 $movePage: MovePageForm object
2259 $oldTitle: old title (object)
2260 $newTitle: new title (object)
2262 'SpecialNewpagesConditions': Called when building sql query for
2264 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2265 $opts: FormOptions object containing special page options
2266 &$conds: array of WHERE conditionals for query
2267 &tables: array of tables to be queried
2268 &$fields: array of columns to select
2269 &$join_conds: join conditions for the tables
2271 'SpecialNewPagesFilters': Called after building form options at NewPages.
2272 $special: the special page object
2273 &$filters: associative array of filter definitions. The keys are the HTML
2274 name/URL parameters. Each key maps to an associative array with a 'msg'
2275 (message key) and a 'default' value.
2277 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2278 hook to remove a core special page.
2279 $list: list (array) of core special pages
2281 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2282 $special: the SpecialPage object
2283 $subPage: the subpage string or null if no subpage was specified
2285 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2286 $special: the SpecialPage object
2287 $subPage: the subpage string or null if no subpage was specified
2289 'SpecialPasswordResetOnSubmit': When executing a form submission on
2290 Special:PasswordReset.
2291 $users: array of User objects.
2292 $data: array of data submitted by the user
2293 &$error: string, error code (message key) used to describe to error (out
2294 parameter). The hook needs to return false when setting this, otherwise it
2295 will have no effect.
2297 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2298 use this to change some selection criteria or substitute a different title.
2299 &$randstr: The random number from wfRandom()
2300 &$isRedir: Boolean, whether to select a redirect or non-redirect
2301 &$namespaces: An array of namespace indexes to get the title from
2302 &$extra: An array of extra SQL statements
2303 &$title: If the hook returns false, a Title object to use instead of the
2304 result from the normal query
2306 'SpecialRecentChangesFilters': Called after building form options at
2308 $special: the special page object
2309 &$filters: associative array of filter definitions. The keys are the HTML
2310 name/URL parameters. Each key maps to an associative array with a 'msg'
2311 (message key) and a 'default' value.
2313 'SpecialRecentChangesPanel': Called when building form options in
2314 SpecialRecentChanges.
2315 &$extraOpts: array of added items, to which can be added
2316 $opts: FormOptions for this request
2318 'SpecialRecentChangesQuery': Called when building SQL query for
2319 SpecialRecentChanges and SpecialRecentChangesLinked.
2320 &$conds: array of WHERE conditionals for query
2321 &$tables: array of tables to be queried
2322 &$join_conds: join conditions for the tables
2323 $opts: FormOptions for this request
2324 &$query_options: array of options for the database request
2325 &$select: Array of columns to select
2327 'SpecialResetTokensTokens': Called when building token list for
2329 &$tokens: array of token information arrays in the format of
2330 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2332 'SpecialSearchCreateLink': Called when making the message to create a page or
2333 go to the existing page.
2334 $t: title object searched for
2335 &$params: an array of the default message name and page title (as parameter)
2337 'SpecialSearchGo': Called when user clicked the "Go".
2338 &$title: title object generated from the text entered by the user
2339 &$term: the search term entered by the user
2341 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2342 target doesn't exist.
2343 &$title: title object generated from the text entered by the user
2345 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2346 the advanced form, a.k.a. power search box.
2347 &$showSections: an array to add values with more options to
2348 $term: the search term (not a title object)
2349 $opts: an array of hidden options (containing 'redirs' and 'profile')
2351 'SpecialSearchProfiles': Allows modification of search profiles.
2352 &$profiles: profiles, which can be modified.
2354 'SpecialSearchProfileForm': Allows modification of search profile forms.
2355 $search: special page object
2356 &$form: String: form html
2357 $profile: String: current search profile
2358 $term: String: search term
2359 $opts: Array: key => value of hidden options for inclusion in custom forms
2361 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2362 $search: SpecialSearch special page object
2363 $profile: String: current search profile
2364 $engine: the search engine
2366 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2367 on the search results page. Useful for including an external search
2368 provider. To disable the output of MediaWiki search output, return
2370 $specialSearch: SpecialSearch object ($this)
2372 $term: Search term specified by the user
2374 'SpecialSearchResultsAppend': Called after all search results HTML has
2375 been output. Note that in some cases, this hook will not be called (no
2376 results, too many results, SpecialSearchResultsPrepend returned false,
2378 $specialSearch: SpecialSearch object ($this)
2380 $term: Search term specified by the user
2382 'SpecialSearchResults': Called before search result display when there are
2384 $term: string of search term
2385 &$titleMatches: empty or SearchResultSet object
2386 &$textMatches: empty or SearchResultSet object
2388 'SpecialSearchNoResults': Called before search result display when there are no
2390 $term: string of search term
2392 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2393 &$extraStats: Array to save the new stats
2394 ( $extraStats['<name of statistic>'] => <value>; )
2396 'SpecialUploadComplete': Called after successfully uploading a file from
2398 $form: The SpecialUpload object
2400 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2401 use this to change the tables headers.
2402 $extTypes: associative array of extensions types
2404 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2405 $wgVersion: Current $wgVersion for you to use
2406 &$versionUrl: Raw url to link to (eg: release notes)
2408 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2409 $special: the special page object
2410 &$filters: associative array of filter definitions. The keys are the HTML
2411 name/URL parameters. Each key maps to an associative array with a 'msg'
2412 (message key) and a 'default' value.
2414 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2415 &$conds: array of WHERE conditionals for query
2416 &$tables: array of tables to be queried
2417 &$join_conds: join conditions for the tables
2418 &$fields: array of query fields
2419 $opts: A FormOptions object with watchlist options for the current request
2421 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2422 SpecialWatchlist. Allows extensions to register custom values they have
2423 inserted to rc_type so they can be returned as part of the watchlist.
2424 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2426 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2427 URL for a title when we have no other parameters on the URL. Gives a chance for
2428 extensions that alter page view behavior radically to abort that redirect or
2430 $request: WebRequest
2431 $title: Title of the currently found title obj
2432 $output: OutputPage object
2434 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2435 rendered (by ThumbnailImage:toHtml method).
2436 $thumbnail: the ThumbnailImage object
2437 &$attribs: image attribute array
2438 &$linkAttribs: image link attribute array
2440 'TitleArrayFromResult': Called when creating an TitleArray object from a
2442 &$titleArray: set this to an object to override the default object returned
2443 $res: database result used to create the object
2445 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2446 or override the quick permissions check.
2447 $title: The Title object being accessed
2448 $user: The User performing the action
2449 $action: Action being performed
2450 &$errors: Array of errors
2451 $doExpensiveQueries: Whether to do expensive DB queries
2452 $short: Whether to return immediately on first error
2454 'TitleGetEditNotices': Allows extensions to add edit notices
2455 $title: The Title object for the page the edit notices are for
2456 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2457 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2459 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2460 that can be applied.
2461 $title: The title in question.
2462 &$types: The types of protection available.
2464 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2465 $title: Title object that is being checked
2466 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2467 Hooks may change this value to override the return value of
2468 Title::isCssOrJsPage().
2470 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2471 overriding default behavior for determining if a page exists. If $isKnown is
2472 kept as null, regular checks happen. If it's a boolean, this value is returned
2473 by the isKnown method.
2474 $title: Title object that is being checked
2475 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2477 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2478 that this hook is not called for interwiki pages or pages in immovable
2479 namespaces: for these, isMovable() always returns false.
2480 $title: Title object that is being checked
2481 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2482 Hooks may change this value to override the return value of
2485 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2486 be handled by separate handler (via ArticleViewCustom).
2487 $title: Title object that is being checked
2488 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2489 Hooks may change this value to override the return value of
2490 Title::isWikitextPage()
2492 'TitleMove': Before moving an article (title).
2495 $user: user who does the move
2497 'TitleMoveComplete': After moving an article (title).
2500 $user: user who did the move
2501 $pageid: database ID of the page that's been moved
2502 $redirid: database ID of the created redirect
2504 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2505 adding the default error message if nothing allows the user to read the page. If
2506 a handler wants a title to *not* be whitelisted, it should also return false.
2507 $title: Title object being checked against
2508 $user: Current user object
2509 &$whitelisted: Boolean value of whether this title is whitelisted
2511 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2512 $this: Title object to purge
2513 &$urls: An array of URLs to purge from the caches, to be manipulated.
2515 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2516 PageArchive object has been created but before any further processing is done.
2517 &$archive: PageArchive object
2518 $title: Title object of the page that we're viewing
2520 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2521 PageArchive object has been created but before any further processing is done.
2522 &$archive: PageArchive object
2523 $title: Title object of the page that we're viewing
2525 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2526 the site is not in read-only mode, that the Title object is not null and after
2527 a PageArchive object has been constructed but before performing any further
2529 &$archive: PageArchive object
2530 $title: Title object of the page that we're about to undelete
2532 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2533 $title: title object related to the revision
2534 $rev: revision (object) that will be viewed
2536 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2538 $action: action name
2539 $article: article "acted on"
2541 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2542 &$files: list of files
2544 'UnwatchArticle': Before a watch is removed from an article.
2545 $user: user watching
2546 $page: WikiPage object to be removed
2547 &$status: Status object to be returned if the hook returns false
2549 'UnwatchArticleComplete': After a watch is removed from an article.
2550 $user: user that watched
2551 $page: WikiPage object that was watched
2553 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2554 $formattedPageStatus: list of valid page states
2556 'UploadForm:initial': Before the upload form is generated. You might set the
2557 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2558 text (HTML) either before or after the editform.
2559 $form: UploadForm object
2561 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2562 poke at member variables like $mUploadDescription before the file is saved. Do
2563 not use this hook to break upload processing. This will return the user to a
2564 blank form with no error message; use UploadVerification and UploadVerifyFile
2566 $form: UploadForm object
2568 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2569 $type: (string) the requested upload type
2570 &$className: the class name of the Upload instance to be created
2572 'UploadComplete': when Upload completes an upload.
2573 &$upload: an UploadBase child instance
2575 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2577 $descriptor: (array) the HTMLForm descriptor
2579 'UploadFormSourceDescriptors': after the standard source inputs have been
2580 added to the descriptor
2581 $descriptor: (array) the HTMLForm descriptor
2583 'UploadVerification': Additional chances to reject an uploaded file. Consider
2584 using UploadVerifyFile instead.
2585 string $saveName: destination file name
2586 string $tempName: filesystem path to the temporary file for checks
2587 string &$error: output: message key for message to show if upload canceled by
2588 returning false. May also be an array, where the first element is the message
2589 key and the remaining elements are used as parameters to the message.
2591 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2592 in most cases over UploadVerification.
2593 object $upload: an instance of UploadBase, with all info about the upload
2594 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2595 will typically only apply for specific mime types.
2596 object &$error: output: true if the file is valid. Otherwise, an indexed array
2597 representing the problem with the file, where the first element is the message
2598 key and the remaining elements are used as parameters to the message.
2600 'UploadComplete': Upon completion of a file upload.
2601 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2602 $uploadBase->getLocalFile().
2604 'User::mailPasswordInternal': before creation and mailing of a user's new
2606 $user: the user who sent the message out
2607 $ip: IP of the user who sent the message out
2608 $u: the account whose new password will be set
2610 'UserAddGroup': Called when adding a group; return false to override
2611 stock group addition.
2612 $user: the user object that is to have a group added
2613 &$group: the group to add, can be modified
2615 'UserArrayFromResult': Called when creating an UserArray object from a database
2617 &$userArray: set this to an object to override the default object returned
2618 $res: database result used to create the object
2620 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2621 want to display an error message, try getUserPermissionsErrors.
2622 $title: Title object being checked against
2623 $user : Current user object
2624 $action: Action being checked
2625 $result: Pointer to result returned if hook returns false. If null is returned,
2626 userCan checks are continued by internal code.
2628 'UserCanSendEmail': To override User::canSendEmail() permission check.
2629 $user: User (object) whose permission is being checked
2630 &$canSend: bool set on input, can override on output
2632 'UserClearNewTalkNotification': Called when clearing the "You have new
2633 messages!" message, return false to not delete it.
2634 $user: User (object) that will clear the message
2635 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2637 'UserComparePasswords': Called when checking passwords, return false to
2638 override the default password checks.
2639 &$hash: String of the password hash (from the database)
2640 &$password: String of the plaintext password the user entered
2641 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2643 &$result: If the hook returns false, this Boolean value will be checked to
2644 determine if the password was valid
2646 'UserCreateForm': change to manipulate the login form
2647 $template: SimpleTemplate instance for the form
2649 'UserCryptPassword': Called when hashing a password, return false to implement
2650 your own hashing method.
2651 &$password: String of the plaintext password to encrypt
2652 &$salt: String of the password salt or Boolean false if no salt is provided
2653 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2655 &$hash: If the hook returns false, this String will be used as the hash
2657 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2658 $user: User to get groups for
2659 &$groups: Current effective groups
2661 'UserGetAllRights': After calculating a list of all available rights.
2662 &$rights: Array of rights, which may be added to.
2664 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2665 before returning the options to the caller. Warning: This hook is called for
2666 every call to User::getDefaultOptions(), which means it's potentially called
2667 dozens or hundreds of times. You may want to cache the results of non-trivial
2668 operations in your hook function for this reason.
2669 &$defaultOptions: Array of preference keys and their default values.
2671 'UserGetEmail': Called when getting an user email address.
2673 &$email: email, change this to override local email
2675 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2676 email authentication.
2678 &$timestamp: timestamp, change this to override local email authentication
2681 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2682 &$groups: List of implicit (automatically-assigned) groups
2684 'UserGetLanguageObject': Called when getting user's interface language object.
2686 &$code: Language code that will be used to create the object
2687 $context: RequestContext object
2689 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2690 &$reservedUsernames: $wgReservedUsernames
2692 'UserGetRights': Called in User::getRights().
2693 $user: User to get rights for
2694 &$rights: Current rights
2696 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2697 specific block exemptions).
2698 $user: User in question
2699 $title: Title of the page in question
2700 &$blocked: Out-param, whether or not the user is blocked from that page.
2701 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2702 to edit their own user talk pages.
2704 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2706 $ip: User's IP address
2707 &$blocked: Whether the user is blocked, to be modified by the hook
2709 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2710 false if a UserGetRights hook might remove the named right.
2711 $right: The user right being checked
2713 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2714 environmental means; occurs after session is loaded.
2715 $user: user object being loaded
2717 'UserLoadDefaults': Called when loading a default user.
2721 'UserLoadFromDatabase': Called when loading a user from the database.
2723 &$s: database query object
2725 'UserLoadFromSession': Called to authenticate users on external/environmental
2726 means; occurs before session is loaded.
2727 $user: user object being loaded
2728 &$result: set this to a boolean value to abort the normal authentication
2731 'UserLoadOptions': When user options/preferences are being loaded from the
2734 &$options: Options, can be modified.
2736 'UserLoginComplete': After a user has logged in.
2737 $user: the user object that was created on login
2738 $inject_html: Any HTML to inject after the "logged in" message.
2740 'UserLoginForm': change to manipulate the login form
2741 $template: SimpleTemplate instance for the form
2743 'UserLogout': Before a user logs out.
2744 $user: the user object that is about to be logged out
2746 'UserLogoutComplete': After a user has logged out.
2747 $user: the user object _after_ logout (won't have name, ID, etc.)
2748 $inject_html: Any HTML to inject after the "logged out" message.
2749 $oldName: name of the user before logout (string)
2751 'UserRemoveGroup': Called when removing a group; return false to override stock
2753 $user: the user object that is to have a group removed
2754 &$group: the group to be removed, can be modified
2756 'UserRights': After a user's group memberships are changed.
2757 $user : User object that was changed
2758 $add : Array of strings corresponding to groups added
2759 $remove: Array of strings corresponding to groups removed
2761 'UserRequiresHTTPS': Called to determine whether a user needs
2762 to be switched to HTTPS.
2763 $user: User in question.
2764 &$https: Boolean whether $user should be switched to HTTPS.
2767 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2769 $user: user retrieving new talks messages
2770 $talks: array of new talks page(s)
2772 'UserSaveSettings': Called when saving user settings.
2775 'UserSaveOptions': Called just before saving user preferences/options.
2777 &$options: Options, modifiable
2779 'UserSetCookies': Called when setting user cookies.
2781 &$session: session array, will be added to $_SESSION
2782 &$cookies: cookies array mapping cookie name to its value
2784 'UserSetEmail': Called when changing user email address.
2786 &$email: new email, change this to override new email address
2788 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2789 email authentication.
2791 &$timestamp: new timestamp, change this to override local email
2792 authentication timestamp
2794 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2795 "Foobar (Talk | Contribs | Block)".
2796 $userId: User id of the current user
2797 $userText: User name of the current user
2798 &$items: Array of user tool links as HTML fragments
2800 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2801 FormatMetadata::getExtendedMeta (return false means cache will be
2802 invalidated and GetExtendedMetadata hook called again).
2803 $timestamp: The timestamp metadata was generated
2804 $file: The file the metadata is for
2806 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2807 used to alter the SQL query which gets the list of wanted pages.
2808 &$wantedPages: WantedPagesPage object
2809 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2811 'WatchArticle': Before a watch is added to an article.
2812 $user: user that will watch
2813 $page: WikiPage object to be watched
2814 &$status: Status object to be returned if the hook returns false
2816 'WatchArticleComplete': After a watch is added to an article.
2817 $user: user that watched
2818 $page: WikiPage object watched
2820 'WatchlistEditorBuildRemoveLine': when building remove lines in
2821 Special:Watchlist/edit.
2822 &$tools: array of extra links
2823 $title: Title object
2824 $redirect: whether the page is a redirect
2827 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2829 $router: The PathRouter instance
2831 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
2832 Return false to prevent setting of the cookie.
2833 &$name: Cookie name passed to WebResponse::setcookie()
2834 &$value: Cookie value passed to WebResponse::setcookie()
2835 &$expire: Cookie expiration, as for PHP's setcookie()
2836 $options: Options passed to WebResponse::setcookie()
2838 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2839 dumps. One, and only one hook should set this, and return false.
2840 &$tables: Database tables to use in the SELECT query
2841 &$opts: Options to use for the query
2842 &$join: Join conditions
2844 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2845 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2846 specific to a content model should be provided by the respective Content's
2847 getDeletionUpdates() method.
2849 $content: the Content to generate updates for
2850 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2852 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2853 run a MediaWiki cli script.
2854 &$script: MediaWiki cli script path
2855 &$parameters: Array of arguments and options to the script
2856 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2859 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2860 query pages to be updated with maintenance/updateSpecialPages.php.
2861 $query: $wgQueryPages itself
2863 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2864 extra metadata to be added.
2865 $obj: The XmlDumpWriter object.
2866 &$out: The output string.
2867 $row: The database row for the page.
2868 $title: The title of the page.
2870 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2872 $obj: The XmlDumpWriter object.
2873 &$out: The text being output.
2874 $row: The database row for the revision.
2875 $text: The revision text.
2877 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2878 to add additional tags to extract.
2879 &$items: Array containing information on which items to extract. See XMPInfo for
2880 details on the format.
2882 'XMPGetResults': Called just before returning the results array of parsing xmp
2883 data. Can be used to post-process the results.
2884 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2885 is an array of metadata tags returned (each tag is either a value, or an array
2888 More hooks might be available but undocumented, you can execute
2889 "php maintenance/findHooks.php" to find hidden ones.