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', 'PageContentSave',
14 'PageContentSaveComplete', 'ArticleDelete'.
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 ) {
77 if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
78 # code to actually show the article goes here
80 Hooks::run( 'ArticleShowComplete', array( &$article ) );
84 We've cleaned up the code here by removing clumps of weird, infrequently used
85 code and moving them off somewhere else. It's much easier for someone working
86 with this code to see what's _really_ going on, and make changes or fix bugs.
88 In addition, we can take all the code that deals with the little-used
89 title-reversing options (say) and put it in one place. Instead of having little
90 title-reversing if-blocks spread all over the codebase in showAnArticle,
91 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
94 function reverseArticleTitle( $article ) {
98 function reverseForExport( $article ) {
102 The setup function for the extension just has to add its hook functions to the
105 setupTitleReversingExtension() {
108 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
109 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
110 $wgHooks['ArticleExport'][] = 'reverseForExport';
113 Having all this code related to the title-reversion option in one place means
114 that it's easier to read and understand; you don't have to do a grep-find to see
115 where the $wgReverseTitle variable is used, say.
117 If the code is well enough isolated, it can even be excluded when not used --
118 making for some slight savings in memory and load-up performance at runtime.
119 Admins who want to have all the reversed titles can add:
121 require_once 'extensions/ReverseTitle.php';
123 ...to their LocalSettings.php file; those of us who don't want or need it can
126 The extensions don't even have to be shipped with MediaWiki; they could be
127 provided by a third-party developer or written by the admin him/herself.
131 A hook is a chunk of code run at some particular event. It consists of:
133 * a function with some optional accompanying data, or
134 * an object with a method and some optional accompanying data.
136 Hooks are registered by adding them to the global $wgHooks array for a given
137 event. All the following are valid ways to define hooks:
139 $wgHooks['EventName'][] = 'someFunction'; # function, no data
140 $wgHooks['EventName'][] = array( 'someFunction', $someData );
141 $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
143 $wgHooks['EventName'][] = $object; # object only
144 $wgHooks['EventName'][] = array( $object, 'someMethod' );
145 $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
146 $wgHooks['EventName'][] = array( $object ); # weird but OK
148 When an event occurs, the function (or object method) will be called with the
149 optional data provided as well as event-specific parameters. The above examples
150 would result in the following code being executed when 'EventName' happened:
153 someFunction( $param1, $param2 )
155 someFunction( $someData, $param1, $param2 )
158 $object->onEventName( $param1, $param2 )
160 $object->someMethod( $param1, $param2 )
161 # object with method and data
162 $object->someMethod( $someData, $param1, $param2 )
164 Note that when an object is the hook, and there's no specified method, the
165 default method called is 'onEventName'. For different events this would be
166 different: 'onArticleSave', 'onUserLogin', etc.
168 The extra data is useful if we want to use the same function or object for
169 different purposes. For example:
171 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
172 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'brion' );
174 This code would result in ircNotify being run twice when an article is saved:
175 once for 'TimStarling', and once for 'brion'.
177 Hooks can return three possible values:
179 * No return value (or null): the hook has operated successfully. Previously,
180 true was required. This is the default since MediaWiki 1.23.
181 * "some string": an error occurred; processing should stop and the error
182 should be shown to the user
183 * false: the hook has successfully done the work necessary and the calling
186 The last result would be for cases where the hook function replaces the main
187 functionality. For example, if you wanted to authenticate users to a custom
188 system (LDAP, another PHP program, whatever), you could do:
190 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
192 function ldapLogin( $username, $password ) {
197 Returning false makes less sense for events where the action is complete, and
198 will normally be ignored.
200 Note that none of the examples made use of create_function() as a way to
201 attach a function to a hook. This is known to cause problems (notably with
202 Special:Version), and should be avoided when at all possible.
206 A calling function or method uses the Hooks::run() function to run the hooks
207 related to a particular event, like so:
214 // Avoid PHP 7.1 warning from passing $this by reference
217 if ( Hooks::run( 'ArticleProtect', [ &$article, &$wgUser ] ) ) {
218 # protect the article
219 Hooks::run( 'ArticleProtectComplete', [ &$article, &$wgUser ] );
224 Hooks::run() returns true if the calling function should continue processing
225 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
226 error occurred, or one of the hooks handled the action already). Checking the
227 return value matters more for "before" hooks than for "complete" hooks.
229 Hooks::run() was added in MediaWiki 1.18, before that the global function
230 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
232 Note that hook parameters are passed in an array; this is a necessary
233 inconvenience to make it possible to pass reference values (that can be changed)
234 into the hook code. Also note that earlier versions of wfRunHooks took a
235 variable number of arguments; the array() calling protocol came about after
238 ==Events and parameters==
240 This is a list of known events and parameters; please add to it if you're going
241 to add events to the MediaWiki code.
243 'AbortAutoAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
244 Return false to cancel automated local account creation, where normally
245 authentication against an external auth plugin would be creating a local
247 $user: the User object about to be created (read-only, incomplete)
248 &$abortMsg: out parameter: name of error message to be displayed to user
250 'AbortAutoblock': Return false to cancel an autoblock.
251 $autoblockip: The IP going to be autoblocked.
252 &$block: The block from which the autoblock is coming.
254 'AbortDiffCache': Can be used to cancel the caching of a diff.
255 &$diffEngine: DifferenceEngine object
257 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
258 $editor: The User who made the change.
259 $title: The Title of the page that was edited.
260 $rc: The current RecentChange object.
262 'AbortLogin': DEPRECATED! Create a PreAuthenticationProvider instead.
263 Return false to cancel account login.
264 $user: the User object being authenticated against
265 $password: the password being submitted, not yet checked for validity
266 &$retval: a LoginForm class constant to return from authenticateUserData();
267 default is LoginForm::ABORTED. Note that the client may be using a machine
268 API rather than the HTML user interface.
269 &$msg: the message identifier for abort reason (new in 1.18, not available
272 'AbortNewAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
273 Return false to cancel explicit account creation.
274 $user: the User object about to be created (read-only, incomplete)
275 &$msg: out parameter: HTML to display on abort
276 &$status: out parameter: Status object to return, replaces the older $msg param
278 Create the object with Status::newFatal() to ensure proper API error
279 messages are returned when creating account through API clients.
281 'AbortTalkPageEmailNotification': Return false to cancel talk page email
283 $targetUser: the user whom to send talk page email notification
284 $title: the page title
286 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
287 $name: name of the action
288 &$form: HTMLForm object
289 $article: Article object
291 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
292 Allows to change the fields on the form that will be generated.
293 $name: name of the action
294 &$fields: HTMLForm descriptor array
295 $article: Article object
297 'AddNewAccount': DEPRECATED! Use LocalUserCreated.
298 After a user account is created.
299 $user: the User object that was created. (Parameter added in 1.7)
300 $byEmail: true when account was created "by email" (added in 1.12)
302 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
303 are created. Can be used to omit specific feeds from being outputted. You must not use
304 this hook to add feeds, use OutputPage::addFeedLink() instead.
305 &$feedLinks: Array of created feed links
307 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
308 before OutputPage::sendCacheControl() and final ob_end_flush() which
309 will send the buffered output to the client. This allows for last-minute
310 modification of the output within the buffer by using ob_get_clean().
311 $output: The OutputPage object where output() was called
313 'AfterImportPage': When a page import is completed.
314 $title: Title under which the revisions were imported
315 $foreignTitle: ForeignTitle object based on data 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 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
321 just before adding its HTML to parser output.
322 $parser: Parser object that called the hook
323 $ig: Gallery, an object of one of the gallery classes (inheriting from
325 &$html: HTML generated by the gallery
327 'AlternateEdit': Before checking if a user can edit a page and before showing
328 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
329 $editPage: the EditPage object
331 'AlternateEditPreview': Before generating the preview of the page when editing
332 ( EditPage::getPreviewText() ).
333 Return false and set $previewHTML and $parserOutput to output custom page
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
340 'AlternateUserMailer': Called before mail is sent so that mail could be logged
341 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
342 the regular method of sending mail. Return a string to return a php-mail-error
343 message containing the error. Returning true will continue with sending email
345 $headers: Associative array of headers for the email
346 $to: MailAddress object or array
348 $subject: Subject of the email
349 $body: Body of the message
351 'APIAfterExecute': After calling the execute() method of an API module. Use
352 this to extend core API modules.
353 &$module: Module object
355 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
356 &$main: ApiMain object
358 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
359 authenticate and authorize API clients before executing the module. Return
360 false and set a message to cancel the request.
361 $module: Module object
363 &$message: API message to die with. Specific values accepted depend on the
365 * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
366 pass to ApiBase::dieWithError().
367 * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
368 * Earlier: A key or key+parameters in ApiBase::$messageMap.
370 'ApiDeprecationHelp': Add messages to the 'deprecation-help' warning generated
371 from ApiBase::addDeprecation().
372 &$msgs: Message[] Messages to include in the help. Multiple messages will be
375 'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
376 Before saving a page with api.php?action=edit, after
377 processing request parameters. Return false to let the request fail, returning
378 an error message or an <edit result="Failure"> tag if $resultArr was filled.
379 Unlike for example 'EditFilterMergedContent' this also being run on undo.
380 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
381 for the API and it's recommended to use it instead of this hook.
382 $editPage: the EditPage object
383 $text: the text passed to the API. Note that this includes only the single
384 section for section edit, and is not necessarily the final text in case of
385 automatically resolved edit conflicts.
386 &$resultArr: data in this array will be added to the API result
388 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
389 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
390 this hook may cancel the hook to signal that the item is not viewable in the
392 $row: A row of data from ContribsPager. The set of data returned by
393 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
395 $context: An IContextSource implementation.
396 &$feedItem: Set this to a FeedItem instance if the callback can handle the
397 provided row. This is provided to the hook as a null, if it is non null then
398 another callback has already handled the hook.
400 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
401 highlighting, add output to $context->getOutput() and return false.
402 $context: An IContextSource.
403 $text: Text to be highlighted.
404 $mime: MIME type of $text.
405 $format: API format code for $text.
407 'APIGetAllowedParams': Use this hook to modify a module's parameters.
408 &$module: ApiBase Module object
409 &$params: Array of parameters
410 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
412 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
413 Use this hook to modify a module's description.
414 &$module: ApiBase Module object
415 &$desc: String description, or array of description strings
417 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
418 $module: ApiBase Module object
419 &$msg: Array of Message objects
421 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
423 Use this hook to modify a module's parameter descriptions.
424 &$module: ApiBase Module object
425 &$desc: Array of parameter descriptions
427 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
429 $module: ApiBase Module object
430 &$msg: Array of arrays of Message objects
432 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
433 $module: ApiBase Module object
434 &$help: Array of HTML strings to be joined for the output.
435 $options: Array Options passed to ApiHelp::getHelp
436 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
437 the page and values as for Linker::generateTOC().
439 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
440 module manager. Can be used to conditionally register API modules.
441 $moduleManager: ApiModuleManager Module manager instance
443 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
444 an exception is thrown during API action execution.
445 $apiMain: Calling ApiMain instance.
446 $e: Exception object.
448 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
449 extensions to adjust the ParserOptions before parsing.
450 $options: ParserOptions object
451 $title: Title to be parsed
452 $params: Parameter array for the API module
453 $module: API module (which is also a ContextSource)
454 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
455 &$suppressCache: Set true if cache should be suppressed.
457 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
458 can alter or append to the array.
459 &$results: array with integer keys to associative arrays. Keys in associative
461 - title: Title object.
462 - redirect from: Title or null.
463 - extract: Description for this result.
464 - extract trimmed: If truthy, the extract will not be trimmed to
465 $wgOpenSearchDescriptionLength.
466 - image: Thumbnail for this result. Value is an array with subkeys 'source'
467 (url), 'width', 'height', 'alt', 'align'.
468 - url: Url for the given title.
470 'ApiParseMakeOutputPage': Called when preparing the OutputPage object for
471 ApiParse. This is mainly intended for calling OutputPage::addContentOverride()
472 or OutputPage::addContentOverrideCallback().
473 $module: ApiBase (which is also a ContextSource)
476 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
477 module manager. Can be used to conditionally register API query modules.
478 $moduleManager: ApiModuleManager Module manager instance
480 'APIQueryAfterExecute': After calling the execute() method of an
481 action=query submodule. Use this to extend core API modules.
482 &$module: Module object
484 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
485 database query has returned. An API query module wanting to use this hook
486 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
488 $module: ApiQueryBase module in question
489 $result: ResultWrapper|bool returned from the IDatabase::select()
490 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
491 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
494 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
495 database query is made. WARNING: It would be very easy to misuse this hook and
496 break the module! Any joins added *must* join on a unique key of the target
497 table unless you really know what you're doing. An API query module wanting to
498 use this hook should see the ApiQueryBase::select() and
499 ApiQueryBase::processRow() documentation.
500 $module: ApiQueryBase module in question
501 &$tables: array of tables to be queried
502 &$fields: array of columns to select
503 &$conds: array of WHERE conditionals for query
504 &$query_options: array of options for the database request
505 &$join_conds: join conditions for the tables
506 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
507 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
509 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
510 the database result is processed. Return false to stop processing the result
511 set. An API query module wanting to use this hook should see the
512 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
513 $module: ApiQueryBase module in question
514 $row: stdClass Database result row
515 &$data: array to be included in the ApiResult.
516 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
517 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
519 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
520 an action=query submodule. Use this to extend core API modules.
521 &$module: Module object
522 &$resultPageSet: ApiPageSet object
524 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
525 Use this hook to add custom tokens to prop=info. Every token has an action,
526 which will be used in the intoken parameter and in the output
527 (actiontoken="..."), and a callback function which should return the token, or
528 false if the user isn't allowed to obtain it. The prototype of the callback
529 function is func($pageid, $title), where $pageid is the page ID of the page the
530 token is requested for and $title is the associated Title object. In the hook,
531 just add your callback to the $tokenFunctions array and return true (returning
532 false makes no sense).
533 &$tokenFunctions: array(action => callback)
535 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
537 Use this hook to add custom tokens to list=recentchanges. Every token has an
538 action, which will be used in the rctoken parameter and in the output
539 (actiontoken="..."), and a callback function which should return the token, or
540 false if the user isn't allowed to obtain it. The prototype of the callback
541 function is func($pageid, $title, $rc), where $pageid is the page ID of the
542 page associated to the revision the token is requested for, $title the
543 associated Title object and $rc the associated RecentChange object. In the
544 hook, just add your callback to the $tokenFunctions array and return true
545 (returning false makes no sense).
546 &$tokenFunctions: array(action => callback)
548 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
549 Use this hook to add custom tokens to prop=revisions. Every token has an
550 action, which will be used in the rvtoken parameter and in the output
551 (actiontoken="..."), and a callback function which should return the token, or
552 false if the user isn't allowed to obtain it. The prototype of the callback
553 function is func($pageid, $title, $rev), where $pageid is the page ID of the
554 page associated to the revision the token is requested for, $title the
555 associated Title object and $rev the associated Revision object. In the hook,
556 just add your callback to the $tokenFunctions array and return true (returning
557 false makes no sense).
558 &$tokenFunctions: array(action => callback)
560 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
561 sites general information.
562 $module: the current ApiQuerySiteInfo module
563 &$results: array of results, add things here
565 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
566 sites statistics information.
567 &$results: array of results, add things here
569 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
570 action=query&meta=tokens. Note that most modules will probably be able to use
571 the 'csrf' token instead of creating their own token types.
572 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
573 and key to pass to Session::getToken() )
575 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
576 Use this hook to add custom token to list=users. Every token has an action,
577 which will be used in the ustoken parameter and in the output
578 (actiontoken="..."), and a callback function which should return the token, or
579 false if the user isn't allowed to obtain it. The prototype of the callback
580 function is func($user) where $user is the User object. In the hook, just add
581 your callback to the $tokenFunctions array and return true (returning false
583 &$tokenFunctions: array(action => callback)
585 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
586 $module: ApiQueryWatchlist instance
587 $watchedItem: WatchedItem instance
588 $recentChangeInfo: Array of recent change info data
589 &$vals: Associative array of data to be output for the row
591 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
592 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
593 $module: ApiQueryWatchlist instance
594 $params: Array of parameters, as would be returned by $module->extractRequestParams()
595 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
597 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
598 should have its own entry in the $apis array and have a unique name, passed as
599 key for the array that represents the service data. In this data array, the
600 key-value-pair identified by the apiLink key is required.
601 &$apis: array of services
603 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
604 Use this hook to extend action=tokens with new token types.
605 &$tokenTypes: supported token types in format 'type' => callback function
606 used to retrieve this type of tokens.
608 'ApiValidatePassword': Called from ApiValidatePassword.
609 $module: ApiValidatePassword instance.
612 'Article::MissingArticleConditions': Before fetching deletion & move log entries
613 to display a message of a non-existing page being deleted/moved, give extensions
614 a chance to hide their (unrelated) log entries.
615 &$conds: Array of query conditions (all of which have to be met; conditions will
616 AND in the final query)
617 $logTypes: Array of log types being queried
619 'ArticleAfterFetchContentObject': After fetching content of an article from the
621 &$article: the article (object) being loaded from the database
622 &$content: the content of the article, as a Content object
624 'ArticleConfirmDelete': Before writing the confirmation form for article
626 $article: the article (object) being deleted
627 $output: the OutputPage object
628 &$reason: the reason (string) the article is being deleted
630 'ArticleContentOnDiff': Before showing the article content below a diff. Use
631 this to change the content in this area or how it is loaded.
632 $diffEngine: the DifferenceEngine
633 $output: the OutputPage object
635 'ArticleContentViewCustom': Allows to output the text of the article in a
636 different format than wikitext. Note that it is preferable to implement proper
637 handing for a custom data type using the ContentHandler facility.
638 $content: content of the page, as a Content object
639 $title: title of the page
640 $output: reference to $wgOut
642 'ArticleDelete': Before an article is deleted.
643 &$wikiPage: the WikiPage (object) being deleted
644 &$user: the user (object) deleting the article
645 &$reason: the reason (string) the article is being deleted
646 &$error: if the deletion was prohibited, the (raw HTML) error message to display
648 &$status: Status object, modify this to throw an error. Overridden by $error
650 $suppress: Whether this is a suppression deletion or not (added in 1.27)
652 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
653 $title: Title of the article that has been deleted.
654 $outputPage: OutputPage that can be used to append the output.
656 'ArticleDeleteComplete': After an article is deleted.
657 &$wikiPage: the WikiPage that was deleted
658 &$user: the user that deleted the article
659 $reason: the reason the article was deleted
660 $id: id of the article that was deleted
661 $content: the Content of the deleted page (or null, when deleting a broken page)
662 $logEntry: the ManualLogEntry used to record the deletion
663 $archivedRevisionCount: the number of revisions archived during the deletion
665 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
667 &$wikiPage: WikiPage (object) of the user talk page
668 $recipient: User (object) who's talk page was edited
670 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
671 article has been changed.
672 &$wikiPage: the WikiPage (object)
673 &$editInfo: data holder that includes the parser output ($editInfo->output) for
674 that page after the change
675 $changed: bool for if the page was changed
677 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
678 recentchanges table, return false to not delete old entries.
679 &$wikiPage: WikiPage (object) being modified
681 'ArticleFromTitle': when creating an article object from a title object using
682 Wiki::articleFromTitle().
683 &$title: Title (object) used to create the article object
684 &$article: Article (object) that will be returned
685 $context: IContextSource (object)
687 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
688 $targetTitle: target title (object)
689 $destTitle: destination title (object)
691 'ArticlePageDataAfter': After loading data of an article from the database.
692 &$wikiPage: WikiPage (object) whose data were loaded
693 &$row: row (object) returned from the database server
695 'ArticlePageDataBefore': Before loading data of an article from the database.
696 &$wikiPage: WikiPage (object) that data will be loaded
697 &$fields: fields (array) to load from the database
698 &$tables: tables (array) to load from the database
699 &$joinConds: join conditions (array) to load from the database
701 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
702 $wikiPage: the WikiPage being saved
703 $popts: parser options to be used for pre-save transformation
705 'ArticleProtect': Before an article is protected.
706 &$wikiPage: the WikiPage being protected
707 &$user: the user doing the protection
708 $protect: Set of restriction keys
709 $reason: Reason for protect
711 'ArticleProtectComplete': After an article is protected.
712 &$wikiPage: the WikiPage that was protected
713 &$user: the user who did the protection
714 $protect: Set of restriction keys
715 $reason: Reason for protect
717 'ArticlePurge': Before executing "&action=purge".
718 &$wikiPage: WikiPage (object) to purge
720 'ArticleRevisionUndeleted': After an article revision is restored.
721 &$title: the article title
722 $revision: the revision
723 $oldPageID: the page ID of the revision when archived (may be null)
725 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
726 revisions of an article.
727 $title: Title object of the article
728 $ids: Ids to set the visibility for
729 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
730 examined to determine exactly what visibility bits have changed for each
731 revision. This array is of the form
732 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
734 'ArticleRollbackComplete': After an article rollback is completed.
735 $wikiPage: the WikiPage that was edited
736 $user: the user who did the rollback
737 $revision: the revision the page was reverted back to
738 $current: the reverted revision
740 'ArticleUndelete': When one or more revisions of an article are restored.
741 &$title: Title corresponding to the article restored
742 $create: Whether or not the restoration caused the page to be created (i.e. it
743 didn't exist before).
744 $comment: The comment associated with the undeletion.
745 $oldPageId: ID of page previously deleted (from archive table). This ID will be used
746 for the restored page.
747 $restoredPages: Set of page IDs that have revisions restored for this undelete,
748 with keys being page IDs and values are 'true'.
750 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
751 $pageArchive: the PageArchive object
752 &$logEntry: ManualLogEntry object
753 $user: User who is performing the log action
755 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
756 the user is redirected back to the page.
757 $article: the article
758 &$sectionanchor: The section anchor link (e.g. "#overview" )
759 &$extraq: Extra query parameters which can be added via hooked functions
761 'ArticleViewFooter': After showing the footer section of an ordinary page view
762 $article: Article object
763 $patrolFooterShown: boolean whether patrol footer is shown
765 'ArticleViewHeader': Before the parser cache is about to be tried for article
767 &$article: the article
768 &$pcache: whether to try the parser cache or not
769 &$outputDone: whether the output for this page finished or not. Set to
770 a ParserOutput object to both indicate that the output is done and what
771 parser output was used.
773 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
774 redirect was followed.
775 &$article: target article (object)
777 'AuthChangeFormFields': After converting a field information array obtained
778 from a set of AuthenticationRequest classes into a form descriptor; hooks
779 can tweak the array to change how login etc. forms should look.
780 $requests: array of AuthenticationRequests the fields are created from
781 $fieldInfo: field information array (union of all AuthenticationRequest::getFieldInfo() responses).
782 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
783 to change the order of the fields.
784 $action: one of the AuthManager::ACTION_* constants.
786 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
787 for a reason other than misconfiguration or session loss. No return data is
788 accepted; this hook is for auditing only.
789 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
790 $user: The User object being authenticated against, or null if authentication
791 failed before getting that far.
792 $username: A guess at the user name being authenticated, or null if we can't
795 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
796 Called when creating a local account for an user logged in from an external
797 authentication method.
798 $user: User object created locally
800 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
801 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
802 extension to set it programmatically to a variable class.
803 &$auth: the $wgAuth object, probably a stub
805 'AutopromoteCondition': Check autopromote condition for user.
806 $type: condition type
809 &$result: result of checking autopromote condition
811 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
812 certain title are fetched.
814 $title: title of the page to which backlinks are sought
815 &$conds: query conditions
817 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
821 'BadImage': When checking against the bad image list. Change $bad and return
822 false to override. If an image is "bad", it is not rendered inline in wiki
823 pages or galleries in category pages.
824 $name: Image name being checked
825 &$bad: Whether or not the image is "bad"
827 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
828 custom HTML after the section. Any uses of the hook need to handle escaping.
829 $template: BaseTemplate
830 $portlet: string portlet name
833 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
834 and returning it for the skin to output. You can add items to the toolbox while
835 still letting the skin make final decisions on skin-specific markup conventions
837 &$sk: The BaseTemplate base skin template
838 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
839 BaseTemplate::makeListItem for details on the format of individual items
840 inside of this array.
842 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
843 "noarticletext-nopermission" at Article::showMissingArticle().
844 $article: article object
846 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
847 override how the redirect is output by modifying, or by returning false, and
848 letting standard HTTP rendering take place.
849 ATTENTION: This hook is likely to be removed soon due to overall design of the
851 $context: IContextSource object
852 &$redirect: string URL, modifiable
854 'BeforeInitialize': Before anything is initialized in
855 MediaWiki::performRequest().
856 &$title: Title being used for request
858 &$output: OutputPage object
860 $request: WebRequest object
861 $mediaWiki: Mediawiki object
863 'BeforePageDisplay': Prior to outputting a page.
864 &$out: OutputPage object
867 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
868 override how the redirect is output by modifying, or by returning false and
869 taking over the output.
870 $out: OutputPage object
871 &$redirect: URL, modifiable
872 &$code: HTTP code (eg '301' or '302'), modifiable
874 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
875 $parser: Parser object
877 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
878 as a key then the file will appear as a broken thumbnail.
879 &$descQuery: query string to add to thumbnail URL
881 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
882 $parser: Parser object
883 $title: title of the template
884 &$skip: skip this template and link it?
885 &$id: the id of the revision being parsed
887 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
888 &$parser: Parser object
889 &$ig: ImageGallery object
891 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
893 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
894 to a newly created user account.
895 &$injected_html: Any HTML to inject after the "logged in" message of a newly
898 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
899 normalizations have been performed, except for the $wgMaxImageArea check.
901 &$params: Array of parameters
902 &$checkImageAreaHookResult: null, set to true or false to override the
903 $wgMaxImageArea check result.
905 'BitmapHandlerTransform': before a file is transformed, gives extension the
906 possibility to transform it themselves
907 $handler: BitmapHandler
909 &$scalerParams: Array with scaler parameters
910 &$mto: null, set to a MediaTransformOutput
912 'BlockIp': Before an IP address or user is blocked.
913 &$block: the Block object about to be saved
914 &$user: the user _doing_ the block (not the one being blocked)
915 &$reason: if the hook is aborted, the error message to be returned in an array
917 'BlockIpComplete': After an IP address or user is blocked.
918 $block: the Block object that was saved
919 $user: the user who did the block (not the one being blocked)
920 $priorBlock: the Block object for the prior block or null if there was none
922 'BookInformation': Before information output on Special:Booksources.
923 $isbn: ISBN to show information for
924 $output: OutputPage object in use
926 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
927 to be able to access the wiki via HTTPS.
928 $ip: The IP address in human-readable form
929 &$canDo: This reference should be set to false if the client may not be able
932 'CanonicalNamespaces': For extensions adding their own namespaces or altering
934 Note that if you need to specify namespace protection or content model for
935 a namespace that is added in a CanonicalNamespaces hook handler, you
936 should do so by altering $wgNamespaceProtection and
937 $wgNamespaceContentModels outside the handler, in top-level scope. The
938 point at which the CanonicalNamespaces hook fires is too late for altering
939 these variables. This applies even if the namespace addition is
940 conditional; it is permissible to declare a content model and protection
941 for a namespace and then decline to actually register it.
942 &$namespaces: Array of namespace numbers with corresponding canonical names
944 'CategoryAfterPageAdded': After a page is added to a category.
945 $category: Category that page was added to
946 $wikiPage: WikiPage that was added
948 'CategoryAfterPageRemoved': After a page is removed from a category.
949 $category: Category that page was removed from
950 $wikiPage: WikiPage that was removed
951 $id: the page ID (original ID in case of page deletions)
953 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
954 &$catpage: CategoryPage instance
956 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
957 in a Category page. Gives extensions the opportunity to batch load any
958 related data about the pages.
959 $type: The category type. Either 'page', 'file' or 'subcat'
960 $res: Query result from Wikimedia\Rdbms\IDatabase::select()
962 'CategoryViewer::generateLink': Before generating an output link allow
963 extensions opportunity to generate a more specific or relevant link.
964 $type: The category type. Either 'page', 'img' or 'subcat'
965 $title: Title object for the categorized page
966 $html: Requested html content of anchor
967 &$link: Returned value. When set to a non-null value by a hook subscriber
968 this value will be used as the anchor instead of Linker::link
970 'ChangeAuthenticationDataAudit': Called when user changes his password.
971 No return data is accepted; this hook is for auditing only.
972 $req: AuthenticationRequest object describing the change (and target user)
973 $status: StatusValue with the result of the action
975 'ChangePasswordForm': DEPRECATED! Use AuthChangeFormFields or security levels.
976 For extensions that need to add a field to the ChangePassword form via the
978 &$extraFields: An array of arrays that hold fields like would be passed to the
981 'ChangesListInitRows': Batch process change list rows prior to rendering.
982 $changesList: ChangesList instance
983 $rows: The data that will be rendered. May be a ResultWrapper instance or
986 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
987 &$changesList: ChangesList instance.
988 &$articlelink: HTML of link to article (already filled-in).
989 &$s: HTML of row that is being constructed.
990 &$rc: RecentChange instance.
991 $unpatrolled: Whether or not we are showing unpatrolled changes.
992 $watched: Whether or not the change is watched by the user.
994 'ChangesListSpecialPageFilters': DEPRECATED! Use 'ChangesListSpecialPageStructuredFilters'
996 Called after building form options on pages
997 inheriting from ChangesListSpecialPage (in core: RecentChanges,
998 RecentChangesLinked and Watchlist).
999 $special: ChangesListSpecialPage instance
1000 &$filters: associative array of filter definitions. The keys are the HTML
1001 name/URL parameters. Each key maps to an associative array with a 'msg'
1002 (message key) and a 'default' value.
1004 'ChangesListSpecialPageQuery': Called when building SQL query on pages
1005 inheriting from ChangesListSpecialPage (in core: RecentChanges,
1006 RecentChangesLinked and Watchlist).
1007 Do not use this to implement individual filters if they are compatible with the
1008 ChangesListFilter and ChangesListFilterGroup structure.
1009 Instead, use sub-classes of those classes, in conjunction with the
1010 ChangesListSpecialPageStructuredFilters hook.
1011 This hook can be used to implement filters that do not implement that structure,
1012 or custom behavior that is not an individual filter.
1013 $name: name of the special page, e.g. 'Watchlist'
1014 &$tables: array of tables to be queried
1015 &$fields: array of columns to select
1016 &$conds: array of WHERE conditionals for query
1017 &$query_options: array of options for the database request
1018 &$join_conds: join conditions for the tables
1019 $opts: FormOptions for this request
1021 'ChangesListSpecialPageStructuredFilters': Called to allow extensions to register
1022 filters for pages inheriting from ChangesListSpecialPage (in core: RecentChanges,
1023 RecentChangesLinked, and Watchlist). Generally, you will want to construct
1024 new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects.
1025 When constructing them, you specify which group they belong to. You can reuse
1026 existing groups (accessed through $special->getFilterGroup), or create your own
1027 (ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup).
1028 If you create new groups, you must register them with $special->registerFilterGroup.
1029 Note that this is called regardless of whether the user is currently using
1030 the new (structured) or old (unstructured) filter UI. If you want your boolean
1031 filter to show on both the new and old UI, specify all the supported fields.
1032 These include showHide, label, and description.
1033 See the constructor of each ChangesList* class for documentation of supported
1035 $special: ChangesListSpecialPage instance
1037 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
1038 removed from all revisions and log entries to which it was applied). This gives
1039 extensions a chance to take it off their books.
1040 $tag: name of the tag
1041 &$status: Status object. Add warnings to this as required. There is no point
1042 setting errors, as the deletion has already been partly carried out by this
1045 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1046 from the UI (Special:Tags) or via the API. You could use this hook if you want
1047 to reserve a specific "namespace" of tags, or something similar.
1048 $tag: name of the tag
1049 $user: user initiating the action
1050 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1051 using `$status->warning()`. Errors and warnings will be relayed to the user.
1052 If you set an error, the user will be unable to create the tag.
1054 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1055 deleted from the UI (Special:Tags) or via the API. The default is that tags
1056 defined using the ListDefinedTags hook are not allowed to be deleted unless
1057 specifically allowed. If you wish to allow deletion of the tag, set
1058 `$status = Status::newGood()` to allow deletion, and then `return false` from
1059 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1060 out custom deletion actions.
1061 $tag: name of the tag
1062 $user: user initiating the action
1063 &$status: Status object. See above.
1065 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1066 uses are in active use.
1067 &$tags: list of all active tags. Append to this array.
1069 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1070 ChangeTags::updateTags function. Params:
1071 $addedTags: tags effectively added in the update
1072 $removedTags: tags effectively removed in the update
1073 $prevTags: tags that were present prior to the update
1074 $rc_id: recentchanges table id
1075 $rev_id: revision table id
1076 $log_id: logging table id
1078 $rc: RecentChange being tagged when the tagging accompanies the action or null
1079 $user: User who performed the tagging when the tagging is subsequent to the action or null
1081 'ChangeTagsAllowedAdd': Called when checking if a user can add tags to a change.
1082 &$allowedTags: List of all the tags the user is allowed to add. Any tags the
1083 user wants to add ($addTags) that are not in this array will cause it to fail.
1084 You may add or remove tags to this array as required.
1085 $addTags: List of tags user intends to add.
1086 $user: User who is adding the tags.
1088 'ChangeUserGroups': Called before user groups are changed.
1089 $performer: The User who will perform the change
1090 $user: The User whose groups will be changed
1091 &$add: The groups that will be added
1092 &$remove: The groups that will be removed
1094 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1095 $collationName: Name of the collation in question
1096 &$collationObject: Null. Replace with a subclass of the Collation class that
1097 implements the collation given in $collationName.
1099 'ConfirmEmailComplete': Called after a user's email has been confirmed
1101 $user: user (object) whose email is being confirmed
1103 'ContentAlterParserOutput': Modify parser output for a given content object.
1104 Called by Content::getParserOutput after parsing has finished. Can be used
1105 for changes that depend on the result of the parsing but have to be done
1106 before LinksUpdate is called (such as adding tracking categories based on
1108 $content: The Content to render
1109 $title: Title of the page, as context
1110 $parserOutput: ParserOutput to manipulate
1112 'ContentGetParserOutput': Customize parser output for a given content object,
1113 called by AbstractContent::getParserOutput. May be used to override the normal
1114 model-specific rendering of page content.
1115 $content: The Content to render
1116 $title: Title of the page, as context
1117 $revId: The revision ID, as context
1118 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1119 the output can only depend on parameters provided to this hook function, not
1121 $generateHtml: boolean, indicating whether full HTML should be generated. If
1122 false, generation of HTML may be skipped, but other information should still
1123 be present in the ParserOutput object.
1124 &$output: ParserOutput, to manipulate or replace
1126 'ContentHandlerDefaultModelFor': Called when the default content model is
1127 determined for a given title. May be used to assign a different model for that
1129 $title: the Title in question
1130 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1132 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1133 a given content model name, but no entry for that model exists in
1135 Note: if your extension implements additional models via this hook, please
1136 use GetContentModels hook to make them known to core.
1137 $modeName: the requested content model name
1138 &$handler: set this to a ContentHandler object, if desired.
1140 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1141 be used on a given page. This is especially useful to prevent some content
1142 models to be used in some special location.
1143 $contentModel: ID of the content model in question
1144 $title: the Title in question.
1145 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1146 Handler functions that modify $ok should generally return false to prevent
1147 further hooks from further modifying $ok.
1149 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1150 &$pager: Pager object for contributions
1151 &$queryInfo: The query for the contribs Pager
1153 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1155 &$data: an array of results of all contribs queries
1156 $pager: The ContribsPager object hooked into
1157 $offset: Index offset, inclusive
1158 $limit: Exact query limit
1159 $descending: Query direction, false for ascending, true for descending
1161 'ContributionsLineEnding': Called before a contributions HTML line is finished
1162 $page: SpecialPage object for contributions
1163 &$ret: the HTML line
1164 $row: the DB row for this line
1165 &$classes: the classes to add to the surrounding <li>
1166 &$attribs: associative array of other HTML attributes for the <li> element.
1167 Currently only data attributes reserved to MediaWiki are allowed
1168 (see Sanitizer::isReservedDataAttribute).
1170 'ContributionsToolLinks': Change tool links above Special:Contributions
1171 $id: User identifier
1172 $title: User page title
1173 &$tools: Array of tool links
1174 $specialPage: SpecialPage instance for context and services. Can be either
1175 SpecialContributions or DeletedContributionsPage. Extensions should type
1176 hint against a generic SpecialPage though.
1178 'ConvertContent': Called by AbstractContent::convert when a conversion to
1179 another content model is requested.
1180 Handler functions that modify $result should generally return false to disable
1181 further attempts at conversion.
1182 $content: The Content object to be converted.
1183 $toModel: The ID of the content model to convert to.
1184 $lossy: boolean indicating whether lossy conversion is allowed.
1185 &$result: Output parameter, in case the handler function wants to provide a
1186 converted Content object. Note that $result->getContentModel() must return
1189 'ContentSecurityPolicyDefaultSource': Modify the allowed CSP load sources. This affects all
1190 directives except for the script directive. If you want to add a script
1191 source, see ContentSecurityPolicyScriptSource hook.
1192 &$defaultSrc: Array of Content-Security-Policy allowed sources
1193 $policyConfig: Current configuration for the Content-Security-Policy header
1194 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE
1195 depending on type of header
1197 'ContentSecurityPolicyDirectives': Modify the content security policy directives.
1198 Use this only if ContentSecurityPolicyDefaultSource and
1199 ContentSecurityPolicyScriptSource do not meet your needs.
1200 &$directives: Array of CSP directives
1201 $policyConfig: Current configuration for the CSP header
1202 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1203 ContentSecurityPolicy::FULL_MODE depending on type of header
1205 'ContentSecurityPolicyScriptSource': Modify the allowed CSP script sources.
1206 Note that you also have to use ContentSecurityPolicyDefaultSource if you
1207 want non-script sources to be loaded from
1209 &$scriptSrc: Array of CSP directives
1210 $policyConfig: Current configuration for the CSP header
1211 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE
1212 depending on type of header
1214 'CustomEditor': When invoking the page editor
1215 Return true to allow the normal editor to be used, or false if implementing
1216 a custom editor, e.g. for a special namespace, etc.
1217 $article: Article being edited
1218 $user: User performing the edit
1220 'DatabaseOraclePostInit': Called after initialising an Oracle database
1221 $db: the DatabaseOracle object
1223 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1224 for Special:DeletedContributions
1225 Similar to ContribsPager::reallyDoQuery
1226 &$data: an array of results of all contribs queries
1227 $pager: The DeletedContribsPager object hooked into
1228 $offset: Index offset, inclusive
1229 $limit: Exact query limit
1230 $descending: Query direction, false for ascending, true for descending
1232 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1234 Similar to ContributionsLineEnding
1235 $page: SpecialPage object for DeletedContributions
1236 &$ret: the HTML line
1237 $row: the DB row for this line
1238 &$classes: the classes to add to the surrounding <li>
1239 &$attribs: associative array of other HTML attributes for the <li> element.
1240 Currently only data attributes reserved to MediaWiki are allowed
1241 (see Sanitizer::isReservedDataAttribute).
1243 'DeleteUnknownPreferences': Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which
1244 to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences
1245 that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed
1246 with 'gadget-', and so anything with that prefix is excluded from the deletion.
1247 &where: An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted
1248 from the user_properties table.
1249 $db: The IDatabase object, useful for accessing $db->buildLike() etc.
1251 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1252 after the new revision's content has been loaded into the class member variable
1253 $differenceEngine->mNewContent but before returning true from this function.
1254 $differenceEngine: DifferenceEngine object
1256 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1257 DifferenceEngine::loadText() after the new revision's content has been loaded
1258 into the class member variable $differenceEngine->mNewContent but before
1259 checking if the variable's value is null.
1260 This hook can be used to inject content into said class member variable.
1261 $differenceEngine: DifferenceEngine object
1263 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1264 which is shown both on the diff header as well as on the bottom of a page, usually
1265 wrapped in a span element which has class="patrollink".
1266 $differenceEngine: DifferenceEngine object
1267 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1268 $rcid: Recent change ID (rc_id) for this change (int)
1270 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1271 For example the rcid might be set to zero due to the user being the same as the
1272 performer of the change but an extension might still want to show it under certain
1274 &$rcid: rc_id (int) of the change or 0
1275 $differenceEngine: DifferenceEngine object
1276 $change: RecentChange object
1277 $user: User object representing the current user
1279 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1280 contains information about the new revision, such as the revision's author, whether
1281 the revision was marked as a minor edit or not, etc.
1282 $differenceEngine: DifferenceEngine object
1283 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1284 include things like revision author info, revision comment, RevisionDelete link and more
1285 $formattedRevisionTools: Array containing revision tools, some of which may have
1286 been injected with the DiffRevisionTools hook
1287 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1288 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1289 $newminor: String indicating if the new revision was marked as a minor edit
1290 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1291 whether we should show just the diff; passed in as a query string parameter to the
1292 various URLs constructed here (i.e. $nextlink)
1293 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1294 to use the RevisionDelete feature
1295 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1297 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1298 contains information about the old revision, such as the revision's author, whether
1299 the revision was marked as a minor edit or not, etc.
1300 $differenceEngine: DifferenceEngine object
1301 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1302 include things like revision author info, revision comment, RevisionDelete link and more
1303 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1304 $oldminor: String indicating if the old revision was marked as a minor edit
1305 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1306 whether we should show just the diff; passed in as a query string parameter to the
1307 various URLs constructed here (i.e. $prevlink)
1308 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1309 to use the RevisionDelete feature
1310 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1312 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1313 there is no old revision
1314 &$oldHeader: empty string by default
1316 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1317 Return false to not add parser output via OutputPage's addParserOutput method.
1318 $differenceEngine: DifferenceEngine object
1319 $out: OutputPage object
1320 $parserOutput: ParserOutput object
1321 $wikiPage: WikiPage object
1323 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1324 point and return false to not show the final "mark as patrolled" link on the bottom
1326 This hook has no arguments.
1328 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1329 eventually gets sent to the OutputPage object.
1330 $differenceEngine: DifferenceEngine object
1332 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1333 body (without header) in cases when there is no old revision or the old and new
1334 revisions are identical.
1335 $differenceEngine: DifferenceEngine object
1337 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1338 object into the diff view
1339 $out: OutputPage object
1341 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1342 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1343 Return false in order to prevent displaying the missing revision message
1344 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1345 $differenceEngine: DifferenceEngine object
1347 'DiffRevisionTools': Override or extend the revision tools available from the
1348 diff view, i.e. undo, etc.
1349 $newRev: Revision object of the "new" revision
1350 &$links: Array of HTML links
1351 $oldRev: Revision object of the "old" revision (may be null)
1352 $user: Current user object
1354 'DiffViewHeader': Called before diff display
1355 $diff: DifferenceEngine object that's calling
1356 $oldRev: Revision object of the "old" revision (may be null/invalid)
1357 $newRev: Revision object of the "new" revision
1359 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1361 &$article: article (object) being viewed
1362 &$oldid: oldid (int) being viewed
1364 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1365 Override the HTML generated for section edit links
1366 $skin: Skin object rendering the UI
1367 $title: Title object for the title being linked to (may not be the same as
1368 the page title, if the section is included from a template)
1369 $section: The designation of the section being pointed to, to be included in
1370 the link, like "§ion=$section"
1371 $tooltip: The default tooltip. Escape before using.
1372 By default, this is wrapped in the 'editsectionhint' message.
1373 &$result: The HTML to return, prefilled with the default plus whatever other
1374 changes earlier hooks have made
1375 $lang: The language code to use for the link in the wfMessage function
1377 'EditFilter': Perform checks on an edit
1378 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1379 $text: Contents of the edit box
1380 $section: Section being edited
1381 &$error: Error message to return
1382 $summary: Edit summary for page
1385 'EditFilterMergedContent': Post-section-merge edit filter.
1386 This may be triggered by the EditPage or any other facility that modifies page
1387 content. Use the $status object to indicate whether the edit should be allowed,
1388 and to provide a reason for disallowing it. Return false to abort the edit, and
1389 true to continue. Returning true if $status->isOK() returns false means "don't
1390 save but continue user interaction", e.g. show the edit form.
1391 $status->apiHookResult can be set to an array to be returned by api.php
1392 action=edit. This is used to deliver captchas.
1393 $context: object implementing the IContextSource interface.
1394 $content: content of the edit box, as a Content object.
1395 $status: Status object to represent errors, etc.
1396 $summary: Edit summary for page
1397 $user: the User object representing the user whois performing the edit.
1398 $minoredit: whether the edit was marked as minor by the user.
1400 'EditFormInitialText': Allows modifying the edit form when editing existing
1402 $editPage: EditPage object
1404 'EditFormPreloadText': Allows population of the edit form when creating
1406 &$text: Text to preload with
1407 &$title: Title object representing the page being created
1409 'EditPage::attemptSave': Called before an article is
1410 saved, that is before WikiPage::doEditContent() is called
1411 $editpage_Obj: the current EditPage object
1413 'EditPage::attemptSave:after': Called after an article save attempt
1414 $editpage_Obj: the current EditPage object
1415 $status: the resulting Status object
1416 $resultDetails: Result details array
1418 'EditPage::importFormData': allow extensions to read additional data
1420 $editpage: EditPage instance
1421 $request: Webrequest
1422 return value is ignored (should always return true)
1424 'EditPage::showEditForm:fields': allows injection of form field into edit form
1425 Return value is ignored (should always return true)
1426 &$editor: the EditPage instance for reference
1427 &$out: an OutputPage instance to write to
1429 'EditPage::showEditForm:initial': before showing the edit form
1430 Return false to halt editing; you'll need to handle error messages, etc.
1431 yourself. Alternatively, modifying $error and returning true will cause the
1432 contents of $error to be echoed at the top of the edit form as wikitext.
1433 Return true without altering $error to allow the edit to proceed.
1434 &$editor: EditPage instance (object)
1435 &$out: an OutputPage instance to write to
1437 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1438 but for the read-only 'view source' variant of the edit form.
1439 Return value is ignored (should always return true)
1440 $editor: EditPage instance (object)
1441 &$out: an OutputPage instance to write to
1443 'EditPage::showStandardInputs:options': allows injection of form fields into
1444 the editOptions area
1445 Return value is ignored (should always be true)
1446 $editor: EditPage instance (object)
1447 $out: an OutputPage instance to write to
1448 &$tabindex: HTML tabindex of the last edit check/button
1450 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1451 when there's an edit conflict. Return false to halt normal diff output; in
1452 this case you're responsible for computing and outputting the entire "conflict"
1453 part, i.e., the "difference between revisions" and "your text" headers and
1455 &$editor: EditPage instance
1456 &$out: OutputPage instance
1458 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1459 textarea in the edit form.
1460 &$editpage: The current EditPage object
1461 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1462 &$tabindex: HTML tabindex of the last edit check/button
1464 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1465 textarea in the edit form.
1466 &$toolbar: The toolbar HTML
1467 Hook subscribers can return false to avoid the default toolbar code being loaded.
1469 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1470 contribution/copyright notice.
1471 $title: title of page being edited
1472 &$msg: localization message name, overridable. Default is either
1473 'copyrightwarning' or 'copyrightwarning2'.
1475 'EditPageGetCheckboxesDefinition': Allows modifying the edit checkboxes
1476 below the textarea in the edit form.
1477 $editpage: The current EditPage object
1478 &$checkboxes: Array of checkbox definitions. See EditPage::getCheckboxesDefinition()
1481 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1482 "Show changes". Note that it is preferable to implement diff handling for
1483 different data types using the ContentHandler facility.
1484 $editPage: EditPage object
1485 &$newtext: wikitext that will be used as "your version"
1487 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1488 previewed. Note that it is preferable to implement previews for different data
1489 types using the ContentHandler facility.
1490 $editPage: EditPage object
1491 &$content: Content object to be previewed (may be replaced by hook function)
1493 'EditPageNoSuchSection': When a section edit request is given for an
1494 non-existent section
1495 &$editpage: The current EditPage object
1496 &$res: the HTML of the error text
1498 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1499 of terms of service summary link that might exist separately from the copyright
1501 $title: title of page being edited
1502 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1504 'EmailConfirmed': When checking that the user's email address is "confirmed".
1505 This runs before the other checks, such as anonymity and the real check; return
1506 true to allow those checks to occur, and false if checking is done.
1507 &$user: User being checked
1508 &$confirmed: Whether or not the email address is confirmed
1510 'EmailUser': Before sending email from one user to another.
1511 &$to: MailAddress object of receiving user
1512 &$from: MailAddress object of sending user
1513 &$subject: subject of the mail
1514 &$text: text of the mail
1515 &$error: Out-param for an error. Should be set to a Status object or boolean false.
1517 'EmailUserCC': Before sending the copy of the email to the author.
1518 &$to: MailAddress object of receiving user
1519 &$from: MailAddress object of sending user
1520 &$subject: subject of the mail
1521 &$text: text of the mail
1523 'EmailUserComplete': After sending email from one user to another.
1524 $to: MailAddress object of receiving user
1525 $from: MailAddress object of sending user
1526 $subject: subject of the mail
1527 $text: text of the mail
1529 'EmailUserForm': After building the email user form object.
1530 &$form: HTMLForm object
1532 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1534 $user: The user who is trying to email another user.
1535 $editToken: The user's edit token.
1536 &$hookErr: Out-param for the error. Passed as the parameters to
1537 OutputPage::showErrorPage.
1539 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1540 group of changes in EnhancedChangesList.
1541 Hook subscribers can return false to omit this line from recentchanges.
1542 $changesList: EnhancedChangesList object
1543 &$links: The links that were generated by EnhancedChangesList
1544 $block: The RecentChanges objects in that block
1546 'EnhancedChangesListModifyLineData': to alter data used to build
1547 a grouped recent change inner line in EnhancedChangesList.
1548 Hook subscribers can return false to omit this line from recentchanges.
1549 $changesList: EnhancedChangesList object
1550 &$data: An array with all the components that will be joined in order to create the line
1551 $block: An array of RecentChange objects in that block
1552 $rc: The RecentChange object for this line
1553 &$classes: An array of classes to change
1554 &$attribs: associative array of other HTML attributes for the <tr> element.
1555 Currently only data attributes reserved to MediaWiki are allowed
1556 (see Sanitizer::isReservedDataAttribute).
1558 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1559 a non-grouped recent change line in EnhancedChangesList.
1560 $changesList: EnhancedChangesList object
1561 &$data: An array with all the components that will be joined in order to create the line
1562 $rc: The RecentChange object for this line
1564 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1566 $ip: The ip address of the user
1568 'ExtensionTypes': Called when generating the extensions credits, use this to
1569 change the tables headers.
1570 &$extTypes: associative array of extensions types
1572 'FetchChangesList': When fetching the ChangesList derivative for a particular
1574 $user: User the list is being fetched for
1575 &$skin: Skin object to be used with the list
1576 &$list: List object (defaults to NULL, change it to an object instance and
1577 return false override the list derivative used)
1579 'FileDeleteComplete': When a file is deleted.
1580 &$file: reference to the deleted file
1581 &$oldimage: in case of the deletion of an old image, the name of the old file
1582 &$article: in case all revisions of the file are deleted a reference to the
1583 WikiFilePage associated with the file.
1584 &$user: user who performed the deletion
1587 'FileTransformed': When a file is transformed and moved into storage.
1588 $file: reference to the File object
1589 $thumb: the MediaTransformOutput object
1590 $tmpThumbPath: The temporary file system path of the transformed file
1591 $thumbPath: The permanent storage path of the transformed file
1593 'FileUndeleteComplete': When a file is undeleted
1594 $title: title object to the file
1595 $fileVersions: array of undeleted versions. Empty if all versions were restored
1596 $user: user who performed the undeletion
1599 'FileUpload': When a file upload occurs.
1600 $file: Image object representing the file that was uploaded
1601 $reupload: Boolean indicating if there was a previously another image there or
1603 $hasDescription: Boolean indicating that there was already a description page
1604 and a new one from the comment wasn't created (since 1.17)
1606 'FormatAutocomments': When an autocomment is formatted by the Linker.
1607 &$comment: Reference to the accumulated comment. Initially null, when set the
1608 default code will be skipped.
1609 $pre: Boolean, true if there is text before this autocomment
1610 $auto: The extracted part of the parsed comment before the call to the hook.
1611 $post: Boolean, true if there is text after this autocomment
1612 $title: An optional title object used to links to sections. Can be null.
1613 $local: Boolean indicating whether section links should refer to local page.
1614 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1615 autocomment originated; null for the local wiki. Added in 1.26, should default
1616 to null in handler functions, for backwards compatibility.
1618 'GalleryGetModes': Get list of classes that can render different modes of a
1620 &$modeArray: An associative array mapping mode names to classes that implement
1621 that mode. It is expected all registered classes are a subclass of
1624 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1626 $user: user to promote.
1627 &$promote: groups that will be added.
1629 'GetBlockedStatus': after loading blocking status of an user from the database
1630 &$user: user (object) being checked
1632 'GetCacheVaryCookies': Get cookies that should vary cache options.
1633 $out: OutputPage object
1634 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1635 that have to vary cache options
1637 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1639 &$title: Title object of page
1640 &$url: string value as output (out parameter, can modify)
1641 $query: query options passed to Title::getCanonicalURL()
1643 'GetContentModels': Add content models to the list of available models.
1644 &$models: array containing current model list, as strings. Extensions should add to this list.
1646 'GetDefaultSortkey': Override the default sortkey for a page.
1647 $title: Title object that we need to get a sortkey for
1648 &$sortkey: Sortkey to use.
1650 'GetDifferenceEngine': Called when getting a new difference engine interface
1651 object Return false for valid object in $differenceEngine or true for the
1652 default difference engine.
1653 $context: IContextSource context to be used for diff
1654 $old: Revision ID to show and diff with
1655 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1656 $refreshCache: If set, refreshes the diff cache
1657 $unhide: If set, allow viewing deleted revs
1658 &$differenceEngine: output parameter, difference engine object to be used for
1661 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1662 underscore) magic words. Called by MagicWord.
1663 &$doubleUnderscoreIDs: array of strings
1665 'GetExtendedMetadata': Get extended file metadata for the API
1666 &$combinedMeta: Array of the form:
1667 'MetadataPropName' => array(
1668 value' => prop value,
1669 'source' => 'name of hook'
1671 $file: File object of file in question
1672 $context: RequestContext (including language to use)
1673 $single: Only extract the current language; if false, the prop value should
1674 be in the metadata multi-language array format:
1675 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1676 &$maxCacheTime: how long the results can be cached
1678 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1679 &$title: Title object of page
1680 &$url: string value as output (out parameter, can modify)
1681 $query: query options passed to Title::getFullURL()
1683 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1684 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1686 &$output: string for the output timestamp
1687 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1688 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1689 $user: User whose preferences are being used to make timestamp
1690 $lang: Language that will be used to render the timestamp
1692 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1693 &$title: Title object of page
1694 &$url: string value as output (out parameter, can modify)
1695 $query: query options passed to Title::getInternalURL()
1697 'GetIP': modify the ip of the current user (called only once).
1698 &$ip: string holding the ip as determined so far
1700 'GetLangPreferredVariant': Called in LanguageConverter#getPreferredVariant() to
1701 allow fetching the language variant code from cookies or other such
1702 alternative storage.
1703 &$req: language variant from the URL (string) or boolean false if no variant
1704 was specified in the URL; the value of this variable comes from
1705 LanguageConverter#getURLVariant()
1707 'GetLinkColours': modify the CSS class of an array of page links.
1708 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1710 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1712 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1713 working with internal urls (non-interwiki) then it may be preferable to work
1714 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1715 be buggy for internal urls on render if you do not re-implement the horrible
1716 hack that Title::getLocalURL uses in your own extension.
1717 &$title: Title object of page
1718 &$url: string value as output (out parameter, can modify)
1719 $query: query options passed to Title::getLocalURL()
1721 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1722 without any fancy queries or variants.
1723 &$title: Title object of page
1724 &$url: string value as output (out parameter, can modify)
1726 'GetLocalURL::Internal': Modify local URLs to internal pages.
1727 &$title: Title object of page
1728 &$url: string value as output (out parameter, can modify)
1729 $query: query options passed to Title::getLocalURL()
1731 'GetLogTypesOnUser': Add log types where the target is a userpage
1732 &$types: Array of log types
1734 'GetMetadataVersion': Modify the image metadata version currently in use. This
1735 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1736 that need to have versioned metadata should add an element to the end of the
1737 version array of the form 'handler_name=version'. Most media handlers won't need
1738 to do this unless they broke backwards compatibility with a previous version of
1739 the media handler metadata output.
1740 &$version: Array of version strings
1742 'GetNewMessagesAlert': Disable or modify the new messages alert
1743 &$newMessagesAlert: An empty string by default. If the user has new talk page
1744 messages, this should be populated with an alert message to that effect
1745 $newtalks: An empty array if the user has no new messages or an array
1746 containing links and revisions if there are new messages (See
1747 User::getNewMessageLinks)
1748 $user: The user object of the user who is loading the page
1749 $out: OutputPage object (to check what type of page the user is on)
1751 'GetPreferences': Modify user preferences.
1752 $user: User whose preferences are being modified.
1753 &$preferences: Preferences description array, to be fed to an HTMLForm object
1755 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1756 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1758 &$output: string for the output timestamp
1759 &$diff: DateInterval representing the difference between the timestamps
1760 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1761 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1762 $user: User whose preferences are being used to make timestamp
1763 $lang: Language that will be used to render the timestamp
1765 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1766 checked for. Use instead of userCan for most cases. Return false if the user
1767 can't do it, and populate $result with the reason in the form of
1768 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1769 might want to use ApiMessage to provide machine-readable details for the API).
1770 For consistency, error messages
1771 should be plain text with no special coloring, bolding, etc. to show that
1772 they're errors; presenting them properly to the user as errors is done by the
1774 &$title: Title object being checked against
1775 &$user: Current user object
1776 $action: Action being checked
1777 &$result: User permissions error to add. If none, return true.
1779 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1780 called only if expensive checks are enabled. Add a permissions error when
1781 permissions errors are checked for. Return false if the user can't do it, and
1782 populate $result with the reason in the form of array( messagename, param1,
1783 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1784 to provide machine-readable details for the API). For consistency, error
1785 messages should be plain text with no
1786 special coloring, bolding, etc. to show that they're errors; presenting them
1787 properly to the user as errors is done by the caller.
1788 &$title: Title object being checked against
1789 &$user: Current user object
1790 $action: Action being checked
1791 &$result: User permissions error to add. If none, return true.
1793 'GitViewers': Called when generating the list of git viewers for
1794 Special:Version, use this to change the list.
1795 &$extTypes: associative array of repo URLS to viewer URLs.
1797 'HistoryRevisionTools': Override or extend the revision tools available from the
1798 page history view, i.e. undo, rollback, etc.
1799 $rev: Revision object
1800 &$links: Array of HTML links
1801 $prevRev: Revision object, next in line in page history, or null
1802 $user: Current user object
1804 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1806 $context: An IContextSource object with information about the request being
1809 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1810 image insertion. You can skip the default logic entirely by returning false, or
1811 just modify a few things using call-by-reference.
1813 &$title: Title object of the image
1814 &$file: File object, or false if it doesn't exist
1815 &$frameParams: Various parameters with special meanings; see documentation in
1816 includes/Linker.php for Linker::makeImageLink
1817 &$handlerParams: Various parameters with special meanings; see documentation in
1818 includes/Linker.php for Linker::makeImageLink
1819 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1820 &$res: Final HTML output, used if you return false
1822 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1823 the image on an image page.
1824 &$imagePage: ImagePage object ($this)
1827 'ImagePageAfterImageLinks': Called after the image links section on an image
1829 $imagePage: ImagePage object ($this)
1830 &$html: HTML for the hook to add
1832 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1833 $imagePage: ImagePage object ($this)
1835 &$line: the HTML of the history line
1836 &$css: the line CSS class
1838 'ImagePageFindFile': Called when fetching the file associated with an image
1840 $page: ImagePage object
1842 &$displayFile: displayed File object
1844 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1845 $page: ImagePage object
1846 &$toc: Array of <li> strings
1848 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1850 &$title: the Title object of the file as it would appear for the upload page
1851 &$path: the original file and path name when img_auth was invoked by the web
1853 &$name: the name only component of the file
1854 &$result: The location to pass back results of the hook routine (only used if
1856 $result[0]=The index of the header message
1857 $result[1]=The index of the body text message
1858 $result[2 through n]=Parameters passed to body text message. Please note the
1859 header message cannot receive/use parameters.
1861 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1862 Return false to stop further processing of the tag
1863 $reader: XMLReader object
1864 $logInfo: Array of information
1866 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1867 Return false to stop further processing of the tag
1868 $reader: XMLReader object
1869 &$pageInfo: Array of information
1871 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1872 Return false to stop further processing of the tag
1873 $reader: XMLReader object
1874 $pageInfo: Array of page information
1875 $revisionInfo: Array of revision information
1877 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1878 Return false to stop further processing of the tag
1879 $reader: XMLReader object
1881 'ImportHandleUnknownUser': When a user doesn't exist locally, this hook is called
1882 to give extensions an opportunity to auto-create it. If the auto-creation is
1883 successful, return false.
1886 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1887 Return false to stop further processing of the tag
1888 $reader: XMLReader object
1889 $revisionInfo: Array of information
1891 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1892 and edit summaries for transwiki imports.
1893 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1894 &$pageTitle: String that contains page title.
1896 'ImportSources': Called when reading from the $wgImportSources configuration
1897 variable. Can be used to lazy-load the import sources list.
1898 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1899 comment in DefaultSettings.php for the detail of how to structure this array.
1901 'InfoAction': When building information to display on the action=info page.
1902 $context: IContextSource object
1903 &$pageInfo: Array of information
1905 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1906 &$title: Title object for the current page
1907 &$request: WebRequest
1908 &$ignoreRedirect: boolean to skip redirect check
1909 &$target: Title/string of redirect target
1910 &$article: Article object
1912 'InternalParseBeforeLinks': during Parser's internalParse method before links
1913 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1914 &$parser: Parser object
1915 &$text: string containing partially parsed text
1916 &$stripState: Parser's internal StripState object
1918 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1919 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1920 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1921 template/parser function execution which respect nowiki and HTML-comments.
1922 &$parser: Parser object
1923 &$text: string containing partially parsed text
1924 &$stripState: Parser's internal StripState object
1926 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1927 Return true without providing an interwiki to continue interwiki search.
1928 $prefix: interwiki prefix we are looking for.
1929 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1930 iw_trans and optionally iw_api and iw_wikiid.
1932 'InvalidateEmailComplete': Called after a user's email has been invalidated
1934 $user: user (object) whose email is being invalidated
1936 'IRCLineURL': When constructing the URL to use in an IRC notification.
1937 Callee may modify $url and $query, URL will be constructed as $url . $query
1938 &$url: URL to index.php
1939 &$query: Query string
1940 $rc: RecentChange object that triggered url generation
1942 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1943 &$article: article (object) being checked
1945 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1946 &$ip: IP being check
1947 &$result: Change this value to override the result of IP::isTrustedProxy()
1949 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1950 $url: URL used to upload from
1951 &$allowed: Boolean indicating if uploading is allowed for given URL
1953 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1954 instance to return false if the domain name doesn't match your organization.
1955 $addr: The e-mail address entered by the user
1956 &$result: Set this and return false to override the internal checks
1958 'isValidPassword': Override the result of User::isValidPassword()
1959 $password: The password entered by the user
1960 &$result: Set this and return false to override the internal checks
1961 $user: User the password is being validated for
1963 'Language::getMessagesFileName':
1964 $code: The language code or the language we're looking for a messages file for
1965 &$file: The messages file path, you can override this to change the location.
1967 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1968 $wgExtensionMessagesFiles instead.
1969 Use this to define synonyms of magic words depending of the language
1970 &$magicExtensions: associative array of magic words synonyms
1971 $lang: language code (string)
1973 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1974 remove namespaces. Do not use this hook to add namespaces. Use
1975 CanonicalNamespaces for that.
1976 &$namespaces: Array of namespaces indexed by their numbers
1978 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1979 listed in $wgExtensionMessagesFiles instead.
1980 Use to define aliases of special pages names depending of the language
1981 &$specialPageAliases: associative array of magic words synonyms
1982 $lang: language code (string)
1984 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1985 &$names: array of language code => language name
1986 $code: language of the preferred translations
1988 'LanguageLinks': Manipulate a page's language links. This is called
1989 in various places to allow extensions to define the effective language
1991 $title: The page's Title.
1992 &$links: Array with elements of the form "language:title" in the order
1993 that they will be output.
1994 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1995 Currently unused, but planned to provide support for marking individual
1996 language links in the UI, e.g. for featured articles.
1998 'LanguageSelector': Hook to change the language selector available on a page.
1999 $out: The output page.
2000 $cssClassName: CSS class name of the language selector.
2002 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
2003 Used when generating internal and interwiki links in
2004 Linker::link(), before processing starts. Return false to skip default
2005 processing and return $ret. See documentation for Linker::link() for details on
2006 the expected meanings of parameters.
2007 $skin: the Skin object
2008 $target: the Title that the link is pointing to
2009 &$html: the contents that the <a> tag should have (raw HTML); null means
2011 &$customAttribs: the HTML attributes that the <a> tag should have, in
2012 associative array form, with keys and values unescaped. Should be merged
2013 with default values, with a value of false meaning to suppress the
2015 &$query: the query string to add to the generated URL (the bit after the "?"),
2016 in associative array form, with keys and values unescaped.
2017 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
2018 &$ret: the value to return if your hook returns false.
2020 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
2021 Used when generating internal and interwiki links in Linker::link(),
2022 just before the function returns a value. If you return true, an <a> element
2023 with HTML attributes $attribs and contents $html will be returned. If you
2024 return false, $ret will be returned.
2025 $skin: the Skin object
2026 $target: the Title object that the link is pointing to
2027 $options: the options. Will always include either 'known' or 'broken', and may
2028 include 'noclasses'.
2029 &$html: the final (raw HTML) contents of the <a> tag, after processing.
2030 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2031 associative array form.
2032 &$ret: the value to return if your hook returns false.
2034 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
2036 &$url: the image url
2037 &$alt: the image's alt text
2038 &$img: the new image HTML (if returning false)
2040 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
2043 &$text: the link text
2044 &$link: the new link HTML (if returning false)
2045 &$attribs: the attributes to be applied.
2046 $linkType: The external link type
2048 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
2050 $title: the Title object that the link is pointing to
2051 $file: the File object or false if broken link
2052 &$html: the link text
2053 &$attribs: the attributes to be applied
2054 &$ret: the value to return if your hook returns false
2056 'LogEventsListLineEnding': Called before a Special:Log line is finished
2057 $page: the LogEventsList object
2058 &$ret: the HTML line
2059 $entry: the DatabaseLogEntry object for this row
2060 &$classes: the classes to add to the surrounding <li>
2061 &$attribs: associative array of other HTML attributes for the <li> element.
2062 Currently only data attributes reserved to MediaWiki are allowed
2063 (see Sanitizer::isReservedDataAttribute).
2066 'HtmlPageLinkRendererBegin':
2067 Used when generating internal and interwiki links in
2068 LinkRenderer, before processing starts. Return false to skip default
2069 processing and return $ret.
2070 $linkRenderer: the LinkRenderer object
2071 $target: the LinkTarget that the link is pointing to
2072 &$text: the contents that the <a> tag should have; either a plain, unescaped
2073 string or a HtmlArmor object; null means "default".
2074 &$customAttribs: the HTML attributes that the <a> tag should have, in
2075 associative array form, with keys and values unescaped. Should be merged
2076 with default values, with a value of false meaning to suppress the
2078 &$query: the query string to add to the generated URL (the bit after the "?"),
2079 in associative array form, with keys and values unescaped.
2080 &$ret: the value to return if your hook returns false.
2082 'HtmlPageLinkRendererEnd':
2083 Used when generating internal and interwiki links in LinkRenderer,
2084 just before the function returns a value. If you return true, an <a> element
2085 with HTML attributes $attribs and contents $html will be returned. If you
2086 return false, $ret will be returned.
2087 $linkRenderer: the LinkRenderer object
2088 $target: the LinkTarget object that the link is pointing to
2089 $isKnown: boolean indicating whether the page is known or not
2090 &$text: the contents that the <a> tag should have; either a plain, unescaped
2091 string or a HtmlArmor object.
2092 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2093 associative array form.
2094 &$ret: the value to return if your hook returns false.
2096 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2098 &$linksUpdate: the LinksUpdate object
2100 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2101 each link table insert. For example, pagelinks, imagelinks, externallinks.
2102 $linksUpdate: LinksUpdate object
2103 $table: the table to insert links to
2104 $insertions: an array of links to insert
2106 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2107 including delete and insert, has completed for all link tables
2108 &$linksUpdate: the LinksUpdate object
2109 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2111 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2112 &$linksUpdate: the LinksUpdate object
2114 'ListDefinedTags': When trying to find all defined tags.
2115 &$tags: The list of tags.
2117 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2118 $updater: A DatabaseUpdater subclass
2120 'LocalFile::getHistory': Called before file history query performed.
2121 &$file: the File object
2123 &$fields: select fields
2125 &$opts: query options
2126 &$join_conds: JOIN conditions
2128 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2129 $file: the File object
2130 $archiveName: name of an old file version or false if it's the current one
2132 'LocalisationCacheRecache': Called when loading the localisation data into
2134 $cache: The LocalisationCache object
2135 $code: language code
2136 &$alldata: The localisation data from core and extensions
2137 &$purgeBlobs: whether to purge/update the message blobs via
2138 MessageBlobStore::clear()
2140 'LocalisationCacheRecacheFallback': Called for each language when merging
2141 fallback data into the cache.
2142 $cache: The LocalisationCache object
2143 $code: language code
2144 &$alldata: The localisation data from core and extensions. Note some keys may
2145 be omitted if they won't be merged into the final result.
2147 'LocalisationChecksBlacklist': When fetching the blacklist of
2148 localisation checks.
2149 &$blacklist: array of checks to blacklist. See the bottom of
2150 maintenance/language/checkLanguage.inc for the format of this variable.
2152 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2153 optional localisation messages
2154 &$ignored: Array of ignored message keys
2155 &$optional: Array of optional message keys
2157 'LocalUserCreated': Called when a local user has been created
2158 $user: User object for the created user
2159 $autocreated: Boolean, whether this was an auto-creation
2161 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2162 Special:Log for a specific log type
2163 $type: String of log type being displayed
2164 $logEventsList: LogEventsList object for context and access to the WebRequest
2165 &$input: string HTML of an input element
2167 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2168 Returning false will prevent the string from being added to the OutputPage.
2169 &$s: html string to show for the log extract
2170 $types: String or Array Log types to show
2171 $page: String or Title The page title to show log entries for
2172 $user: String The user who made the log entries
2173 $param: Associative Array with the following additional options:
2174 - lim Integer Limit of items to show, default is 50
2175 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2176 - showIfEmpty boolean Set to false if you don't want any output in case the
2177 loglist is empty if set to true (default), "No matching items in log" is
2178 displayed if loglist is empty
2179 - msgKey Array If you want a nice box with a message, set this to the key of
2180 the message. First element is the message key, additional optional elements
2181 are parameters for the key that are processed with
2182 wfMessage()->params()->parseAsBlock()
2183 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2185 - wrap String Wrap the message in html (usually something like
2186 "<div ...>$1</div>").
2187 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2189 'LogException': Called before an exception (or PHP error) is logged. This is
2190 meant for integration with external error aggregation services; returning false
2191 will NOT prevent logging.
2192 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2193 $suppressed: true if the error was suppressed via
2194 error_reporting()/wfSuppressWarnings()
2196 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2197 error messages. Allows to add additional error messages (except messages already
2198 in LoginForm::$validErrorMessages).
2199 &$messages: Already added messages (inclusive messages from
2200 LoginForm::$validErrorMessages)
2202 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2203 Called during login to allow extensions the opportunity to inform a user that
2204 their username doesn't exist for a specific reason, instead of letting the
2205 login form give the generic error message that the account does not exist. For
2206 example, when the account has been renamed or deleted.
2207 $user: the User object being authenticated against.
2208 &$msg: the message identifier for abort reason, or an array to pass a message
2211 'LogLine': Processes a single log entry on Special:Log.
2212 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2213 logging.log_type database field.
2214 $log_action: string for the type of log action (e.g. 'delete', 'block',
2215 'create2'). Corresponds to logging.log_action database field.
2216 $title: Title object that corresponds to logging.log_namespace and
2217 logging.log_title database fields.
2218 $paramArray: Array of parameters that corresponds to logging.log_params field.
2219 Note that only $paramArray[0] appears to contain anything.
2220 &$comment: string that corresponds to logging.log_comment database field, and
2221 which is displayed in the UI.
2222 &$revert: string that is displayed in the UI, similar to $comment.
2223 $time: timestamp of the log entry (added in 1.12)
2225 'LonelyPagesQuery': Allow extensions to modify the query used by
2226 Special:LonelyPages.
2227 &$tables: tables to join in the query
2228 &$conds: conditions for the query
2229 &$joinConds: join conditions for the query
2231 'MagicWordwgVariableIDs': When defining new magic words IDs.
2232 &$variableIDs: array of strings
2234 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2236 $refreshLinks: RefreshLinks object
2238 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2239 Ideally, this hook should only be used to add variables that depend on
2240 the current page/request; static configuration should be added through
2241 ResourceLoaderGetConfigVars instead.
2242 &$vars: variable (or multiple variables) to be added into the output of
2243 Skin::makeVariablesScript
2244 $out: The OutputPage which called the hook, can be used to get the real title.
2246 'MarkPatrolled': Before an edit is marked patrolled.
2247 $rcid: ID of the revision to be marked patrolled
2248 &$user: the user (object) marking the revision as patrolled
2249 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2250 sysop in order to mark an edit patrolled.
2251 $auto: true if the edit is being marked as patrolled automatically
2253 'MarkPatrolledComplete': After an edit is marked patrolled.
2254 $rcid: ID of the revision marked as patrolled
2255 &$user: user (object) who marked the edit patrolled
2256 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2257 sysop to patrol the edit.
2258 $auto: true if the edit is being marked as patrolled automatically
2260 'ApiMaxLagInfo': When lag information is being requested via API. Use this to
2261 override lag information. Generally a hook function should only replace
2262 $lagInfo if the new $lagInfo['lag'] is greater than the current $lagInfo['lag'].
2263 &$lagInfo: Maximum lag information array. Fields in the array are:
2264 'lag' is the number of seconds of lag.
2265 'host' is the host name on which the lag exists.
2266 'type' is an indication of the type of lag,
2267 e.g. "db" for database replication lag or "jobqueue" for job queue size
2268 converted to pseudo-seconds.
2269 It is possible to add more fields and they will be returned to the user in
2272 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2273 something completely different, after the basic globals have been set up, but
2274 before ordinary actions take place.
2276 $article: Article on which the action will be performed
2277 $title: Title on which the action will be performed
2279 $request: $wgRequest
2280 $mediaWiki: The $mediawiki object
2282 'MediaWikiServices': Called when a global MediaWikiServices instance is
2283 initialized. Extensions may use this to define, replace, or wrap services.
2284 However, the preferred way to define a new service is
2285 the $wgServiceWiringFiles array.
2286 $services: MediaWikiServices
2288 'MessageCache::get': When fetching a message. Can be used to override the key
2289 for customisations. Given and returned message key must be in special format:
2290 1) first letter must be in lower case according to the content language.
2291 2) spaces must be replaced with underscores
2292 &$key: message key (string)
2294 'MessageCacheReplace': When a message page is changed. Useful for updating
2296 $title: name of the page changed.
2297 $text: new contents of the page.
2299 'MessagesPreLoad': When loading a message from the database.
2300 $title: title of the message (string)
2301 &$message: value (string), change it to the message you want to define
2302 $code: code (string) denoting the language to try.
2304 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2305 $mimeMagic: Instance of MimeMagic.
2306 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2307 &$tail: More or equal than last 65558 bytes of the file in a string
2308 (in - Do not alter!).
2310 &$mime: MIME type (out).
2312 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2313 MIME type detected by considering the file extension.
2314 $mimeMagic: Instance of MimeMagic.
2315 $ext: File extension.
2316 &$mime: MIME type (in/out).
2318 'MimeMagicInit': Before processing the list mapping MIME types to media types
2319 and the list mapping MIME types to file extensions.
2320 As an extension author, you are encouraged to submit patches to MediaWiki's
2321 core to add new MIME types to mime.types.
2322 $mimeMagic: Instance of MimeMagic.
2323 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2324 for adding new MIME info to the list.
2325 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2326 for adding new MIME types to the list.
2328 'ModifyExportQuery': Modify the query used by the exporter.
2329 $db: The database object to be queried.
2330 &$tables: Tables in the query.
2331 &$conds: Conditions in the query.
2332 &$opts: Options for the query.
2333 &$join_conds: Join conditions for the query.
2335 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2337 $oldTitle: Title object of the current (old) location
2338 $newTitle: Title object of the new location
2339 $user: User making the move
2340 $reason: string of the reason provided by the user
2341 $status: Status object to pass error messages to
2343 'MovePageIsValidMove': Specify whether a page can be moved for technical
2345 $oldTitle: Title object of the current (old) location
2346 $newTitle: Title object of the new location
2347 $status: Status object to pass error messages to
2349 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2351 $index: Integer; the index of the namespace being checked.
2352 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2353 namespace are movable. Hooks may change this value to override the return
2354 value of MWNamespace::isMovable().
2356 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2357 $title: the diff page title (nullable)
2358 &$oldId: the actual old Id to use in the diff
2359 &$newId: the actual new Id to use in the diff (0 means current)
2360 $old: the ?old= param value from the url
2361 $new: the ?new= param value from the url
2363 'NewPagesLineEnding': Called before a NewPages line is finished.
2364 $page: the SpecialNewPages object
2365 &$ret: the HTML line
2366 $row: the database row for this page (the recentchanges record and a few extras - see
2367 NewPagesPager::getQueryInfo)
2368 &$classes: the classes to add to the surrounding <li>
2369 &$attribs: associative array of other HTML attributes for the <li> element.
2370 Currently only data attributes reserved to MediaWiki are allowed
2371 (see Sanitizer::isReservedDataAttribute).
2373 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2375 $wikiPage: the WikiPage edited
2376 $rev: the new revision
2377 $baseID: the revision ID this was based off, if any
2378 $user: the editing user
2379 &$tags: tags to apply to the edit and recent change
2381 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2382 return false to omit the line from RecentChanges and Watchlist special pages.
2383 &$changeslist: The OldChangesList instance.
2384 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2385 $rc: The RecentChange object.
2386 &$classes: array of css classes for the <li> element.
2387 &$attribs: associative array of other HTML attributes for the <li> element.
2388 Currently only data attributes reserved to MediaWiki are allowed
2389 (see Sanitizer::isReservedDataAttribute).
2391 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2392 can alter or append to the array of URLs for search & suggestion formats.
2393 &$urls: array of associative arrays with Url element attributes
2395 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2396 when a page view triggers a re-rendering of the page. This may happen
2397 particularly if the parser cache is split by user language, and no cached
2398 rendering of the page exists in the user's language. The hook is called
2399 before checking whether page_links_updated indicates that the links are up
2400 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2401 without triggering any updates.
2402 $page: the Page that was rendered.
2403 $title: the Title of the rendered page.
2404 $parserOutput: ParserOutput resulting from rendering the page.
2406 'OtherAutoblockLogLink': Get links to the autoblock log from extensions which
2407 autoblocks users and/or IP addresses too.
2408 &$otherBlockLink: An array with links to other autoblock logs
2410 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2411 users and/or IP addresses too.
2412 &$otherBlockLink: An array with links to other block logs
2413 $ip: The requested IP address or username
2415 'OutputPageBeforeHTML': A page has been processed by the parser and the
2416 resulting HTML is about to be displayed.
2417 &$parserOutput: the parserOutput (object) that corresponds to the page
2418 &$text: the text that will be displayed, in HTML (string)
2420 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2421 body tag to allow for extensions to add attributes to the body of the page they
2422 might need. Or to allow building extensions to add body classes that aren't of
2423 high enough demand to be included in core.
2424 $out: The OutputPage which called the hook, can be used to get the real title
2425 $sk: The Skin that called OutputPage::headElement
2426 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2428 'OutputPageCheckLastModified': when checking if the page has been modified
2429 since the last visit.
2430 &$modifiedTimes: array of timestamps.
2431 The following keys are set: page, user, epoch
2432 $out: OutputPage object (since 1.28)
2434 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2435 categories. Implementations should return false if they generate the category
2436 links, so the default link generation is skipped.
2437 &$out: OutputPage instance (object)
2438 $categories: associative array, keys are category names, values are category
2439 types ("normal" or "hidden")
2440 &$links: array, intended to hold the result. Must be an associative array with
2441 category types as keys and arrays of HTML links as values.
2443 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2444 &$out: OutputPage instance (object)
2445 $parserOutput: parserOutput instance being added in $out
2447 'PageContentInsertComplete': After a new article is created.
2448 $wikiPage: WikiPage created
2449 $user: User creating the article
2450 $content: New content as a Content object
2451 $summary: Edit summary/comment
2452 $isMinor: Whether or not the edit was marked as minor
2453 $isWatch: (No longer used)
2454 $section: (No longer used)
2455 $flags: Flags passed to WikiPage::doEditContent()
2456 $revision: New Revision of the article
2458 'PageContentLanguage': Allows changing the language in which the content of a
2459 page is written. Defaults to the wiki content language ($wgContLang).
2460 $title: Title object
2461 &$pageLang: the page content language (either an object or a language code)
2462 $wgLang: the user language
2464 'PageContentSave': Before an article is saved.
2465 $wikiPage: the WikiPage (object) being saved
2466 $user: the user (object) saving the article
2467 $content: the new article content, as a Content object
2468 $summary: the article summary (comment)
2469 $isminor: minor flag
2470 $iswatch: watch flag
2473 'PageContentSaveComplete': After an article has been updated.
2474 $wikiPage: WikiPage modified
2475 $user: User performing the modification
2476 $content: New content, as a Content object
2477 $summary: Edit summary/comment
2478 $isMinor: Whether or not the edit was marked as minor
2479 $isWatch: (No longer used)
2480 $section: (No longer used)
2481 $flags: Flags passed to WikiPage::doEditContent()
2482 $revision: New Revision of the article (can be null for edits that change
2484 $status: Status object about to be returned by doEditContent()
2485 $baseRevId: the rev ID (or false) this edit was based on
2486 $undidRevId: the rev ID (or 0) this edit undid
2488 'PageHistoryBeforeList': When a history page list is about to be constructed.
2489 &$article: the article that the history is loading for
2490 $context: RequestContext object
2492 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2493 $historyAction: the action object
2494 &$row: the revision row for this line
2495 &$s: the string representing this parsed line
2496 &$classes: array containing the <li> element classes
2497 &$attribs: associative array of other HTML attributes for the <li> element.
2498 Currently only data attributes reserved to MediaWiki are allowed
2499 (see Sanitizer::isReservedDataAttribute).
2501 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2502 any output is generated, to allow batch lookups for prefetching information
2503 needed for display. If the hook handler returns false, the regular behavior of
2504 doBatchLookups() is skipped.
2505 $pager: the PageHistoryPager
2506 $result: a ResultWrapper representing the query result
2508 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2511 &$queryInfo: the query parameters
2513 'PageRenderingHash': NOTE: Consider using ParserOptionsRegister instead.
2514 Alter the parser cache option hash key. A parser extension
2515 which depends on user options should install this hook and append its values to
2517 &$confstr: reference to a hash key string which can be modified
2518 $user: User (object) requesting the page
2519 &$forOptions: array of options the hash is for
2521 'PageViewUpdates': Allow database (or other) changes to be made after a
2522 page view is seen by MediaWiki. Note this does not capture views made
2523 via external caches such as Squid.
2524 $wikipage: WikiPage (object) for the page being viewed.
2525 $user: User (object) for the user who is viewing.
2527 'ParserAfterParse': Called from Parser::parse() just after the call to
2528 Parser::internalParse() returns.
2529 &$parser: parser object
2530 &$text: text being parsed
2531 &$stripState: stripState used (object)
2533 'ParserAfterStrip': Called at end of parsing time.
2534 TODO: No more strip, deprecated ?
2535 &$parser: parser object
2536 &$text: text being parsed
2537 &$stripState: stripState used (object)
2539 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2540 &$parser: Parser object being used
2541 &$text: text that will be returned
2543 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2544 Parser::internalParseHalfParsed()
2545 &$parser: Parser object being used
2546 &$text: text that will be returned
2548 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2549 &$parser: Parser object
2550 &$text: text to parse
2551 &$stripState: StripState instance being used
2553 'ParserBeforeStrip': Called at start of parsing time.
2554 TODO: No more strip, deprecated ?
2555 &$parser: parser object
2556 &$text: text being parsed
2557 &$stripState: stripState used (object)
2559 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2560 &$parser: Parser object being used
2563 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2565 $parserCache: ParserCache object $parserOutput was stored in
2566 $parserOutput: ParserOutput object that was stored
2567 $title: Title of the page that was parsed to generate $parserOutput
2568 $popts: ParserOptions used for generating $parserOutput
2569 $revId: ID of the revision that was parsed to create $parserOutput
2571 'ParserClearState': Called at the end of Parser::clearState().
2572 &$parser: Parser object being cleared
2574 'ParserCloned': Called when the parser is cloned.
2575 $parser: Newly-cloned Parser object
2577 'ParserFetchTemplate': Called when the parser fetches a template
2578 $parser: Parser Parser object or false
2579 $title: Title object of the template to be fetched
2580 $rev: Revision object of the template
2581 &$text: Transclusion text of the template or false or null
2582 &$deps: Array of template dependencies with 'title', 'page_id', 'rev_id' keys
2584 'ParserFirstCallInit': Called when the parser initialises for the first time.
2585 &$parser: Parser object being cleared
2587 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2589 &$parser: Parser object
2590 &$varCache: array to store the value in case of multiples calls of the
2592 &$index: index (string) of the magic
2593 &$ret: value of the magic word (the hook should set it)
2594 &$frame: PPFrame object to use for expanding any template variables
2596 'ParserGetVariableValueTs': Use this to change the value of the time for the
2597 {{LOCAL...}} magic word.
2598 &$parser: Parser object
2599 &$time: actual time (timestamp)
2601 'ParserGetVariableValueVarCache': use this to change the value of the variable
2602 cache or return false to not use it.
2603 &$parser: Parser object
2604 &$varCache: variable cache (array)
2606 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2607 ParserLimitReportFormat instead.
2608 Called at the end of Parser:parse() when the parser will
2609 include comments about size of the text parsed.
2610 $parser: Parser object
2611 &$limitReport: text that will be included (without comment tags)
2613 'ParserLimitReportFormat': Called for each row in the parser limit report that
2614 needs formatting. If nothing handles this hook, the default is to use "$key" to
2615 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2617 $key: Key for the limit report item (string)
2618 &$value: Value of the limit report item
2619 &$report: String onto which to append the data
2620 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2621 text intended for display in a monospaced font.
2622 $localize: If false, $report should be output in English.
2624 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2625 will include comments about size of the text parsed. Hooks should use
2626 $output->setLimitReportData() to populate data. Functions for this hook should
2627 not use $wgLang; do that in ParserLimitReportFormat instead.
2628 $parser: Parser object
2629 $output: ParserOutput object
2631 'ParserMakeImageParams': Called before the parser make an image link, use this
2632 to modify the parameters of the image.
2633 $title: title object representing the file
2634 $file: file object that will be used to create the image
2635 &$params: 2-D array of parameters
2636 $parser: Parser object that called the hook
2638 'ParserOptionsRegister': Register additional parser options. Note that if you
2639 change the default value for an option, all existing parser cache entries will
2640 be invalid. To avoid bugs, you'll need to handle that somehow (e.g. with the
2641 RejectParserCacheValue hook) because MediaWiki won't do it for you.
2642 &$defaults: Set the default value for your option here.
2643 &$inCacheKey: To fragment the parser cache on your option, set a truthy value here.
2644 &$lazyLoad: To lazy-initialize your option, set it null in $defaults and set a
2645 callable here. The callable is passed the ParserOptions object and the option
2648 'ParserOutputPostCacheTransform': Called from ParserOutput::getText() to do
2649 post-cache transforms.
2650 $parserOutput: The ParserOutput object.
2651 &$text: The text being transformed, before core transformations are done.
2652 &$options: The options array being used for the transformation.
2654 'ParserSectionCreate': Called each time the parser creates a document section
2655 from wikitext. Use this to apply per-section modifications to HTML (like
2656 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2657 can begin in one section and end in another. Make sure your code can handle
2658 that case gracefully. See the EditSectionClearerLink extension for an example.
2659 $parser: the calling Parser instance
2660 $section: the section number, zero-based, but section 0 is usually empty
2661 &$sectionContent: ref to the content of the section. modify this.
2662 $showEditLinks: boolean describing whether this section has an edit link
2664 'ParserTestGlobals': Allows to define globals for parser tests.
2665 &$globals: Array with all the globals which should be set for parser tests.
2666 The arrays keys serve as the globals names, its values are the globals values.
2668 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2669 run. Use when page save hooks require the presence of custom tables to ensure
2670 that tests continue to run properly.
2671 &$tables: array of table names
2673 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2674 $page: the WikiPage of the candidate edit
2675 $content: the Content object of the candidate edit
2676 $output: the ParserOutput result of the candidate edit
2677 $summary: the change summary of the candidate edit
2678 $user: the User considering the edit
2680 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2681 $user: User object whose policy you are modifying
2682 &$effectivePolicy: Array of policy statements that apply to this user
2684 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2686 $block: Block object (which is set to be autoblocking)
2687 &$blockIds: Array of block IDs of the autoblock
2689 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2690 my talk page, my contributions" etc).
2691 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2692 &$title: Title object representing the current page
2693 $skin: SkinTemplate object providing context (e.g. to check if the user is
2696 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2697 &$user: User performing the action
2698 $action: Action being performed
2699 &$result: Whether or not the action should be prevented
2700 Change $result and return false to give a definitive answer, otherwise
2701 the built-in rate limiting checks are used, if enabled.
2702 $incrBy: Amount to increment counter by
2704 'PlaceNewSection': Override placement of new sections. Return false and put the
2705 merged text into $text to override the default behavior.
2706 $wikipage: WikiPage object
2707 $oldtext: the text of the article before editing
2708 $subject: subject of the new section
2709 &$text: text of the new section
2711 'PostLoginRedirect': Modify the post login redirect behavior.
2712 Occurs after signing up or logging in, allows for interception of redirect.
2713 &$returnTo: The page name to return to, as a string
2714 &$returnToQuery: array of url parameters, mapping parameter names to values
2715 &$type: type of login redirect as string;
2716 error: display a return to link ignoring $wgRedirectOnLogin
2717 signup: display a return to link using $wgRedirectOnLogin if needed
2718 success: display a return to link using $wgRedirectOnLogin if needed
2719 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2721 'PreferencesFormPreSave': Override preferences being saved
2722 $formData: array of user submitted data
2723 $form: HTMLForm object, also a ContextSource
2724 $user: User object with preferences to be saved set
2725 &$result: boolean indicating success
2726 $oldUserOptions: array with user old options (before save)
2728 'PreferencesGetLegend': Override the text used for the <legend> of a
2729 preferences section.
2730 $form: the HTMLForm object. This is a ContextSource as well
2731 $key: the section name
2732 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2735 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2736 Override the title prefix search used for OpenSearch and
2737 AJAX search suggestions. Put results into &$results outparam and return false.
2738 $ns: array of int namespace keys to search in
2739 $search: search term (not guaranteed to be conveniently normalized)
2740 $limit: maximum number of results to return
2741 &$results: out param: array of page names (strings)
2742 $offset: number of results to offset from the beginning
2744 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2745 namespace from the search string so that extensions can attempt it.
2746 &$namespaces: array of int namespace keys to search in (change this if you can
2748 &$search: search term (replace this with term without the namespace if you can
2751 'PrefsEmailAudit': Called when user changes their email address.
2752 $user: User (object) changing his email address
2753 $oldaddr: old email address (string)
2754 $newaddr: new email address (string)
2756 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2758 $article: the title being (un)protected
2759 &$output: a string of the form HTML so far
2761 'ProtectionForm::save': Called when a protection form is submitted.
2762 $article: the Page being (un)protected
2763 &$errorMsg: an html message string of an error or an array of message name and
2765 $reasonstr: a string describing the reason page protection level is altered
2767 'ProtectionForm::showLogExtract': Called after the protection log extract is
2769 $article: the page the form is shown for
2770 $out: OutputPage object
2772 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2774 &$tables: Database tables to be used in the query
2775 &$conds: Conditions to be applied in the query
2776 &$joinConds: Join conditions to be applied in the query
2778 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2779 &$obj: RawAction object
2780 &$text: The text that's going to be the output
2782 'RecentChange_save': Called at the end of RecentChange::save().
2783 &$recentChange: RecentChange object
2785 'RecentChangesPurgeRows': Called when old recentchanges rows are purged, after
2786 deleting those rows but within the same transaction.
2787 $rows: The deleted rows as an array of recentchanges row objects (with up to
2788 $wgUpdateRowsPerQuery items).
2790 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2791 names such as "oldid" that are preserved when using redirecting special pages
2792 such as Special:MyPage and Special:MyTalk.
2793 &$redirectParams: An array of parameters preserved by redirecting special pages.
2795 'RejectParserCacheValue': Return false to reject an otherwise usable
2796 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2797 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2799 $parserOutput: ParserOutput value.
2800 $wikiPage: WikiPage object.
2801 $parserOptions: ParserOptions object.
2803 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2804 instance. Can be used by an extension override what skin is used in certain
2806 $context: (IContextSource) The RequestContext the skin is being created for.
2807 &$skin: A variable reference you may set a Skin instance or string key on to
2808 override the skin that will be used for the context.
2810 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2811 flagged to lack same-origin security. Return false to indicate the lack. Note
2812 if the "somehow" involves HTTP headers, you'll probably need to make sure
2813 the header is varied on.
2814 $request: The WebRequest object.
2816 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2817 $user: The user having their password expiration reset
2818 &$newExpire: The new expiration date
2820 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2821 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2822 to override its behavior. See the module docs for more information.
2823 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2825 $context: ResourceLoaderContext|null
2827 'ResourceLoaderGetConfigVars': Called at the end of
2828 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2829 configuration variables to JavaScript. Things that depend on the current page
2830 or request state must be added through MakeGlobalVariablesScript instead.
2831 &$vars: array( variable name => value )
2833 'ResourceLoaderJqueryMsgModuleMagicWords': Called in
2834 ResourceLoaderJqueryMsgModule to allow adding magic words for jQueryMsg.
2835 The value should be a string, and they can depend only on the
2836 ResourceLoaderContext.
2837 $context: ResourceLoaderContext
2838 &$magicWords: Associative array mapping all-caps magic word to a string value
2840 'ResourceLoaderRegisterModules': Right before modules information is required,
2841 such as when responding to a resource
2842 loader request or generating HTML output.
2843 &$resourceLoader: ResourceLoader object
2845 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2846 called after the addition of 'qunit' and MediaWiki testing resources.
2847 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2848 included in core, is fed using tests/qunit/QUnitTestResources.php.
2849 To add a new qunit module named 'myext.tests':
2850 $testModules['qunit']['myext.tests'] = array(
2851 'script' => 'extension/myext/tests.js',
2852 'dependencies' => <any module dependency you might have>
2854 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2855 added to any module.
2856 &$ResourceLoader: object
2858 'RevisionRecordInserted': Called after a revision is inserted into the database.
2859 $revisionRecord: the RevisionRecord that has just been inserted.
2861 'RevisionInsertComplete': DEPRECATED! Use RevisionRecordInserted hook instead.
2862 Called after a revision is inserted into the database.
2863 $revision: the Revision
2864 $data: DEPRECATED! Always null!
2865 $flags: DEPRECATED! Always null!
2867 'SearchableNamespaces': An option to modify which namespaces are searchable.
2868 &$arr: Array of namespaces ($nsId => $name) which will be used.
2870 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2871 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2873 $term: Search term string
2874 &$title: Outparam; set to $title object and return false for a match
2876 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2877 if nothing was found.
2878 $term: Search term string
2879 &$title: Outparam; set to $title object and return false for a match
2881 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2882 the normal operations.
2883 $allSearchTerms: Array of the search terms in all content languages
2884 &$titleResult: Outparam; the value to return. A Title object or null.
2886 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2888 $term: Search term string
2889 &$title: Current Title object that is being returned (null if none found).
2891 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2893 $title: Current Title object being displayed in search results.
2894 &$id: Revision ID (default is false, for latest)
2896 'SearchIndexFields': Add fields to search index mapping.
2897 &$fields: Array of fields, all implement SearchIndexField
2898 $engine: SearchEngine instance for which mapping is being built.
2900 'SearchDataForIndex': Add data to search document. Allows to add any data to
2901 the field map used to index the document.
2902 &$fields: Array of name => value pairs for fields
2903 $handler: ContentHandler for the content being indexed
2904 $page: WikiPage that is being indexed
2905 $output: ParserOutput that is produced from the page
2906 $engine: SearchEngine for which the indexing is intended
2908 'SearchResultsAugment': Allows extension to add its code to the list of search
2910 &$setAugmentors: List of whole-set augmentor objects, must implement ResultSetAugmentor
2911 &$rowAugmentors: List of per-row augmentor objects, must implement ResultAugmentor.
2912 Note that lists should be in the format name => object and the names in both lists should
2915 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2916 perform when page content is modified. Currently called by
2917 AbstractContent::getSecondaryDataUpdates.
2918 $title: Title of the page that is being edited.
2919 $oldContent: Content object representing the page's content before the edit.
2920 $recursive: bool indicating whether DataUpdates should trigger recursive
2921 updates (relevant mostly for LinksUpdate).
2922 $parserOutput: ParserOutput representing the rendered version of the page
2924 &$updates: a list of DataUpdate objects, to be modified or replaced by
2927 'SecuritySensitiveOperationStatus': Affect the return value from
2928 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2929 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2930 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2931 authentication isn't possible for the current session type.
2932 $operation: (string) The operation being checked.
2933 $session: (MediaWiki\Session\Session) The current session. The
2934 currently-authenticated user may be retrieved as $session->getUser().
2935 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2936 the time of last auth is unknown, or -1 if authentication is not possible.
2938 'SelfLinkBegin': Called before a link to the current article is displayed to
2939 allow the display of the link to be customized.
2940 $nt: the Title object
2941 &$html: html to display for the link
2942 &$trail: optional text to display before $html
2943 &$prefix: optional text to display after $html
2944 &$ret: the value to return if your hook returns false
2946 'SendWatchlistEmailNotification': Return true to send watchlist email
2948 $targetUser: the user whom to send watchlist email notification
2949 $title: the page title
2950 $enotif: EmailNotification object
2952 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2953 loaded from storage. Return false to prevent it from being used.
2954 &$reason: String rejection reason to be logged
2955 $info: MediaWiki\Session\SessionInfo being validated
2956 $request: WebRequest being loaded from
2957 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2958 $data: Array|false Data array for the MediaWiki\Session\Session
2960 'SessionMetadata': Add metadata to a session being saved.
2961 $backend: MediaWiki\Session\SessionBackend being saved.
2962 &$metadata: Array Metadata to be stored. Add new keys here.
2963 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2964 request and 0+ FauxRequests.
2966 'SetupAfterCache': Called in Setup.php, after cache objects are set
2968 'ShortPagesQuery': Allow extensions to modify the query used by
2970 &$tables: tables to join in the query
2971 &$conds: conditions for the query
2972 &$joinConds: join conditions for the query
2973 &$options: options for the query
2975 'ShowMissingArticle': Called when generating the output for a non-existent page.
2976 $article: The article object corresponding to the page
2978 'ShowSearchHit': Customize display of search hit.
2979 $searchPage: The SpecialSearch instance.
2980 $result: The SearchResult to show
2981 $terms: Search terms, for highlighting
2982 &$link: HTML of link to the matching page. May be modified.
2983 &$redirect: HTML of redirect info. May be modified.
2984 &$section: HTML of matching section. May be modified.
2985 &$extract: HTML of content extract. May be modified.
2986 &$score: HTML of score. May be modified.
2987 &$size: HTML of page size. May be modified.
2988 &$date: HTML of of page modification date. May be modified.
2989 &$related: HTML of additional info for the matching page. May be modified.
2990 &$html: May be set to the full HTML that should be used to represent the search
2991 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2992 function returned false.
2994 'ShowSearchHitTitle': Customise display of search hit title/link.
2995 &$title: Title to link to
2996 &$titleSnippet: Label for the link representing the search result. Typically the article title.
2997 $result: The SearchResult object
2998 $terms: String of the search terms entered
2999 $specialSearch: The SpecialSearch object
3000 &$query: Array of query string parameters for the link representing the search result.
3001 &$attributes: Array of title link attributes, can be modified by extension.
3003 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
3004 Warning: This hook is run on each display. You should consider to use
3005 'SkinBuildSidebar' that is aggressively cached.
3007 &$bar: Sidebar content
3008 Modify $bar to add or modify sidebar portlets.
3010 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
3011 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
3012 the sitenotice/anonnotice.
3015 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
3016 allow the normal method of notice selection/rendering to work, or change the
3017 value of $siteNotice and return false to alter it.
3018 &$siteNotice: HTML returned as the sitenotice
3021 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
3023 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
3024 the stock bottom scripts.
3026 'SkinAfterContent': Allows extensions to add text after the page content and
3027 article metadata. This hook should work in all skins. Set the &$data variable to
3028 the text you're going to add.
3029 &$data: (string) Text to be printed out directly (without parsing)
3032 'SkinBuildSidebar': At the end of Skin::buildSidebar().
3034 &$bar: Sidebar contents
3035 Modify $bar to add or modify sidebar portlets.
3037 'SkinCopyrightFooter': Allow for site and per-namespace customization of
3039 $title: displayed page title
3040 $type: 'normal' or 'history' for old/diff views
3041 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
3042 message must be in HTML format, not wikitext!
3043 &$link: overridable HTML link to be passed into the message as $1
3044 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
3047 'SkinEditSectionLinks': Modify the section edit links
3048 $skin: Skin object rendering the UI
3049 $title: Title object for the title being linked to (may not be the same as
3050 the page title, if the section is included from a template)
3051 $section: The designation of the section being pointed to, to be included in
3052 the link, like "§ion=$section"
3053 $tooltip: The default tooltip. Escape before using.
3054 By default, this is wrapped in the 'editsectionhint' message.
3055 &$result: Array containing all link detail arrays. Each link detail array should
3056 contain the following keys:
3057 - targetTitle - Target Title object
3058 - text - String for the text
3059 - attribs - Array of attributes
3060 - query - Array of query parameters to add to the URL
3061 - options - Array of options for Linker::link
3062 $lang: The language code to use for the link in the wfMessage function
3064 'SkinGetPoweredBy': TODO
3065 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
3066 the MediaWiki icon but plain text instead.
3069 'SkinPreloadExistence': Supply titles that should be added to link existence
3070 cache before the page is rendered.
3071 &$titles: Array of Title objects
3074 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
3075 If false is returned $subpages will be used instead of the HTML
3076 subPageSubtitle() generates.
3077 If true is returned, $subpages will be ignored and the rest of
3078 subPageSubtitle() will run.
3079 &$subpages: Subpage links HTML
3081 $out: OutputPage object
3083 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
3085 &$sktemplate: SkinTemplate object
3086 &$nav_urls: array of tabs
3087 &$revid: The revision id of the permanent link
3088 &$revid2: The revision id of the permanent link, second time
3090 'SkinTemplateGetLanguageLink': After building the data for a language link from
3091 which the actual html is constructed.
3092 &$languageLink: array containing data about the link. The following keys can be
3093 modified: href, text, title, class, lang, hreflang. Each of them is a string.
3094 $languageLinkTitle: Title object belonging to the external language link.
3095 $title: Title object of the page the link belongs to.
3096 $outputPage: The OutputPage object the links are built from.
3098 'SkinTemplateNavigation': Called on content pages after the tabs have been
3099 added, but before variants have been added.
3100 &$sktemplate: SkinTemplate object
3101 &$links: Structured navigation links. This is used to alter the navigation for
3102 skins which use buildNavigationUrls such as Vector.
3104 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
3105 tab is added but before variants have been added.
3106 &$sktemplate: SkinTemplate object
3107 &$links: Structured navigation links. This is used to alter the navigation for
3108 skins which use buildNavigationUrls such as Vector.
3110 'SkinTemplateNavigation::Universal': Called on both content and special pages
3111 after variants have been added.
3112 &$sktemplate: SkinTemplate object
3113 &$links: Structured navigation links. This is used to alter the navigation for
3114 skins which use buildNavigationUrls such as Vector.
3116 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
3118 &$sktemplate: SkinTemplate object
3119 &$tpl: QuickTemplate engine object
3121 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
3122 &$sktemplate: SkinTemplate object
3123 &$res: set to true to prevent active tabs
3125 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
3126 You can either create your own array, or alter the parameters for
3128 &$sktemplate: The SkinTemplate instance.
3129 $title: Title instance for the page.
3130 $message: Visible label of tab.
3131 $selected: Whether this is a selected tab.
3132 $checkEdit: Whether or not the action=edit query should be added if appropriate.
3133 &$classes: Array of CSS classes to apply.
3134 &$query: Query string to add to link.
3136 &$result: Complete assoc. array if you want to return true.
3138 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
3139 been rendered (useful for adding more).
3140 &$sk: The QuickTemplate based skin template running the hook.
3141 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3142 extensions that add support for BaseTemplateToolbox should watch for this
3143 dummy parameter with "$dummy=false" in their code and return without echoing
3144 any HTML to avoid creating duplicate toolbox items.
3146 'SoftwareInfo': Called by Special:Version for returning information about the
3148 &$software: The array of software in format 'name' => 'version'. See
3149 SpecialVersion::softwareInformation().
3151 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3152 $sp: SpecialPage object, for context
3153 &$fields: Current HTMLForm fields
3155 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3156 $id: User id number, only provided for backwards-compatibility
3157 $user: User object representing user contributions are being fetched for
3158 $sp: SpecialPage instance, providing context
3160 'SpecialContributions::formatRow::flags': Called before rendering a
3161 Special:Contributions row.
3162 $context: IContextSource object
3163 $row: Revision information from the database
3164 &$flags: List of flags on this row
3166 'SpecialContributions::getForm::filters': Called with a list of filters to render
3167 on Special:Contributions.
3168 $sp: SpecialContributions object, for context
3169 &$filters: List of filters rendered as HTML
3171 'SpecialListusersDefaultQuery': Called right before the end of
3172 UsersPager::getDefaultQuery().
3173 $pager: The UsersPager instance
3174 &$query: The query array to be returned
3176 'SpecialListusersFormatRow': Called right before the end of
3177 UsersPager::formatRow().
3178 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
3179 $row: Database row object
3181 'SpecialListusersHeader': Called after adding the submit button in
3182 UsersPager::getPageHeader().
3183 $pager: The UsersPager instance
3184 &$out: The header HTML
3186 'SpecialListusersHeaderForm': Called before adding the submit button in
3187 UsersPager::getPageHeader().
3188 $pager: The UsersPager instance
3189 &$out: The header HTML
3191 'SpecialListusersQueryInfo': Called right before the end of.
3192 UsersPager::getQueryInfo()
3193 $pager: The UsersPager instance
3194 &$query: The query array to be returned
3196 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3197 $type: String of the log type
3198 $request: WebRequest object for getting the value provided by the current user
3199 &$qc: Array for query conditions to add
3201 'SpecialMovepageAfterMove': Called after moving a page.
3202 &$movePage: MovePageForm object
3203 &$oldTitle: old title (object)
3204 &$newTitle: new title (object)
3206 'SpecialNewpagesConditions': Called when building sql query for
3208 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3209 $opts: FormOptions object containing special page options
3210 &$conds: array of WHERE conditionals for query
3211 &$tables: array of tables to be queried
3212 &$fields: array of columns to select
3213 &$join_conds: join conditions for the tables
3215 'SpecialNewPagesFilters': Called after building form options at NewPages.
3216 $special: the special page object
3217 &$filters: associative array of filter definitions. The keys are the HTML
3218 name/URL parameters. Each key maps to an associative array with a 'msg'
3219 (message key) and a 'default' value.
3221 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3222 this hook to remove a core special page or conditionally register special pages.
3223 &$list: list (array) of core special pages
3225 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3226 $special: the SpecialPage object
3227 $subPage: the subpage string or null if no subpage was specified
3229 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3230 Return false to prevent execution.
3231 $special: the SpecialPage object
3232 $subPage: the subpage string or null if no subpage was specified
3234 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3235 $name: name of the special page
3236 &$form: HTMLForm object
3238 'SpecialPasswordResetOnSubmit': When executing a form submission on
3239 Special:PasswordReset.
3240 &$users: array of User objects.
3241 $data: array of data submitted by the user
3242 &$error: string, error code (message key) used to describe to error (out
3243 parameter). The hook needs to return false when setting this, otherwise it
3244 will have no effect.
3246 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3247 use this to change some selection criteria or substitute a different title.
3248 &$randstr: The random number from wfRandom()
3249 &$isRedir: Boolean, whether to select a redirect or non-redirect
3250 &$namespaces: An array of namespace indexes to get the title from
3251 &$extra: An array of extra SQL statements
3252 &$title: If the hook returns false, a Title object to use instead of the
3253 result from the normal query
3255 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageStructuredFilters
3257 Called after building form options at RecentChanges.
3258 $special: the special page object
3259 &$filters: associative array of filter definitions. The keys are the HTML
3260 name/URL parameters. Each key maps to an associative array with a 'msg'
3261 (message key) and a 'default' value.
3263 'SpecialRecentChangesPanel': Called when building form options in
3264 SpecialRecentChanges.
3265 &$extraOpts: array of added items, to which can be added
3266 $opts: FormOptions for this request
3268 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageStructuredFilters
3269 or ChangesListSpecialPageQuery instead.
3270 Called when building SQL query for SpecialRecentChanges and
3271 SpecialRecentChangesLinked.
3272 &$conds: array of WHERE conditionals for query
3273 &$tables: array of tables to be queried
3274 &$join_conds: join conditions for the tables
3275 $opts: FormOptions for this request
3276 &$query_options: array of options for the database request
3277 &$select: Array of columns to select
3279 'SpecialResetTokensTokens': Called when building token list for
3281 &$tokens: array of token information arrays in the format of
3283 'preference' => '<preference-name>',
3284 'label-message' => '<message-key>',
3287 'SpecialSearchCreateLink': Called when making the message to create a page or
3288 go to the existing page.
3289 $t: title object searched for
3290 &$params: an array of the default message name and page title (as parameter)
3292 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3293 canceled and a normal search will be performed. Returning true without setting
3294 $url does a standard redirect to $title. Setting $url redirects to the
3296 $term: The string the user searched for
3297 $title: The title the 'go' feature has decided to forward the user to
3298 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3300 'SpecialSearchNogomatch': Called when the 'Go' feature is triggered (generally
3301 from autocomplete search other than the main bar on Special:Search) and the
3302 target doesn't exist. Full text search results are generated after this hook is
3304 &$title: title object generated from the text entered by the user
3306 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3307 the advanced form, a.k.a. power search box.
3308 &$showSections: an array to add values with more options to
3309 $term: the search term (not a title object)
3310 $opts: an array of hidden options (containing 'redirs' and 'profile')
3312 'SpecialSearchProfileForm': Allows modification of search profile forms.
3313 $search: special page object
3314 &$form: String: form html
3315 $profile: String: current search profile
3316 $term: String: search term
3317 $opts: Array: key => value of hidden options for inclusion in custom forms
3319 'SpecialSearchProfiles': Allows modification of search profiles.
3320 &$profiles: profiles, which can be modified.
3322 'SpecialSearchResults': Called before search result display
3323 $term: string of search term
3324 &$titleMatches: empty or SearchResultSet object
3325 &$textMatches: empty or SearchResultSet object
3327 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3328 on the search results page. Useful for including an external search
3329 provider. To disable the output of MediaWiki search output, return
3331 $specialSearch: SpecialSearch object ($this)
3333 $term: Search term specified by the user
3335 'SpecialSearchResultsAppend': Called immediately before returning HTML
3336 on the search results page. Useful for including a feedback link.
3337 $specialSearch: SpecialSearch object ($this)
3339 $term: Search term specified by the user
3341 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3342 $search: SpecialSearch special page object
3343 $profile: String: current search profile
3344 $engine: the search engine
3346 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3347 &$extraStats: Array to save the new stats
3348 $extraStats['<name of statistic>'] => <value>;
3349 <value> can be an array with the keys "name" and "number":
3350 "name" is the HTML to be displayed in the name column
3351 "number" is the number to be displayed.
3352 or, <value> can be the number to be displayed and <name> is the
3353 message key to use in the name column,
3354 $context: IContextSource object
3356 'SpecialTrackingCategories::preprocess': Called after LinkBatch on Special:TrackingCategories
3357 $specialPage: The SpecialTrackingCategories object
3358 $trackingCategories: Array of data from Special:TrackingCategories with msg and cats
3360 'SpecialTrackingCategories::generateCatLink': Called for each cat link on Special:TrackingCategories
3361 $specialPage: The SpecialTrackingCategories object
3362 $catTitle: The Title object of the linked category
3363 &$html: The Result html
3365 'SpecialUploadComplete': Called after successfully uploading a file from
3367 &$form: The SpecialUpload object
3369 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3370 $wgVersion: Current $wgVersion for you to use
3371 &$versionUrl: Raw url to link to (eg: release notes)
3373 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageStructuredFilters
3375 Called after building form options at Watchlist.
3376 $special: the special page object
3377 &$filters: associative array of filter definitions. The keys are the HTML
3378 name/URL parameters. Each key maps to an associative array with a 'msg'
3379 (message key) and a 'default' value.
3381 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3382 SpecialWatchlist. Allows extensions to register custom values they have
3383 inserted to rc_type so they can be returned as part of the watchlist.
3384 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3386 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageStructuredFilters
3387 or ChangesListSpecialPageQuery instead.
3388 Called when building sql query for SpecialWatchlist.
3389 &$conds: array of WHERE conditionals for query
3390 &$tables: array of tables to be queried
3391 &$join_conds: join conditions for the tables
3392 &$fields: array of query fields
3393 $opts: A FormOptions object with watchlist options for the current request
3395 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3396 URL for a title when we have no other parameters on the URL. Gives a chance for
3397 extensions that alter page view behavior radically to abort that redirect or
3399 $request: WebRequest
3400 $title: Title of the currently found title obj
3401 $output: OutputPage object
3403 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3404 rendered (by ThumbnailImage:toHtml method).
3405 $thumbnail: the ThumbnailImage object
3406 &$attribs: image attribute array
3407 &$linkAttribs: image link attribute array
3409 'TitleArrayFromResult': Called when creating an TitleArray object from a
3411 &$titleArray: set this to an object to override the default object returned
3412 $res: database result used to create the object
3414 'TitleExists': Called when determining whether a page exists at a given title.
3415 $title: The title being tested.
3416 &$exists: Whether the title exists.
3418 'TitleGetEditNotices': Allows extensions to add edit notices
3419 $title: The Title object for the page the edit notices are for
3420 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3421 &$notices: Array of notices. Keys are i18n message keys, values are
3422 parseAsBlock()ed messages.
3424 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3425 that can be applied.
3426 $title: The title in question.
3427 &$types: The types of protection available.
3429 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3430 overriding default behavior for determining if a page exists. If $isKnown is
3431 kept as null, regular checks happen. If it's a boolean, this value is returned
3432 by the isKnown method.
3433 $title: Title object that is being checked
3434 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3436 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3437 that this hook is not called for interwiki pages or pages in immovable
3438 namespaces: for these, isMovable() always returns false.
3439 $title: Title object that is being checked
3440 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3441 Hooks may change this value to override the return value of
3445 'TitleMove': Before moving an article (title).
3448 $user: user who does the move
3450 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3453 $user: user who does the move
3455 'TitleMoveComplete': After moving an article (title), post-commit.
3458 &$user: user who did the move
3459 $pageid: database ID of the page that's been moved
3460 $redirid: database ID of the created redirect
3461 $reason: reason for the move
3462 $revision: the Revision created by the move
3464 'TitleMoveCompleting': After moving an article (title), pre-commit.
3467 $user: user who did the move
3468 $pageid: database ID of the page that's been moved
3469 $redirid: database ID of the created redirect
3470 $reason: reason for the move
3471 $revision: the Revision created by the move
3473 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3474 or override the quick permissions check.
3475 $title: The Title object being accessed
3476 $user: The User performing the action
3477 $action: Action being performed
3478 &$errors: Array of errors
3479 $doExpensiveQueries: Whether to do expensive DB queries
3480 $short: Whether to return immediately on first error
3482 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3483 adding the default error message if nothing allows the user to read the page. If
3484 a handler wants a title to *not* be whitelisted, it should also return false.
3485 $title: Title object being checked against
3486 $user: Current user object
3487 &$whitelisted: Boolean value of whether this title is whitelisted
3489 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3490 $title: Title object to purge
3491 &$urls: An array of URLs to purge from the caches, to be manipulated.
3493 'UnblockUser': Before an IP address or user is unblocked.
3494 &$block: The Block object about to be saved
3495 &$user: The user performing the unblock (not the one being unblocked)
3496 &$reason: If the hook is aborted, the error message to be returned in an array
3498 'UnblockUserComplete': After an IP address or user has been unblocked.
3499 $block: The Block object that was saved
3500 $user: The user who performed the unblock (not the one being unblocked)
3502 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3503 PageArchive object has been created but before any further processing is done.
3504 &$archive: PageArchive object
3505 $title: Title object of the page that we're viewing
3507 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3508 PageArchive object has been created but before any further processing is done.
3509 &$archive: PageArchive object
3510 $title: Title object of the page that we're viewing
3512 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3513 the site is not in read-only mode, that the Title object is not null and after
3514 a PageArchive object has been constructed but before performing any further
3516 &$archive: PageArchive object
3517 $title: Title object of the page that we're about to undelete
3519 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3520 $title: title object related to the revision
3521 $rev: revision (object) that will be viewed
3523 'UnitTestsAfterDatabaseSetup': Called right after MediaWiki's test infrastructure
3524 has finished creating/duplicating core tables for unit tests.
3525 $database: Database in question
3526 $prefix: Table prefix to be used in unit tests
3528 'UnitTestsBeforeDatabaseTeardown': Called right before MediaWiki tears down its
3529 database infrastructure used for unit tests.
3531 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3532 Since 1.24: Paths pointing to a directory will be recursively scanned for
3533 test case files matching the suffix "Test.php".
3534 &$paths: list of test cases and directories to search.
3536 'UnknownAction': DEPRECATED! To add an action in an extension,
3537 create a subclass of Action, and add a new key to $wgActions.
3538 An unknown "action" has occurred (useful for defining your own actions).
3539 $action: action name
3540 $article: article "acted on"
3542 'UnwatchArticle': Before a watch is removed from an article.
3543 &$user: user watching
3544 &$page: WikiPage object to be removed
3545 &$status: Status object to be returned if the hook returns false
3547 'UnwatchArticleComplete': After a watch is removed from an article.
3548 $user: user that watched
3549 &$page: WikiPage object that was watched
3551 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3552 &$formattedPageStatus: list of valid page states
3554 'UploadComplete': Upon completion of a file upload.
3555 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3556 $uploadBase->getLocalFile().
3558 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3559 $type: (string) the requested upload type
3560 &$className: the class name of the Upload instance to be created
3562 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3563 poke at member variables like $mUploadDescription before the file is saved. Do
3564 not use this hook to break upload processing. This will return the user to a
3565 blank form with no error message; use UploadVerification and UploadVerifyFile
3567 &$form: UploadForm object
3569 'UploadForm:getInitialPageText': After the initial page text for file uploads
3570 is generated, to allow it to be altered.
3571 &$pageText: the page text
3572 $msg: array of header messages
3573 $config: Config object
3575 'UploadForm:initial': Before the upload form is generated. You might set the
3576 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3577 text (HTML) either before or after the editform.
3578 &$form: UploadForm object
3580 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3582 &$descriptor: (array) the HTMLForm descriptor
3584 'UploadFormSourceDescriptors': after the standard source inputs have been
3585 added to the descriptor
3586 &$descriptor: (array) the HTMLForm descriptor
3587 &$radio: Boolean, if source type should be shown as radio button
3588 $selectedSourceType: The selected source type
3590 'UploadStashFile': Before a file is stashed (uploaded to stash).
3591 Note that code which has not been updated for MediaWiki 1.28 may not call this
3592 hook. If your extension absolutely, positively must prevent some files from
3593 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3594 $upload: (object) An instance of UploadBase, with all info about the upload
3595 $user: (object) An instance of User, the user uploading this file
3596 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3597 &$error: output: If the file stashing should be prevented, set this to the reason
3598 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3599 instance (you might want to use ApiMessage to provide machine-readable details
3602 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3603 Additional chances to reject an uploaded file.
3604 $saveName: (string) destination file name
3605 $tempName: (string) filesystem path to the temporary file for checks
3606 &$error: (string) output: message key for message to show if upload canceled by
3607 returning false. May also be an array, where the first element is the message
3608 key and the remaining elements are used as parameters to the message.
3610 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3611 in most cases over UploadVerification.
3612 $upload: (object) an instance of UploadBase, with all info about the upload
3613 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3614 Handlers will typically only apply for specific MIME types.
3615 &$error: (object) output: true if the file is valid. Otherwise, set this to the reason
3616 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3617 instance (you might want to use ApiMessage to provide machine-readable details
3620 'UploadVerifyUpload': Upload verification, based on both file properties like
3621 MIME type (same as UploadVerifyFile) and the information entered by the user
3622 (upload comment, file page contents etc.).
3623 $upload: (object) An instance of UploadBase, with all info about the upload
3624 $user: (object) An instance of User, the user uploading this file
3625 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3626 $comment: (string) Upload log comment (also used as edit summary)
3627 $pageText: (string) File description page text (only used for new uploads)
3628 &$error: output: If the file upload should be prevented, set this to the reason
3629 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3630 instance (you might want to use ApiMessage to provide machine-readable details
3633 'UserIsBot': when determining whether a user is a bot account
3635 &$isBot: whether this is user a bot or not (boolean)
3637 'User::mailPasswordInternal': before creation and mailing of a user's new
3639 &$user: the user who sent the message out
3640 &$ip: IP of the user who sent the message out
3641 &$u: the account whose new password will be set
3643 'UserAddGroup': Called when adding a group or changing a group's expiry; return
3644 false to override stock group addition.
3645 $user: the user object that is to have a group added
3646 &$group: the group to add; can be modified
3647 &$expiry: the expiry time in TS_MW format, or null if the group is not to
3648 expire; can be modified
3650 'UserArrayFromResult': Called when creating an UserArray object from a database
3652 &$userArray: set this to an object to override the default object returned
3653 $res: database result used to create the object
3655 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3656 want to display an error message, try getUserPermissionsErrors.
3657 &$title: Title object being checked against
3658 &$user: Current user object
3659 $action: Action being checked
3660 &$result: Pointer to result returned if hook returns false. If null is returned,
3661 userCan checks are continued by internal code.
3663 'UserCanSendEmail': To override User::canSendEmail() permission check.
3664 &$user: User (object) whose permission is being checked
3665 &$canSend: bool set on input, can override on output
3667 'UserClearNewTalkNotification': Called when clearing the "You have new
3668 messages!" message, return false to not delete it.
3669 &$user: User (object) that will clear the message
3670 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3672 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3673 Manipulate the login form.
3674 &$template: SimpleTemplate instance for the form
3676 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3677 &$user: User to get groups for
3678 &$groups: Current effective groups
3680 'UserGetAllRights': After calculating a list of all available rights.
3681 &$rights: Array of rights, which may be added to.
3683 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3684 before returning the options to the caller. Warning: This hook is called for
3685 every call to User::getDefaultOptions(), which means it's potentially called
3686 dozens or hundreds of times. You may want to cache the results of non-trivial
3687 operations in your hook function for this reason.
3688 &$defaultOptions: Array of preference keys and their default values.
3690 'UserGetEmail': Called when getting an user email address.
3692 &$email: email, change this to override local email
3694 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3695 email authentication.
3697 &$timestamp: timestamp, change this to override local email authentication
3700 'UserGetImplicitGroups': DEPRECATED!
3701 Called in User::getImplicitGroups().
3702 &$groups: List of implicit (automatically-assigned) groups
3704 'UserGetLanguageObject': Called when getting user's interface language object.
3706 &$code: Language code that will be used to create the object
3707 $context: IContextSource object
3709 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3710 &$reservedUsernames: $wgReservedUsernames
3712 'UserGetRights': Called in User::getRights().
3713 $user: User to get rights for
3714 &$rights: Current rights
3716 'UserGroupsChanged': Called after user groups are changed.
3717 $user: User whose groups changed
3718 $added: Groups added
3719 $removed: Groups removed
3720 $performer: User who performed the change, false if via autopromotion
3721 $reason: The reason, if any, given by the user performing the change,
3722 false if via autopromotion.
3723 $oldUGMs: An associative array (group name => UserGroupMembership object) of
3724 the user's group memberships before the change.
3725 $newUGMs: An associative array (group name => UserGroupMembership object) of
3726 the user's current group memberships.
3728 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3729 specific block exemptions).
3730 $user: User in question
3731 $title: Title of the page in question
3732 &$blocked: Out-param, whether or not the user is blocked from that page.
3733 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3734 to edit their own user talk pages.
3736 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3738 $ip: User's IP address
3739 &$blocked: Whether the user is blocked, to be modified by the hook
3740 &$block: The Block object, to be modified by the hook
3742 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3743 false if a UserGetRights hook might remove the named right.
3744 $right: The user right being checked
3746 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3747 $user: User in question.
3748 &$hidden: Set true if the user's name should be hidden.
3750 'UserIsLocked': Check if the user is locked. See User::isLocked().
3751 $user: User in question.
3752 &$locked: Set true if the user should be locked.
3754 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3755 environmental means; occurs after session is loaded.
3756 $user: user object being loaded
3758 'UserLoadDefaults': Called when loading a default user.
3762 'UserLoadFromDatabase': Called when loading a user from the database.
3764 &$s: database query object
3766 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3767 Called to authenticate users on external/environmental means; occurs before
3769 $user: user object being loaded
3770 &$result: set this to a boolean value to abort the normal authentication
3773 'UserLoadOptions': When user options/preferences are being loaded from the
3776 &$options: Options, can be modified.
3778 'UserLoggedIn': Called after a user is logged in
3779 $user: User object for the logged-in user
3781 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3782 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3783 &$user: the user object that was created on login
3784 &$inject_html: Any HTML to inject after the "logged in" message.
3785 $direct: (bool) The hook is called directly after a successful login. This will only happen once
3786 per login. A UserLoginComplete call with direct=false can happen when the user visits the login
3787 page while already logged in.
3789 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3790 Manipulate the login form.
3791 &$template: QuickTemplate instance for the form
3793 'UserLogout': Before a user logs out.
3794 &$user: the user object that is about to be logged out
3796 'UserLogoutComplete': After a user has logged out.
3797 &$user: the user object _after_ logout (won't have name, ID, etc.)
3798 &$inject_html: Any HTML to inject after the "logged out" message.
3799 $oldName: name of the user before logout (string)
3801 'UserMailerChangeReturnPath': Called to generate a VERP return address
3802 when UserMailer sends an email, with a bounce handling extension.
3803 $to: Array of MailAddress objects for the recipients
3804 &$returnPath: The return address string
3806 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3807 to split up an email with multiple the To: field into separate emails.
3808 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3810 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3811 Extensions can block sending the email by returning false and setting $error.
3812 $to: array of MailAdresses of the targets
3813 $from: MailAddress of the sender
3814 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3815 &$error: should be set to an error message string
3817 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3818 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3819 $to: array of MailAdresses of the targets
3820 $from: MailAddress of the sender
3821 &$subject: email subject (not MIME encoded)
3822 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3823 &$body: email body (in MIME format) as a string
3824 &$error: should be set to an error message string
3826 'UserRemoveGroup': Called when removing a group; return false to override stock
3828 $user: the user object that is to have a group removed
3829 &$group: the group to be removed, can be modified
3831 'UserRequiresHTTPS': Called to determine whether a user needs
3832 to be switched to HTTPS.
3833 $user: User in question.
3834 &$https: Boolean whether $user should be switched to HTTPS.
3836 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3837 have been requested to be reset. This hook can be used to exclude certain
3838 options from being reset even when the user has requested all prefs to be reset,
3839 because certain options might be stored in the user_properties database table
3840 despite not being visible and editable via Special:Preferences.
3841 $user: the User (object) whose preferences are being reset
3842 &$newOptions: array of new (site default) preferences
3843 $options: array of the user's old preferences
3844 $resetKinds: array containing the kinds of preferences to reset
3846 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3848 &$user: user retrieving new talks messages
3849 &$talks: array of new talks page(s)
3851 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3852 After a user's group memberships are changed.
3853 &$user: User object that was changed
3854 $add: Array of strings corresponding to groups added
3855 $remove: Array of strings corresponding to groups removed
3857 'UserSaveOptions': Called just before saving user preferences. Hook handlers can either add or
3858 manipulate options, or reset one back to it's default to block changing it. Hook handlers are also
3859 allowed to abort the process by returning false, e.g. to save to a global profile instead. Compare
3860 to the UserSaveSettings hook, which is called after the preferences have been saved.
3861 $user: The User for which the options are going to be saved
3862 &$options: The users options as an associative array, modifiable
3864 'UserSaveSettings': Called directly after user preferences (user_properties in the database) have
3865 been saved. Compare to the UserSaveOptions hook, which is called before.
3866 $user: The User for which the options have been saved
3868 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3869 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3870 instead. Otherwise, you can no longer count on user data being saved to cookies
3871 versus some other mechanism.
3872 Called when setting user cookies.
3874 &$session: session array, will be added to the session
3875 &$cookies: cookies array mapping cookie name to its value
3877 'UserSetEmail': Called when changing user email address.
3879 &$email: new email, change this to override new email address
3881 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3882 email authentication.
3884 &$timestamp: new timestamp, change this to override local email
3885 authentication timestamp
3887 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3888 "Foobar (Talk | Contribs | Block)".
3889 $userId: User id of the current user
3890 $userText: User name of the current user
3891 &$items: Array of user tool links as HTML fragments
3893 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3894 extensions providing user group data from an alternate source a chance to add
3895 their data into the cache array so that things like global user groups are
3896 displayed correctly in Special:ListUsers.
3897 $dbr: Read-only database handle
3898 $userIds: Array of user IDs whose groups we should look up
3899 &$cache: Array of user ID -> (array of internal group name (e.g. 'sysop') ->
3900 UserGroupMembership object)
3901 &$groups: Array of group name -> bool true mappings for members of a given user
3904 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3905 FormatMetadata::getExtendedMeta (return false means cache will be
3906 invalidated and GetExtendedMetadata hook called again).
3907 $timestamp: The timestamp metadata was generated
3908 $file: The file the metadata is for
3910 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3911 used to alter the SQL query which gets the list of wanted pages.
3912 &$wantedPages: WantedPagesPage object
3913 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3915 'WatchArticle': Before a watch is added to an article.
3916 &$user: user that will watch
3917 &$page: WikiPage object to be watched
3918 &$status: Status object to be returned if the hook returns false
3920 'WatchArticleComplete': After a watch is added to an article.
3921 &$user: user that watched
3922 &$page: WikiPage object watched
3924 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3925 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3926 $watchedItemQueryService: Service object
3928 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3929 form, used to manipulate the list of pages or preload data based on that list.
3930 &$watchlistInfo: array of watchlisted pages in
3931 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3933 'WatchlistEditorBuildRemoveLine': when building remove lines in
3934 Special:Watchlist/edit.
3935 &$tools: array of extra links
3936 $title: Title object
3937 $redirect: whether the page is a redirect
3939 &$link: HTML link to title
3941 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3943 $router: The PathRouter instance
3945 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3946 Return false to prevent setting of the cookie.
3947 &$name: Cookie name passed to WebResponse::setcookie()
3948 &$value: Cookie value passed to WebResponse::setcookie()
3949 &$expire: Cookie expiration, as for PHP's setcookie()
3950 &$options: Options passed to WebResponse::setcookie()
3952 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3953 run a MediaWiki cli script.
3954 &$script: MediaWiki cli script path
3955 &$parameters: Array of arguments and options to the script
3956 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3959 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3960 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3961 &$qp: The list of QueryPages
3963 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3964 $row: The DB row of the entry.
3965 $title: The Title of the page where the link comes FROM
3966 $target: The Title of the page where the link goes TO
3967 &$props: Array of HTML strings to display after the title.
3969 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3970 dumps. One, and only one hook should set this, and return false.
3971 &$tables: Database tables to use in the SELECT query
3972 &$opts: Options to use for the query
3973 &$join: Join conditions
3975 'WikiPageDeletionUpdates': manipulate the list of DeferrableUpdates to be applied when
3976 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3977 specific to a content model should be provided by the respective Content's
3978 getDeletionUpdates() method.
3980 $content: the Content to generate updates for, or null in case the page revision could not be
3981 loaded. The delete will succeed despite this.
3982 &$updates: the array of objects that implement DeferrableUpdate. Hook function may want to add to
3985 'WikiPageFactory': Override WikiPage class used for a title
3986 $title: Title of the page
3987 &$page: Variable to set the created WikiPage to.
3989 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3990 extra metadata to be added.
3991 $obj: The XmlDumpWriter object.
3992 &$out: The output string.
3993 $row: The database row for the page.
3994 $title: The title of the page.
3996 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3998 &$obj: The XmlDumpWriter object.
3999 &$out: The text being output.
4000 $row: The database row for the revision.
4001 $text: The revision text.
4003 More hooks might be available but undocumented, you can execute
4004 "php maintenance/findHooks.php" to find hidden ones.