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', [ &$article ] ) ) {
78 # code to actually show the article goes here
80 Hooks::run( 'ArticleShowComplete', [ &$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'][] = [ 'someFunction', $someData ];
141 $wgHooks['EventName'][] = [ 'someFunction' ]; # weird, but OK
143 $wgHooks['EventName'][] = $object; # object only
144 $wgHooks['EventName'][] = [ $object, 'someMethod' ];
145 $wgHooks['EventName'][] = [ $object, 'someMethod', $someData ];
146 $wgHooks['EventName'][] = [ $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'][] = [ 'ircNotify', 'TimStarling' ];
172 $wgHooks['PageContentSaveComplete'][] = [ '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'][] = [ '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 Note that hook parameters are passed in an array; this is a necessary
230 inconvenience to make it possible to pass reference values (which can be changed)
231 by the hook callback.
233 ==Events and parameters==
235 This is a list of known events and parameters; please add to it if you're going
236 to add events to the MediaWiki code.
238 'AbortAutoblock': Return false to cancel an autoblock.
239 $autoblockip: The IP going to be autoblocked.
240 &$block: The block from which the autoblock is coming.
242 'AbortDiffCache': Can be used to cancel the caching of a diff.
243 &$diffEngine: DifferenceEngine object
245 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
246 $editor: The User who made the change.
247 $title: The Title of the page that was edited.
248 $rc: The current RecentChange object.
250 'AbortTalkPageEmailNotification': Return false to cancel talk page email
252 $targetUser: the user whom to send talk page email notification
253 $title: the page title
255 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
256 $name: name of the action
257 &$form: HTMLForm object
258 $article: Article object
260 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
261 Allows to change the fields on the form that will be generated.
262 $name: name of the action
263 &$fields: HTMLForm descriptor array
264 $article: Article object
266 'AddNewAccount': DEPRECATED since 1.27! Use LocalUserCreated.
267 After a user account is created.
268 $user: the User object that was created. (Parameter added in 1.7)
269 $byEmail: true when account was created "by email" (added in 1.12)
271 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom,
272 rss,...) are created. Can be used to omit specific feeds from being outputted.
273 You must not use this hook to add feeds, use OutputPage::addFeedLink() instead.
274 &$feedLinks: Array of created feed links
276 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
277 before OutputPage::sendCacheControl() and final ob_end_flush() which
278 will send the buffered output to the client. This allows for last-minute
279 modification of the output within the buffer by using ob_get_clean().
280 $output: The OutputPage object where output() was called
282 'AfterImportPage': When a page import is completed.
283 $title: Title under which the revisions were imported
284 $foreignTitle: ForeignTitle object based on data provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of successfully imported revisions
287 $pageInfo: associative array of page information
289 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
290 just before adding its HTML to parser output.
291 $parser: Parser object that called the hook
292 $ig: Gallery, an object of one of the gallery classes (inheriting from
294 &$html: HTML generated by the gallery
296 'AlternateEdit': Before checking if a user can edit a page and before showing
297 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
298 $editPage: the EditPage object
300 'AlternateEditPreview': Before generating the preview of the page when editing
301 ( EditPage::getPreviewText() ).
302 Return false and set $previewHTML and $parserOutput to output custom page
304 $editPage: the EditPage object
305 &$content: the Content object for the text field from the edit page
306 &$previewHTML: Text to be placed into the page for the preview
307 &$parserOutput: the ParserOutput object for the preview
309 'AlternateUserMailer': Called before mail is sent so that mail could be logged
310 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
311 the regular method of sending mail. Return a string to return a php-mail-error
312 message containing the error. Returning true will continue with sending email
314 $headers: Associative array of headers for the email
315 $to: MailAddress object or array
317 $subject: Subject of the email
318 $body: Body of the message
320 'AncientPagesQuery': Allow extensions to modify the query used by
321 Special:AncientPages.
322 &$tables: tables to join in the query
323 &$conds: conditions for the query
324 &$joinConds: join conditions for the query
326 'APIAfterExecute': After calling the execute() method of an API module. Use
327 this to extend core API modules.
328 &$module: Module object
330 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
331 &$main: ApiMain object
333 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
334 authenticate and authorize API clients before executing the module. Return
335 false and set a message to cancel the request.
336 $module: Module object
338 &$message: API message to die with. Specific values accepted depend on the
340 * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
341 pass to ApiBase::dieWithError().
342 * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
343 * Earlier: A key or key+parameters in ApiBase::$messageMap.
345 'ApiDeprecationHelp': Add messages to the 'deprecation-help' warning generated
346 from ApiBase::addDeprecation().
347 &$msgs: Message[] Messages to include in the help. Multiple messages will be
350 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
351 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
352 this hook may cancel the hook to signal that the item is not viewable in the
354 $row: A row of data from ContribsPager. The set of data returned by
355 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
357 $context: An IContextSource implementation.
358 &$feedItem: Set this to a FeedItem instance if the callback can handle the
359 provided row. This is provided to the hook as a null, if it is non null then
360 another callback has already handled the hook.
362 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
363 highlighting, add output to $context->getOutput() and return false.
364 $context: An IContextSource.
365 $text: Text to be highlighted.
366 $mime: MIME type of $text.
367 $format: API format code for $text.
369 'APIGetAllowedParams': Use this hook to modify a module's parameters.
370 &$module: ApiBase Module object
371 &$params: Array of parameters
372 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
374 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
375 $module: ApiBase Module object
376 &$msg: Array of Message objects
378 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
380 $module: ApiBase Module object
381 &$msg: Array of arrays of Message objects
383 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
384 $module: ApiBase Module object
385 &$help: Array of HTML strings to be joined for the output.
386 $options: Array Options passed to ApiHelp::getHelp
387 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
388 the page and values as for Linker::generateTOC().
390 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
391 module manager. Can be used to conditionally register API modules.
392 $moduleManager: ApiModuleManager Module manager instance
394 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
395 an exception is thrown during API action execution.
396 $apiMain: Calling ApiMain instance.
397 $e: Exception object.
399 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
400 extensions to adjust the ParserOptions before parsing.
401 $options: ParserOptions object
402 $title: Title to be parsed
403 $params: Parameter array for the API module
404 $module: API module (which is also a ContextSource)
405 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
406 &$suppressCache: Set true if cache should be suppressed.
408 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
409 can alter or append to the array.
410 &$results: array with integer keys to associative arrays. Keys in associative
412 - title: Title object.
413 - redirect from: Title or null.
414 - extract: Description for this result.
415 - extract trimmed: If truthy, the extract will not be trimmed to
416 $wgOpenSearchDescriptionLength.
417 - image: Thumbnail for this result. Value is an array with subkeys 'source'
418 (url), 'width', 'height', 'alt', 'align'.
419 - url: Url for the given title.
421 'ApiOptions': Called by action=options before applying changes to user
423 $apiModule: Calling ApiOptions object
424 $user: User object whose preferences are being changed
425 $changes: Associative array of preference name => value
426 $resetKinds: Array of strings specifying which options kinds to reset.
427 See User::resetOptions() and User::getOptionKinds() for possible
430 'ApiParseMakeOutputPage': Called when preparing the OutputPage object for
431 ApiParse. This is mainly intended for calling OutputPage::addContentOverride()
432 or OutputPage::addContentOverrideCallback().
433 $module: ApiBase (which is also a ContextSource)
436 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
437 module manager. Can be used to conditionally register API query modules.
438 $moduleManager: ApiModuleManager Module manager instance
440 'APIQueryAfterExecute': After calling the execute() method of an
441 action=query submodule. Use this to extend core API modules.
442 &$module: Module object
444 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
445 database query has returned. An API query module wanting to use this hook
446 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
448 $module: ApiQueryBase module in question
449 $result: ResultWrapper|bool returned from the IDatabase::select()
450 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
451 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
454 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
455 database query is made. WARNING: It would be very easy to misuse this hook and
456 break the module! Any joins added *must* join on a unique key of the target
457 table unless you really know what you're doing. An API query module wanting to
458 use this hook should see the ApiQueryBase::select() and
459 ApiQueryBase::processRow() documentation.
460 $module: ApiQueryBase module in question
461 &$tables: array of tables to be queried
462 &$fields: array of columns to select
463 &$conds: array of WHERE conditionals for query
464 &$query_options: array of options for the database request
465 &$join_conds: join conditions for the tables
466 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
467 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
469 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
470 the database result is processed. Return false to stop processing the result
471 set. An API query module wanting to use this hook should see the
472 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
473 $module: ApiQueryBase module in question
474 $row: stdClass Database result row
475 &$data: array to be included in the ApiResult.
476 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
477 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
479 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
480 an action=query submodule. Use this to extend core API modules.
481 &$module: Module object
482 &$resultPageSet: ApiPageSet object
484 'APIQueryInfoTokens': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes
485 instead. Use this hook to add custom tokens to prop=info. Every token has an
486 action, which will be used in the intoken parameter and in the output
487 (actiontoken="..."), and a callback function which should return the token, or
488 false if the user isn't allowed to obtain it. The prototype of the callback
489 function is func($pageid, $title), where $pageid is the page ID of the page the
490 token is requested for and $title is the associated Title object. In the hook,
491 just add your callback to the $tokenFunctions array and return true (returning
492 false makes no sense).
493 &$tokenFunctions: [ action => callback ]
495 'APIQueryRecentChangesTokens': DEPRECATED since 1.24! Use
496 ApiQueryTokensRegisterTypes instead.
497 Use this hook to add custom tokens to list=recentchanges. Every token has an
498 action, which will be used in the rctoken parameter and in the output
499 (actiontoken="..."), and a callback function which should return the token, or
500 false if the user isn't allowed to obtain it. The prototype of the callback
501 function is func($pageid, $title, $rc), where $pageid is the page ID of the
502 page associated to the revision the token is requested for, $title the
503 associated Title object and $rc the associated RecentChange object. In the
504 hook, just add your callback to the $tokenFunctions array and return true
505 (returning false makes no sense).
506 &$tokenFunctions: [ action => callback ]
508 'APIQueryRevisionsTokens': DEPRECATED since 1.24! Use
509 ApiQueryTokensRegisterTypes instead.
510 Use this hook to add custom tokens to prop=revisions. Every token has an
511 action, which will be used in the rvtoken parameter and in the output
512 (actiontoken="..."), and a callback function which should return the token, or
513 false if the user isn't allowed to obtain it. The prototype of the callback
514 function is func($pageid, $title, $rev), where $pageid is the page ID of the
515 page associated to the revision the token is requested for, $title the
516 associated Title object and $rev the associated Revision object. In the hook,
517 just add your callback to the $tokenFunctions array and return true (returning
518 false makes no sense).
519 &$tokenFunctions: [ action => callback ]
521 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
522 sites general information.
523 $module: the current ApiQuerySiteInfo module
524 &$results: array of results, add things here
526 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
527 sites statistics information.
528 &$results: array of results, add things here
530 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
531 action=query&meta=tokens. Note that most modules will probably be able to use
532 the 'csrf' token instead of creating their own token types.
533 &$salts: [ type => salt to pass to User::getEditToken(), or array of salt
534 and key to pass to Session::getToken() ]
536 'APIQueryUsersTokens': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes
538 Use this hook to add custom token to list=users. Every token has an action,
539 which will be used in the ustoken parameter and in the output
540 (actiontoken="..."), and a callback function which should return the token, or
541 false if the user isn't allowed to obtain it. The prototype of the callback
542 function is func($user) where $user is the User object. In the hook, just add
543 your callback to the $tokenFunctions array and return true (returning false
545 &$tokenFunctions: [ action => callback ]
547 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
548 $module: ApiQueryWatchlist instance
549 $watchedItem: WatchedItem instance
550 $recentChangeInfo: Array of recent change info data
551 &$vals: Associative array of data to be output for the row
553 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
554 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
555 $module: ApiQueryWatchlist instance
556 $params: Array of parameters, as would be returned by $module->extractRequestParams()
557 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
559 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
560 should have its own entry in the $apis array and have a unique name, passed as
561 key for the array that represents the service data. In this data array, the
562 key-value-pair identified by the apiLink key is required.
563 &$apis: array of services
565 'ApiTokensGetTokenTypes': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes instead.
566 Use this hook to extend action=tokens with new token types.
567 &$tokenTypes: supported token types in format 'type' => callback function
568 used to retrieve this type of tokens.
570 'ApiValidatePassword': Called from ApiValidatePassword.
571 $module: ApiValidatePassword instance.
574 'Article::MissingArticleConditions': Before fetching deletion & move log entries
575 to display a message of a non-existing page being deleted/moved, give extensions
576 a chance to hide their (unrelated) log entries.
577 &$conds: Array of query conditions (all of which have to be met; conditions will
578 AND in the final query)
579 $logTypes: Array of log types being queried
581 'ArticleAfterFetchContentObject': DEPRECATED since 1.32, use ArticleRevisionViewCustom
582 to control output. After fetching content of an article from the database.
583 &$article: the article (object) being loaded from the database
584 &$content: the content of the article, as a Content object
586 'ArticleConfirmDelete': Before writing the confirmation form for article
588 $article: the article (object) being deleted
589 $output: the OutputPage object
590 &$reason: the reason (string) the article is being deleted
592 'ArticleContentOnDiff': Before showing the article content below a diff. Use
593 this to change the content in this area or how it is loaded.
594 $diffEngine: the DifferenceEngine
595 $output: the OutputPage object
597 'ArticleRevisionViewCustom': Allows custom rendering of an article's content.
598 Note that it is preferable to implement proper handing for a custom data type using
599 the ContentHandler facility.
600 $revision: content of the page, as a RevisionRecord object, or null if the revision
601 could not be loaded. May also be a fake that wraps content supplied by an extension.
602 $title: title of the page
603 $oldid: the requested revision id, or 0 for the currrent revision.
604 $output: a ParserOutput object
606 'ArticleContentViewCustom': DEPRECATED since 1.32, use ArticleRevisionViewCustom instead,
607 or provide an appropriate ContentHandler. Allows to output the text of the article in a
608 different format than wikitext.
609 $content: content of the page, as a Content object
610 $title: title of the page
611 $output: a ParserOutput object
613 'ArticleDelete': Before an article is deleted.
614 &$wikiPage: the WikiPage (object) being deleted
615 &$user: the user (object) deleting the article
616 &$reason: the reason (string) the article is being deleted
617 &$error: if the deletion was prohibited, the (raw HTML) error message to display
619 &$status: Status object, modify this to throw an error. Overridden by $error
621 $suppress: Whether this is a suppression deletion or not (added in 1.27)
623 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
624 $title: Title of the article that has been deleted.
625 $outputPage: OutputPage that can be used to append the output.
627 'ArticleDeleteComplete': After an article is deleted.
628 &$wikiPage: the WikiPage that was deleted
629 &$user: the user that deleted the article
630 $reason: the reason the article was deleted
631 $id: id of the article that was deleted
632 $content: the Content of the deleted page (or null, when deleting a broken page)
633 $logEntry: the ManualLogEntry used to record the deletion
634 $archivedRevisionCount: the number of revisions archived during the deletion
636 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
638 &$wikiPage: WikiPage (object) of the user talk page
639 $recipient: User (object) who's talk page was edited
641 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
642 article has been changed.
643 &$wikiPage: the WikiPage (object)
644 &$editInfo: data holder that includes the parser output ($editInfo->output) for
645 that page after the change
646 $changed: bool for if the page was changed
648 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
649 recentchanges table, return false to not delete old entries.
650 &$wikiPage: WikiPage (object) being modified
652 'ArticleFromTitle': when creating an article object from a title object using
653 Wiki::articleFromTitle().
654 &$title: Title (object) used to create the article object
655 &$article: Article (object) that will be returned
656 $context: IContextSource (object)
658 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
659 $targetTitle: target title (object)
660 $destTitle: destination title (object)
662 'ArticlePageDataAfter': After loading data of an article from the database.
663 &$wikiPage: WikiPage (object) whose data were loaded
664 &$row: row (object) returned from the database server
666 'ArticlePageDataBefore': Before loading data of an article from the database.
667 &$wikiPage: WikiPage (object) that data will be loaded
668 &$fields: fields (array) to load from the database
669 &$tables: tables (array) to load from the database
670 &$joinConds: join conditions (array) to load from the database
672 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
673 $wikiPage: the WikiPage being saved
674 $popts: parser options to be used for pre-save transformation
676 'ArticleProtect': Before an article is protected.
677 &$wikiPage: the WikiPage being protected
678 &$user: the user doing the protection
679 $protect: Set of restriction keys
680 $reason: Reason for protect
682 'ArticleProtectComplete': After an article is protected.
683 &$wikiPage: the WikiPage that was protected
684 &$user: the user who did the protection
685 $protect: Set of restriction keys
686 $reason: Reason for protect
688 'ArticlePurge': Before executing "&action=purge".
689 &$wikiPage: WikiPage (object) to purge
691 'ArticleRevisionUndeleted': After an article revision is restored.
692 &$title: the article title
693 $revision: the revision
694 $oldPageID: the page ID of the revision when archived (may be null)
696 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
697 revisions of an article.
698 $title: Title object of the article
699 $ids: Ids to set the visibility for
700 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
701 examined to determine exactly what visibility bits have changed for each
702 revision. This array is of the form
703 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
705 'ArticleRollbackComplete': After an article rollback is completed.
706 $wikiPage: the WikiPage that was edited
707 $user: the user who did the rollback
708 $revision: the revision the page was reverted back to
709 $current: the reverted revision
711 'ArticleShowPatrolFooter': Called at the beginning of Article#showPatrolFooter.
712 Extensions can use this to not show the [mark as patrolled] link in certain
714 $article: the Article object
716 'ArticleUndelete': When one or more revisions of an article are restored.
717 &$title: Title corresponding to the article restored
718 $create: Whether or not the restoration caused the page to be created (i.e. it
719 didn't exist before).
720 $comment: The comment associated with the undeletion.
721 $oldPageId: ID of page previously deleted (from archive table). This ID will be used
722 for the restored page.
723 $restoredPages: Set of page IDs that have revisions restored for this undelete,
724 with keys being page IDs and values are 'true'.
726 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
727 $pageArchive: the PageArchive object
728 &$logEntry: ManualLogEntry object
729 $user: User who is performing the log action
731 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
732 the user is redirected back to the page.
733 $article: the article
734 &$sectionanchor: The section anchor link (e.g. "#overview" )
735 &$extraq: Extra query parameters which can be added via hooked functions
737 'ArticleViewFooter': After showing the footer section of an ordinary page view
738 $article: Article object
739 $patrolFooterShown: boolean whether patrol footer is shown
741 'ArticleViewHeader': Control article output. Called before the parser cache is about
742 to be tried for article viewing.
743 &$article: the article
744 &$pcache: whether to try the parser cache or not
745 &$outputDone: whether the output for this page finished or not. Set to
746 a ParserOutput object to both indicate that the output is done and what
747 parser output was used.
749 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
750 redirect was followed.
751 &$article: target article (object)
753 'AuthChangeFormFields': After converting a field information array obtained
754 from a set of AuthenticationRequest classes into a form descriptor; hooks
755 can tweak the array to change how login etc. forms should look.
756 $requests: array of AuthenticationRequests the fields are created from
757 $fieldInfo: field information array (union of all
758 AuthenticationRequest::getFieldInfo() responses).
759 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
760 to change the order of the fields.
761 $action: one of the AuthManager::ACTION_* constants.
763 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
764 for a reason other than misconfiguration or session loss. No return data is
765 accepted; this hook is for auditing only.
766 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL
768 $user: The User object being authenticated against, or null if authentication
769 failed before getting that far.
770 $username: A guess at the user name being authenticated, or null if we can't
771 even determine that. When $user is not null, it can be in the form of
772 <username>@<more info> (e.g. for bot passwords).
773 $extraData: An array (string => string) with extra information, intended to be
774 added to log contexts. Fields it might include:
775 - appId: the application ID, only if the login was with a bot password
777 'AutopromoteCondition': Check autopromote condition for user.
778 $type: condition type
781 &$result: result of checking autopromote condition
783 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
784 certain title are fetched.
786 $title: title of the page to which backlinks are sought
787 &$conds: query conditions
789 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
793 'BadImage': When checking against the bad image list. Change $bad and return
794 false to override. If an image is "bad", it is not rendered inline in wiki
795 pages or galleries in category pages.
796 $name: Image name being checked
797 &$bad: Whether or not the image is "bad"
799 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
800 custom HTML after the section. Any uses of the hook need to handle escaping.
801 $template: BaseTemplate
802 $portlet: string portlet name
805 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
806 and returning it for the skin to output. You can add items to the toolbox while
807 still letting the skin make final decisions on skin-specific markup conventions
809 &$sk: The BaseTemplate base skin template
810 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
811 BaseTemplate::makeListItem for details on the format of individual items
812 inside of this array.
814 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
815 "noarticletext-nopermission" at Article::showMissingArticle().
816 $article: article object
818 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
819 override how the redirect is output by modifying, or by returning false, and
820 letting standard HTTP rendering take place.
821 ATTENTION: This hook is likely to be removed soon due to overall design of the
823 $context: IContextSource object
824 &$redirect: string URL, modifiable
826 'BeforeInitialize': Before anything is initialized in
827 MediaWiki::performRequest().
828 &$title: Title being used for request
830 &$output: OutputPage object
832 $request: WebRequest object
833 $mediaWiki: Mediawiki object
835 'BeforePageDisplay': Prior to outputting a page.
836 &$out: OutputPage object
839 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
840 override how the redirect is output by modifying, or by returning false and
841 taking over the output.
842 $out: OutputPage object
843 &$redirect: URL, modifiable
844 &$code: HTTP code (eg '301' or '302'), modifiable
846 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
847 $parser: Parser object
849 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
850 as a key then the file will appear as a broken thumbnail.
851 &$descQuery: query string to add to thumbnail URL
853 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
854 $parser: Parser object
855 $title: title of the template
856 &$skip: skip this template and link it?
857 &$id: the id of the revision being parsed
859 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
860 &$parser: Parser object
861 &$ig: ImageGallery object
863 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
865 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
866 to a newly created user account.
867 &$injected_html: Any HTML to inject after the "logged in" message of a newly
870 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
871 normalizations have been performed, except for the $wgMaxImageArea check.
873 &$params: Array of parameters
874 &$checkImageAreaHookResult: null, set to true or false to override the
875 $wgMaxImageArea check result.
877 'BitmapHandlerTransform': before a file is transformed, gives extension the
878 possibility to transform it themselves
879 $handler: BitmapHandler
881 &$scalerParams: Array with scaler parameters
882 &$mto: null, set to a MediaTransformOutput
884 'BlockIp': Before an IP address or user is blocked.
885 &$block: the Block object about to be saved
886 &$user: the user _doing_ the block (not the one being blocked)
887 &$reason: if the hook is aborted, the error message to be returned in an array
889 'BlockIpComplete': After an IP address or user is blocked.
890 $block: the Block object that was saved
891 $user: the user who did the block (not the one being blocked)
892 $priorBlock: the Block object for the prior block or null if there was none
894 'BookInformation': Before information output on Special:Booksources.
895 $isbn: ISBN to show information for
896 $output: OutputPage object in use
898 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
899 to be able to access the wiki via HTTPS.
900 $ip: The IP address in human-readable form
901 &$canDo: This reference should be set to false if the client may not be able
904 'CanonicalNamespaces': For extensions adding their own namespaces or altering
906 Note that if you need to specify namespace protection or content model for
907 a namespace that is added in a CanonicalNamespaces hook handler, you
908 should do so by altering $wgNamespaceProtection and
909 $wgNamespaceContentModels outside the handler, in top-level scope. The
910 point at which the CanonicalNamespaces hook fires is too late for altering
911 these variables. This applies even if the namespace addition is
912 conditional; it is permissible to declare a content model and protection
913 for a namespace and then decline to actually register it.
914 &$namespaces: Array of namespace numbers with corresponding canonical names
916 'CategoryAfterPageAdded': After a page is added to a category.
917 $category: Category that page was added to
918 $wikiPage: WikiPage that was added
920 'CategoryAfterPageRemoved': After a page is removed from a category.
921 $category: Category that page was removed from
922 $wikiPage: WikiPage that was removed
923 $id: the page ID (original ID in case of page deletions)
925 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
926 &$catpage: CategoryPage instance
928 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
929 in a Category page. Gives extensions the opportunity to batch load any
930 related data about the pages.
931 $type: The category type. Either 'page', 'file' or 'subcat'
932 $res: Query result from Wikimedia\Rdbms\IDatabase::select()
934 'CategoryViewer::generateLink': Before generating an output link allow
935 extensions opportunity to generate a more specific or relevant link.
936 $type: The category type. Either 'page', 'img' or 'subcat'
937 $title: Title object for the categorized page
938 $html: Requested html content of anchor
939 &$link: Returned value. When set to a non-null value by a hook subscriber
940 this value will be used as the anchor instead of Linker::link
942 'ChangeAuthenticationDataAudit': Called when user changes his password.
943 No return data is accepted; this hook is for auditing only.
944 $req: AuthenticationRequest object describing the change (and target user)
945 $status: StatusValue with the result of the action
947 'ChangesListInitRows': Batch process change list rows prior to rendering.
948 $changesList: ChangesList instance
949 $rows: The data that will be rendered. May be a \Wikimedia\Rdbms\IResultWrapper
950 instance or an array.
952 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
953 &$changesList: ChangesList instance.
954 &$articlelink: HTML of link to article (already filled-in).
955 &$s: HTML of row that is being constructed.
956 &$rc: RecentChange instance.
957 $unpatrolled: Whether or not we are showing unpatrolled changes.
958 $watched: Whether or not the change is watched by the user.
960 'ChangesListSpecialPageQuery': Called when building SQL query on pages
961 inheriting from ChangesListSpecialPage (in core: RecentChanges,
962 RecentChangesLinked and Watchlist).
963 Do not use this to implement individual filters if they are compatible with the
964 ChangesListFilter and ChangesListFilterGroup structure.
965 Instead, use sub-classes of those classes, in conjunction with the
966 ChangesListSpecialPageStructuredFilters hook.
967 This hook can be used to implement filters that do not implement that structure,
968 or custom behavior that is not an individual filter.
969 $name: name of the special page, e.g. 'Watchlist'
970 &$tables: array of tables to be queried
971 &$fields: array of columns to select
972 &$conds: array of WHERE conditionals for query
973 &$query_options: array of options for the database request
974 &$join_conds: join conditions for the tables
975 $opts: FormOptions for this request
977 'ChangesListSpecialPageStructuredFilters': Called to allow extensions to register
978 filters for pages inheriting from ChangesListSpecialPage (in core: RecentChanges,
979 RecentChangesLinked, and Watchlist). Generally, you will want to construct
980 new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects.
981 When constructing them, you specify which group they belong to. You can reuse
982 existing groups (accessed through $special->getFilterGroup), or create your own
983 (ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup).
984 If you create new groups, you must register them with $special->registerFilterGroup.
985 Note that this is called regardless of whether the user is currently using
986 the new (structured) or old (unstructured) filter UI. If you want your boolean
987 filter to show on both the new and old UI, specify all the supported fields.
988 These include showHide, label, and description.
989 See the constructor of each ChangesList* class for documentation of supported
991 $special: ChangesListSpecialPage instance
993 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
994 removed from all revisions and log entries to which it was applied). This gives
995 extensions a chance to take it off their books.
996 $tag: name of the tag
997 &$status: Status object. Add warnings to this as required. There is no point
998 setting errors, as the deletion has already been partly carried out by this
1001 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1002 from the UI (Special:Tags) or via the API. You could use this hook if you want
1003 to reserve a specific "namespace" of tags, or something similar.
1004 $tag: name of the tag
1005 $user: user initiating the action
1006 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1007 using `$status->warning()`. Errors and warnings will be relayed to the user.
1008 If you set an error, the user will be unable to create the tag.
1010 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1011 deleted from the UI (Special:Tags) or via the API. The default is that tags
1012 defined using the ListDefinedTags hook are not allowed to be deleted unless
1013 specifically allowed. If you wish to allow deletion of the tag, set
1014 `$status = Status::newGood()` to allow deletion, and then `return false` from
1015 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1016 out custom deletion actions.
1017 $tag: name of the tag
1018 $user: user initiating the action
1019 &$status: Status object. See above.
1021 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1022 uses are in active use.
1023 &$tags: list of all active tags. Append to this array.
1025 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1026 ChangeTags::updateTags function. Params:
1027 $addedTags: tags effectively added in the update
1028 $removedTags: tags effectively removed in the update
1029 $prevTags: tags that were present prior to the update
1030 $rc_id: recentchanges table id
1031 $rev_id: revision table id
1032 $log_id: logging table id
1034 $rc: RecentChange being tagged when the tagging accompanies the action, or null
1035 $user: User who performed the tagging when the tagging is subsequent to the
1038 'ChangeTagsAllowedAdd': Called when checking if a user can add tags to a change.
1039 &$allowedTags: List of all the tags the user is allowed to add. Any tags the
1040 user wants to add ($addTags) that are not in this array will cause it to fail.
1041 You may add or remove tags to this array as required.
1042 $addTags: List of tags user intends to add.
1043 $user: User who is adding the tags.
1045 'ChangeUserGroups': Called before user groups are changed.
1046 $performer: The User who will perform the change
1047 $user: The User whose groups will be changed
1048 &$add: The groups that will be added
1049 &$remove: The groups that will be removed
1051 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1052 $collationName: Name of the collation in question
1053 &$collationObject: Null. Replace with a subclass of the Collation class that
1054 implements the collation given in $collationName.
1056 'ConfirmEmailComplete': Called after a user's email has been confirmed
1058 $user: user (object) whose email is being confirmed
1060 'ContentAlterParserOutput': Modify parser output for a given content object.
1061 Called by Content::getParserOutput after parsing has finished. Can be used
1062 for changes that depend on the result of the parsing but have to be done
1063 before LinksUpdate is called (such as adding tracking categories based on
1065 $content: The Content to render
1066 $title: Title of the page, as context
1067 $parserOutput: ParserOutput to manipulate
1069 'ContentGetParserOutput': Customize parser output for a given content object,
1070 called by AbstractContent::getParserOutput. May be used to override the normal
1071 model-specific rendering of page content.
1072 $content: The Content to render
1073 $title: Title of the page, as context
1074 $revId: The revision ID, as context
1075 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1076 the output can only depend on parameters provided to this hook function, not
1078 $generateHtml: boolean, indicating whether full HTML should be generated. If
1079 false, generation of HTML may be skipped, but other information should still
1080 be present in the ParserOutput object.
1081 &$output: ParserOutput, to manipulate or replace
1083 'ContentHandlerDefaultModelFor': Called when the default content model is
1084 determined for a given title. May be used to assign a different model for that
1086 $title: the Title in question
1087 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1089 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1090 a given content model name, but no entry for that model exists in
1092 Note: if your extension implements additional models via this hook, please
1093 use GetContentModels hook to make them known to core.
1094 $modeName: the requested content model name
1095 &$handler: set this to a ContentHandler object, if desired.
1097 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1098 be used on a given page. This is especially useful to prevent some content
1099 models to be used in some special location.
1100 $contentModel: ID of the content model in question
1101 $title: the Title in question.
1102 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1103 Handler functions that modify $ok should generally return false to prevent
1104 further hooks from further modifying $ok.
1106 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1107 &$pager: Pager object for contributions
1108 &$queryInfo: The query for the contribs Pager
1110 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1112 &$data: an array of results of all contribs queries
1113 $pager: The ContribsPager object hooked into
1114 $offset: Index offset, inclusive
1115 $limit: Exact query limit
1116 $descending: Query direction, false for ascending, true for descending
1118 'ContributionsLineEnding': Called before a contributions HTML line is finished
1119 $page: SpecialPage object for contributions
1120 &$ret: the HTML line
1121 $row: the DB row for this line
1122 &$classes: the classes to add to the surrounding <li>
1123 &$attribs: associative array of other HTML attributes for the <li> element.
1124 Currently only data attributes reserved to MediaWiki are allowed
1125 (see Sanitizer::isReservedDataAttribute).
1127 'ContributionsToolLinks': Change tool links above Special:Contributions
1128 $id: User identifier
1129 $title: User page title
1130 &$tools: Array of tool links
1131 $specialPage: SpecialPage instance for context and services. Can be either
1132 SpecialContributions or DeletedContributionsPage. Extensions should type
1133 hint against a generic SpecialPage though.
1135 'ConvertContent': Called by AbstractContent::convert when a conversion to
1136 another content model is requested.
1137 Handler functions that modify $result should generally return false to disable
1138 further attempts at conversion.
1139 $content: The Content object to be converted.
1140 $toModel: The ID of the content model to convert to.
1141 $lossy: boolean indicating whether lossy conversion is allowed.
1142 &$result: Output parameter, in case the handler function wants to provide a
1143 converted Content object. Note that $result->getContentModel() must return
1146 'ContentSecurityPolicyDefaultSource': Modify the allowed CSP load sources. This
1147 affects all directives except for the script directive. If you want to add a
1148 script source, see ContentSecurityPolicyScriptSource hook.
1149 &$defaultSrc: Array of Content-Security-Policy allowed sources
1150 $policyConfig: Current configuration for the Content-Security-Policy header
1151 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1152 ContentSecurityPolicy::FULL_MODE depending on type of header
1154 'ContentSecurityPolicyDirectives': Modify the content security policy
1155 directives. Use this only if ContentSecurityPolicyDefaultSource and
1156 ContentSecurityPolicyScriptSource do not meet your needs.
1157 &$directives: Array of CSP directives
1158 $policyConfig: Current configuration for the CSP header
1159 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1160 ContentSecurityPolicy::FULL_MODE depending on type of header
1162 'ContentSecurityPolicyScriptSource': Modify the allowed CSP script sources.
1163 Note that you also have to use ContentSecurityPolicyDefaultSource if you
1164 want non-script sources to be loaded from
1166 &$scriptSrc: Array of CSP directives
1167 $policyConfig: Current configuration for the CSP header
1168 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1169 ContentSecurityPolicy::FULL_MODE depending on type of header
1171 'CustomEditor': When invoking the page editor
1172 Return true to allow the normal editor to be used, or false if implementing
1173 a custom editor, e.g. for a special namespace, etc.
1174 $article: Article being edited
1175 $user: User performing the edit
1177 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1178 for Special:DeletedContributions
1179 Similar to ContribsPager::reallyDoQuery
1180 &$data: an array of results of all contribs queries
1181 $pager: The DeletedContribsPager object hooked into
1182 $offset: Index offset, inclusive
1183 $limit: Exact query limit
1184 $descending: Query direction, false for ascending, true for descending
1186 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1188 Similar to ContributionsLineEnding
1189 $page: SpecialPage object for DeletedContributions
1190 &$ret: the HTML line
1191 $row: the DB row for this line
1192 &$classes: the classes to add to the surrounding <li>
1193 &$attribs: associative array of other HTML attributes for the <li> element.
1194 Currently only data attributes reserved to MediaWiki are allowed
1195 (see Sanitizer::isReservedDataAttribute).
1197 'DeleteUnknownPreferences': Called by the cleanupPreferences.php maintenance
1198 script to build a WHERE clause with which to delete preferences that are not
1199 known about. This hook is used by extensions that have dynamically-named
1200 preferences that should not be deleted in the usual cleanup process. For
1201 example, the Gadgets extension creates preferences prefixed with 'gadget-', and
1202 so anything with that prefix is excluded from the deletion.
1203 &where: An array that will be passed as the $cond parameter to
1204 IDatabase::select() to determine what will be deleted from the user_properties
1206 $db: The IDatabase object, useful for accessing $db->buildLike() etc.
1208 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1209 after the new revision's content has been loaded into the class member variable
1210 $differenceEngine->mNewContent but before returning true from this function.
1211 $differenceEngine: DifferenceEngine object
1213 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1214 DifferenceEngine::loadText() after the new revision's content has been loaded
1215 into the class member variable $differenceEngine->mNewContent but before
1216 checking if the variable's value is null.
1217 This hook can be used to inject content into said class member variable.
1218 $differenceEngine: DifferenceEngine object
1220 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as
1221 patrolled" link which is shown both on the diff header as well as on the bottom
1222 of a page, usually wrapped in a span element which has class="patrollink".
1223 $differenceEngine: DifferenceEngine object
1224 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1225 $rcid: Recent change ID (rc_id) for this change (int)
1227 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the
1228 rcid parameter. For example the rcid might be set to zero due to the user being
1229 the same as the performer of the change but an extension might still want to
1230 show it under certain conditions.
1231 &$rcid: rc_id (int) of the change or 0
1232 $differenceEngine: DifferenceEngine object
1233 $change: RecentChange object
1234 $user: User object representing the current user
1236 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader
1237 variable, which contains information about the new revision, such as the
1238 revision's author, whether the revision was marked as a minor edit or not, etc.
1239 $differenceEngine: DifferenceEngine object
1240 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1241 include things like revision author info, revision comment, RevisionDelete
1243 $formattedRevisionTools: Array containing revision tools, some of which may have
1244 been injected with the DiffRevisionTools hook
1245 $nextlink: String containing the link to the next revision (if any); also
1246 included in $newHeader
1247 $rollback: Rollback link (string) to roll this revision back to the previous
1249 $newminor: String indicating if the new revision was marked as a minor edit
1250 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1251 whether we should show just the diff; passed in as a query string parameter to
1252 the various URLs constructed here (i.e. $nextlink)
1253 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1254 to use the RevisionDelete feature
1255 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1257 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader
1258 variable, which contains information about the old revision, such as the
1259 revision's author, whether the revision was marked as a minor edit or not, etc.
1260 $differenceEngine: DifferenceEngine object
1261 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1262 include things like revision author info, revision comment, RevisionDelete
1264 $prevlink: String containing the link to the previous revision (if any); also
1265 included in $oldHeader
1266 $oldminor: String indicating if the old revision was marked as a minor edit
1267 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1268 whether we should show just the diff; passed in as a query string parameter to
1269 the various URLs constructed here (i.e. $prevlink)
1270 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1271 to use the RevisionDelete feature
1272 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1274 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases
1275 when there is no old revision
1276 &$oldHeader: empty string by default
1278 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the
1279 parser output. Return false to not add parser output via OutputPage's
1280 addParserOutput method.
1281 $differenceEngine: DifferenceEngine object
1282 $out: OutputPage object
1283 $parserOutput: ParserOutput object
1284 $wikiPage: WikiPage object
1286 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into
1287 this hook point and return false to not show the final "mark as patrolled" link
1288 on the bottom of a page.
1289 This hook has no arguments.
1291 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1292 eventually gets sent to the OutputPage object.
1293 $differenceEngine: DifferenceEngine object
1295 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff
1296 table body (without header) in cases when there is no old revision or the old
1297 and new revisions are identical.
1298 $differenceEngine: DifferenceEngine object
1300 'DifferenceEngineShowDiffPage': Add additional output via the available
1301 OutputPage object into the diff view
1302 $out: OutputPage object
1304 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1305 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1306 Return false in order to prevent displaying the missing revision message
1307 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1308 $differenceEngine: DifferenceEngine object
1310 'DiffRevisionTools': Override or extend the revision tools available from the
1311 diff view, i.e. undo, etc.
1312 $newRev: Revision object of the "new" revision
1313 &$links: Array of HTML links
1314 $oldRev: Revision object of the "old" revision (may be null)
1315 $user: Current user object
1317 'DiffViewHeader': Called before diff display
1318 $diff: DifferenceEngine object that's calling
1319 $oldRev: Revision object of the "old" revision (may be null/invalid)
1320 $newRev: Revision object of the "new" revision
1322 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1324 &$article: article (object) being viewed
1325 &$oldid: oldid (int) being viewed
1327 'EditFilter': Perform checks on an edit
1328 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1329 $text: Contents of the edit box
1330 $section: Section being edited
1331 &$error: Error message to return
1332 $summary: Edit summary for page
1334 'EditFilterMergedContent': Post-section-merge edit filter.
1335 This may be triggered by the EditPage or any other facility that modifies page
1336 content. Use the $status object to indicate whether the edit should be allowed,
1337 and to provide a reason for disallowing it. Return false to abort the edit, and
1338 true to continue. Returning true if $status->isOK() returns false means "don't
1339 save but continue user interaction", e.g. show the edit form.
1340 $status->apiHookResult can be set to an array to be returned by api.php
1341 action=edit. This is used to deliver captchas.
1342 $context: object implementing the IContextSource interface.
1343 $content: content of the edit box, as a Content object.
1344 $status: Status object to represent errors, etc.
1345 $summary: Edit summary for page
1346 $user: the User object representing the user whois performing the edit.
1347 $minoredit: whether the edit was marked as minor by the user.
1349 'EditFormInitialText': Allows modifying the edit form when editing existing
1351 $editPage: EditPage object
1353 'EditFormPreloadText': Allows population of the edit form when creating
1355 &$text: Text to preload with
1356 &$title: Title object representing the page being created
1358 'EditPage::attemptSave': Called before an article is
1359 saved, that is before WikiPage::doEditContent() is called
1360 $editpage_Obj: the current EditPage object
1362 'EditPage::attemptSave:after': Called after an article save attempt
1363 $editpage_Obj: the current EditPage object
1364 $status: the resulting Status object
1365 $resultDetails: Result details array
1367 'EditPage::importFormData': allow extensions to read additional data
1369 Return value is ignored (should always return true)
1370 $editpage: EditPage instance
1371 $request: Webrequest
1373 'EditPage::showEditForm:fields': allows injection of form field into edit form
1374 Return value is ignored (should always return true)
1375 &$editor: the EditPage instance for reference
1376 &$out: an OutputPage instance to write to
1378 'EditPage::showEditForm:initial': before showing the edit form
1379 Return false to halt editing; you'll need to handle error messages, etc.
1380 yourself. Alternatively, modifying $error and returning true will cause the
1381 contents of $error to be echoed at the top of the edit form as wikitext.
1382 Return true without altering $error to allow the edit to proceed.
1383 &$editor: EditPage instance (object)
1384 &$out: an OutputPage instance to write to
1386 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1387 but for the read-only 'view source' variant of the edit form.
1388 Return value is ignored (should always return true)
1389 $editor: EditPage instance (object)
1390 &$out: an OutputPage instance to write to
1392 'EditPage::showStandardInputs:options': allows injection of form fields into
1393 the editOptions area
1394 Return value is ignored (should always be true)
1395 $editor: EditPage instance (object)
1396 $out: an OutputPage instance to write to
1397 &$tabindex: HTML tabindex of the last edit check/button
1399 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1400 when there's an edit conflict. Return false to halt normal diff output; in
1401 this case you're responsible for computing and outputting the entire "conflict"
1402 part, i.e., the "difference between revisions" and "your text" headers and
1404 &$editor: EditPage instance
1405 &$out: OutputPage instance
1407 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1408 textarea in the edit form.
1409 &$editpage: The current EditPage object
1410 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1411 &$tabindex: HTML tabindex of the last edit check/button
1413 'EditPageBeforeEditToolbar': Allow adding an edit toolbar above the textarea in
1415 &$toolbar: The toolbar HTML, initially an empty `<div id="toolbar"></div>`
1416 Hook subscribers can return false to have no toolbar HTML be loaded.
1418 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1419 contribution/copyright notice.
1420 $title: title of page being edited
1421 &$msg: localization message name, overridable. Default is either
1422 'copyrightwarning' or 'copyrightwarning2'.
1424 'EditPageGetCheckboxesDefinition': Allows modifying the edit checkboxes
1425 below the textarea in the edit form.
1426 $editpage: The current EditPage object
1427 &$checkboxes: Array of checkbox definitions. See
1428 EditPage::getCheckboxesDefinition() for the format.
1430 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1431 "Show changes". Note that it is preferable to implement diff handling for
1432 different data types using the ContentHandler facility.
1433 $editPage: EditPage object
1434 &$newtext: wikitext that will be used as "your version"
1436 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1437 previewed. Note that it is preferable to implement previews for different data
1438 types using the ContentHandler facility.
1439 $editPage: EditPage object
1440 &$content: Content object to be previewed (may be replaced by hook function)
1442 'EditPageNoSuchSection': When a section edit request is given for an
1443 non-existent section
1444 &$editpage: The current EditPage object
1445 &$res: the HTML of the error text
1447 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1448 of terms of service summary link that might exist separately from the copyright
1450 $title: title of page being edited
1451 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1453 'EmailConfirmed': When checking that the user's email address is "confirmed".
1454 This runs before the other checks, such as anonymity and the real check; return
1455 true to allow those checks to occur, and false if checking is done.
1456 &$user: User being checked
1457 &$confirmed: Whether or not the email address is confirmed
1459 'EmailUser': Before sending email from one user to another.
1460 &$to: MailAddress object of receiving user
1461 &$from: MailAddress object of sending user
1462 &$subject: subject of the mail
1463 &$text: text of the mail
1464 &$error: Out-param for an error. Should be set to a Status object or boolean
1467 'EmailUserCC': Before sending the copy of the email to the author.
1468 &$to: MailAddress object of receiving user
1469 &$from: MailAddress object of sending user
1470 &$subject: subject of the mail
1471 &$text: text of the mail
1473 'EmailUserComplete': After sending email from one user to another.
1474 $to: MailAddress object of receiving user
1475 $from: MailAddress object of sending user
1476 $subject: subject of the mail
1477 $text: text of the mail
1479 'EmailUserForm': After building the email user form object.
1480 &$form: HTMLForm object
1482 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1484 $user: The user who is trying to email another user.
1485 $editToken: The user's edit token.
1486 &$hookErr: Out-param for the error. Passed as the parameters to
1487 OutputPage::showErrorPage.
1489 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1490 group of changes in EnhancedChangesList.
1491 Hook subscribers can return false to omit this line from recentchanges.
1492 $changesList: EnhancedChangesList object
1493 &$links: The links that were generated by EnhancedChangesList
1494 $block: The RecentChanges objects in that block
1496 'EnhancedChangesListModifyLineData': to alter data used to build
1497 a grouped recent change inner line in EnhancedChangesList.
1498 Hook subscribers can return false to omit this line from recentchanges.
1499 $changesList: EnhancedChangesList object
1500 &$data: An array with all the components that will be joined in order to create
1502 $block: An array of RecentChange objects in that block
1503 $rc: The RecentChange object for this line
1504 &$classes: An array of classes to change
1505 &$attribs: associative array of other HTML attributes for the <tr> element.
1506 Currently only data attributes reserved to MediaWiki are allowed
1507 (see Sanitizer::isReservedDataAttribute).
1509 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1510 a non-grouped recent change line in EnhancedChangesList.
1511 $changesList: EnhancedChangesList object
1512 &$data: An array with all the components that will be joined in order to create
1514 $rc: The RecentChange object for this line
1516 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1518 $ip: The ip address of the user
1520 'ExtensionTypes': Called when generating the extensions credits, use this to
1521 change the tables headers.
1522 &$extTypes: associative array of extensions types
1524 'FetchChangesList': When fetching the ChangesList derivative for a particular
1526 $user: User the list is being fetched for
1527 &$skin: Skin object to be used with the list
1528 &$list: List object (defaults to NULL, change it to an object instance and
1529 return false override the list derivative used)
1530 $groups Array of ChangesListFilterGroup objects (added in 1.34)
1532 'FileDeleteComplete': When a file is deleted.
1533 &$file: reference to the deleted file
1534 &$oldimage: in case of the deletion of an old image, the name of the old file
1535 &$article: in case all revisions of the file are deleted a reference to the
1536 WikiFilePage associated with the file.
1537 &$user: user who performed the deletion
1540 'FileTransformed': When a file is transformed and moved into storage.
1541 $file: reference to the File object
1542 $thumb: the MediaTransformOutput object
1543 $tmpThumbPath: The temporary file system path of the transformed file
1544 $thumbPath: The permanent storage path of the transformed file
1546 'FileUndeleteComplete': When a file is undeleted
1547 $title: title object to the file
1548 $fileVersions: array of undeleted versions. Empty if all versions were restored
1549 $user: user who performed the undeletion
1552 'FileUpload': When a file upload occurs.
1553 $file: Image object representing the file that was uploaded
1554 $reupload: Boolean indicating if there was a previously another image there or
1556 $hasDescription: Boolean indicating that there was already a description page
1557 and a new one from the comment wasn't created (since 1.17)
1559 'FormatAutocomments': When an autocomment is formatted by the Linker.
1560 &$comment: Reference to the accumulated comment. Initially null, when set the
1561 default code will be skipped.
1562 $pre: Boolean, true if there is text before this autocomment
1563 $auto: The extracted part of the parsed comment before the call to the hook.
1564 $post: Boolean, true if there is text after this autocomment
1565 $title: An optional title object used to links to sections. Can be null.
1566 $local: Boolean indicating whether section links should refer to local page.
1567 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1568 autocomment originated; null for the local wiki. Added in 1.26, should default
1569 to null in handler functions, for backwards compatibility.
1571 'GalleryGetModes': Get list of classes that can render different modes of a
1573 &$modeArray: An associative array mapping mode names to classes that implement
1574 that mode. It is expected all registered classes are a subclass of
1577 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1579 $user: user to promote.
1580 &$promote: groups that will be added.
1582 'GetBlockedStatus': after loading blocking status of an user from the database
1583 &$user: user (object) being checked
1585 'GetCacheVaryCookies': Get cookies that should vary cache options.
1586 $out: OutputPage object
1587 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1588 that have to vary cache options
1590 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1592 &$title: Title object of page
1593 &$url: string value as output (out parameter, can modify)
1594 $query: query options as string passed to Title::getCanonicalURL()
1596 'GetContentModels': Add content models to the list of available models.
1597 &$models: array containing current model list, as strings. Extensions should add to this list.
1599 'GetDefaultSortkey': Override the default sortkey for a page.
1600 $title: Title object that we need to get a sortkey for
1601 &$sortkey: Sortkey to use.
1603 'GetDifferenceEngine': Called when getting a new difference engine interface
1604 object. Can be used to decorate or replace the default difference engine.
1605 $context: IContextSource context to be used for diff
1606 $old: Revision ID to show and diff with
1607 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1608 $refreshCache: If set, refreshes the diff cache
1609 $unhide: If set, allow viewing deleted revs
1610 &$differenceEngine: The difference engine object to be used for the diff
1612 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1613 underscore) magic words. Called by MagicWord.
1614 &$doubleUnderscoreIDs: array of strings
1616 'GetExtendedMetadata': Get extended file metadata for the API
1617 &$combinedMeta: Array of the form:
1618 'MetadataPropName' => [
1619 value' => prop value,
1620 'source' => 'name of hook'
1622 $file: File object of file in question
1623 $context: RequestContext (including language to use)
1624 $single: Only extract the current language; if false, the prop value should
1625 be in the metadata multi-language array format:
1626 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1627 &$maxCacheTime: how long the results can be cached
1629 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1630 &$title: Title object of page
1631 &$url: string value as output (out parameter, can modify)
1632 $query: query options as string passed to Title::getFullURL()
1634 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1635 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1637 &$output: string for the output timestamp
1638 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1639 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1640 $user: User whose preferences are being used to make timestamp
1641 $lang: Language that will be used to render the timestamp
1643 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1644 &$title: Title object of page
1645 &$url: string value as output (out parameter, can modify)
1646 $query: query options as string passed to Title::getInternalURL()
1648 'GetIP': modify the ip of the current user (called only once).
1649 &$ip: string holding the ip as determined so far
1651 'GetLangPreferredVariant': Called in LanguageConverter#getPreferredVariant() to
1652 allow fetching the language variant code from cookies or other such
1653 alternative storage.
1654 &$req: language variant from the URL (string) or boolean false if no variant
1655 was specified in the URL; the value of this variable comes from
1656 LanguageConverter#getURLVariant()
1658 'GetLinkColours': modify the CSS class of an array of page links.
1659 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1661 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1662 $title: Title object of the page being parsed, on which the links will be shown
1664 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1665 working with internal urls (non-interwiki) then it may be preferable to work
1666 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1667 be buggy for internal urls on render if you do not re-implement the horrible
1668 hack that Title::getLocalURL uses in your own extension.
1669 &$title: Title object of page
1670 &$url: string value as output (out parameter, can modify)
1671 $query: query options as string passed to Title::getLocalURL()
1673 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1674 without any fancy queries or variants.
1675 &$title: Title object of page
1676 &$url: string value as output (out parameter, can modify)
1678 'GetLocalURL::Internal': Modify local URLs to internal pages.
1679 &$title: Title object of page
1680 &$url: string value as output (out parameter, can modify)
1681 $query: query options as string passed to Title::getLocalURL()
1683 'GetLogTypesOnUser': Add log types where the target is a userpage
1684 &$types: Array of log types
1686 'GetMetadataVersion': Modify the image metadata version currently in use. This
1687 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1688 that need to have versioned metadata should add an element to the end of the
1689 version array of the form 'handler_name=version'. Most media handlers won't need
1690 to do this unless they broke backwards compatibility with a previous version of
1691 the media handler metadata output.
1692 &$version: Array of version strings
1694 'GetNewMessagesAlert': Disable or modify the new messages alert
1695 &$newMessagesAlert: An empty string by default. If the user has new talk page
1696 messages, this should be populated with an alert message to that effect
1697 $newtalks: An empty array if the user has no new messages or an array
1698 containing links and revisions if there are new messages (See
1699 User::getNewMessageLinks)
1700 $user: The user object of the user who is loading the page
1701 $out: OutputPage object (to check what type of page the user is on)
1703 'GetPreferences': Modify user preferences.
1704 $user: User whose preferences are being modified.
1705 &$preferences: Preferences description array, to be fed to an HTMLForm object
1707 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1708 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1710 &$output: string for the output timestamp
1711 &$diff: DateInterval representing the difference between the timestamps
1712 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1713 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1714 $user: User whose preferences are being used to make timestamp
1715 $lang: Language that will be used to render the timestamp
1717 'GetSlotDiffRenderer': Replace or wrap the standard SlotDiffRenderer for some
1719 $contentHandler: ContentHandler for which the slot diff renderer is fetched.
1720 &$slotDiffRenderer: SlotDiffRenderer to change or replace.
1721 $context: IContextSource
1723 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1724 checked for. Use instead of userCan for most cases. Return false if the user
1725 can't do it, and populate $result with the reason in the form of
1726 [ messagename, param1, param2, ... ] or a MessageSpecifier instance (you
1727 might want to use ApiMessage to provide machine-readable details for the API).
1728 For consistency, error messages
1729 should be plain text with no special coloring, bolding, etc. to show that
1730 they're errors; presenting them properly to the user as errors is done by the
1732 &$title: Title object being checked against
1733 &$user: Current user object
1734 $action: Action being checked
1735 &$result: User permissions error to add. If none, return true.
1737 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1738 called only if expensive checks are enabled. Add a permissions error when
1739 permissions errors are checked for. Return false if the user can't do it, and
1740 populate $result with the reason in the form of [ messagename, param1, param2,
1741 ... ] or a MessageSpecifier instance (you might want to use ApiMessage to
1742 provide machine-readable details for the API). For consistency, error messages
1743 should be plain text with no special coloring, bolding, etc. to show that
1744 they're errors; presenting them properly to the user as errors is done by the
1746 &$title: Title object being checked against
1747 &$user: Current user object
1748 $action: Action being checked
1749 &$result: User permissions error to add. If none, return true.
1751 'GitViewers': Called when generating the list of git viewers for
1752 Special:Version, use this to change the list.
1753 &$extTypes: associative array of repo URLS to viewer URLs.
1755 'HistoryRevisionTools': Override or extend the revision tools available from the
1756 page history view, i.e. undo, rollback, etc.
1757 $rev: Revision object
1758 &$links: Array of HTML links
1759 $prevRev: Revision object, next in line in page history, or null
1760 $user: Current user object
1762 'HistoryPageToolLinks': Add one or more links to revision history page subtitle.
1763 $context: IContextSource (object)
1764 $linkRenderer: LinkRenderer instance
1765 &$links: Array of HTML strings
1767 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1769 $context: An IContextSource object with information about the request being
1772 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1773 image insertion. You can skip the default logic entirely by returning false, or
1774 just modify a few things using call-by-reference.
1776 &$title: Title object of the image
1777 &$file: File object, or false if it doesn't exist
1778 &$frameParams: Various parameters with special meanings; see documentation in
1779 includes/Linker.php for Linker::makeImageLink
1780 &$handlerParams: Various parameters with special meanings; see documentation in
1781 includes/Linker.php for Linker::makeImageLink
1782 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1783 &$res: Final HTML output, used if you return false
1784 $parser: Parser instance
1785 &$query: Query params for desc URL
1786 &$widthOption: Used by the parser to remember the user preference thumbnailsize
1788 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1789 the image on an image page.
1790 &$imagePage: ImagePage object ($this)
1793 'ImagePageAfterImageLinks': Called after the image links section on an image
1795 $imagePage: ImagePage object ($this)
1796 &$html: HTML for the hook to add
1798 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1799 $imagePage: ImagePage object ($this)
1801 &$line: the HTML of the history line
1802 &$css: the line CSS class
1804 'ImagePageFindFile': Called when fetching the file associated with an image
1806 $page: ImagePage object
1808 &$displayFile: displayed File object
1810 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1811 $page: ImagePage object
1812 &$toc: Array of <li> strings
1814 'ImgAuthBeforeStream': Executed before file is streamed to user, but only when
1816 &$title: the Title object of the file as it would appear for the upload page
1817 &$path: the original file and path name when img_auth was invoked by the web
1819 &$name: the name only component of the file
1820 &$result: The location to pass back results of the hook routine (only used if
1822 $result[0]=The index of the header message
1823 $result[1]=The index of the body text message
1824 $result[2 through n]=Parameters passed to body text message. Please note the
1825 header message cannot receive/use parameters.
1827 'ImgAuthModifyHeaders': Executed just before a file is streamed to a user via
1828 img_auth.php, allowing headers to be modified beforehand.
1829 $title: LinkTarget object
1830 &$headers: HTTP headers ( name => value, names are case insensitive ).
1831 Two headers get special handling: If-Modified-Since (value must be
1832 a valid HTTP date) and Range (must be of the form "bytes=(\d*-\d*)")
1833 will be honored when streaming the file.
1835 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1836 Return false to stop further processing of the tag
1837 $reader: XMLReader object
1838 $logInfo: Array of information
1840 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1841 Return false to stop further processing of the tag
1842 $reader: XMLReader object
1843 &$pageInfo: Array of information
1845 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1846 Return false to stop further processing of the tag
1847 $reader: XMLReader object
1848 $pageInfo: Array of page information
1849 $revisionInfo: Array of revision information
1851 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1852 Return false to stop further processing of the tag
1853 $reader: XMLReader object
1855 'ImportHandleUnknownUser': When a user doesn't exist locally, this hook is
1856 called to give extensions an opportunity to auto-create it. If the auto-creation
1857 is successful, return false.
1860 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1861 Return false to stop further processing of the tag
1862 $reader: XMLReader object
1863 $revisionInfo: Array of information
1865 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1866 and edit summaries for transwiki imports.
1867 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1868 &$pageTitle: String that contains page title.
1870 'ImportSources': Called when reading from the $wgImportSources configuration
1871 variable. Can be used to lazy-load the import sources list.
1872 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1873 comment in DefaultSettings.php for the detail of how to structure this array.
1875 'InfoAction': When building information to display on the action=info page.
1876 $context: IContextSource object
1877 &$pageInfo: Array of information
1879 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1880 &$title: Title object for the current page
1881 &$request: WebRequest
1882 &$ignoreRedirect: boolean to skip redirect check
1883 &$target: Title/string of redirect target
1884 &$article: Article object
1886 'InternalParseBeforeLinks': during Parser's internalParse method before links
1887 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1888 &$parser: Parser object
1889 &$text: string containing partially parsed text
1890 &$stripState: Parser's internal StripState object
1892 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1893 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1894 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1895 template/parser function execution which respect nowiki and HTML-comments.
1896 &$parser: Parser object
1897 &$text: string containing partially parsed text
1898 &$stripState: Parser's internal StripState object
1900 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1901 Return true without providing an interwiki to continue interwiki search.
1902 $prefix: interwiki prefix we are looking for.
1903 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1904 iw_trans and optionally iw_api and iw_wikiid.
1906 'InvalidateEmailComplete': Called after a user's email has been invalidated
1908 $user: user (object) whose email is being invalidated
1910 'IRCLineURL': When constructing the URL to use in an IRC notification.
1911 Callee may modify $url and $query, URL will be constructed as $url . $query
1912 &$url: URL to index.php
1913 &$query: Query string
1914 $rc: RecentChange object that triggered url generation
1916 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1917 &$article: article (object) being checked
1919 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1920 &$ip: IP being check
1921 &$result: Change this value to override the result of IP::isTrustedProxy()
1923 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1924 $url: URL used to upload from
1925 &$allowed: Boolean indicating if uploading is allowed for given URL
1927 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1928 instance to return false if the domain name doesn't match your organization.
1929 $addr: The e-mail address entered by the user
1930 &$result: Set this and return false to override the internal checks
1932 'isValidPassword': Override the result of User::isValidPassword()
1933 $password: The password entered by the user
1934 &$result: Set this and return false to override the internal checks
1935 $user: User the password is being validated for
1937 'Language::getMessagesFileName':
1938 $code: The language code or the language we're looking for a messages file for
1939 &$file: The messages file path, you can override this to change the location.
1941 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1942 remove namespaces. Do not use this hook to add namespaces. Use
1943 CanonicalNamespaces for that.
1944 &$namespaces: Array of namespaces indexed by their numbers
1946 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1947 &$names: array of language code => language name
1948 $code: language of the preferred translations
1950 'LanguageLinks': Manipulate a page's language links. This is called
1951 in various places to allow extensions to define the effective language
1953 $title: The page's Title.
1954 &$links: Array with elements of the form "language:title" in the order
1955 that they will be output.
1956 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1957 Currently unused, but planned to provide support for marking individual
1958 language links in the UI, e.g. for featured articles.
1960 'LanguageSelector': Hook to change the language selector available on a page.
1961 $out: The output page.
1962 $cssClassName: CSS class name of the language selector.
1964 'LinkBegin': DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead.
1965 Used when generating internal and interwiki links in Linker::link(), before
1966 processing starts. Return false to skip default processing and return $ret. See
1967 documentation for Linker::link() for details on the expected meanings of
1969 $skin: the Skin object
1970 $target: the Title that the link is pointing to
1971 &$html: the contents that the <a> tag should have (raw HTML); null means
1973 &$customAttribs: the HTML attributes that the <a> tag should have, in
1974 associative array form, with keys and values unescaped. Should be merged
1975 with default values, with a value of false meaning to suppress the
1977 &$query: the query string to add to the generated URL (the bit after the "?"),
1978 in associative array form, with keys and values unescaped.
1979 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1980 &$ret: the value to return if your hook returns false.
1982 'LinkEnd': DEPRECATED since 1.28! Use HtmlPageLinkRendererEnd hook instead
1983 Used when generating internal and interwiki links in Linker::link(),
1984 just before the function returns a value. If you return true, an <a> element
1985 with HTML attributes $attribs and contents $html will be returned. If you
1986 return false, $ret will be returned.
1987 $skin: the Skin object
1988 $target: the Title object that the link is pointing to
1989 $options: the options. Will always include either 'known' or 'broken', and may
1990 include 'noclasses'.
1991 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1992 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1993 associative array form.
1994 &$ret: the value to return if your hook returns false.
1996 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1998 &$url: the image url
1999 &$alt: the image's alt text
2000 &$img: the new image HTML (if returning false)
2002 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
2005 &$text: the link text
2006 &$link: the new link HTML (if returning false)
2007 &$attribs: the attributes to be applied.
2008 $linkType: The external link type
2010 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
2012 $title: the Title object that the link is pointing to
2013 $file: the File object or false if broken link
2014 &$html: the link text
2015 &$attribs: the attributes to be applied
2016 &$ret: the value to return if your hook returns false
2018 'LogEventsListLineEnding': Called before a Special:Log line is finished
2019 $page: the LogEventsList object
2020 &$ret: the HTML line
2021 $entry: the DatabaseLogEntry object for this row
2022 &$classes: the classes to add to the surrounding <li>
2023 &$attribs: associative array of other HTML attributes for the <li> element.
2024 Currently only data attributes reserved to MediaWiki are allowed
2025 (see Sanitizer::isReservedDataAttribute).
2028 'HtmlPageLinkRendererBegin':
2029 Used when generating internal and interwiki links in
2030 LinkRenderer, before processing starts. Return false to skip default
2031 processing and return $ret.
2032 $linkRenderer: the LinkRenderer object
2033 $target: the LinkTarget that the link is pointing to
2034 &$text: the contents that the <a> tag should have; either a plain, unescaped
2035 string or a HtmlArmor object; null means "default".
2036 &$customAttribs: the HTML attributes that the <a> tag should have, in
2037 associative array form, with keys and values unescaped. Should be merged
2038 with default values, with a value of false meaning to suppress the
2040 &$query: the query string to add to the generated URL (the bit after the "?"),
2041 in associative array form, with keys and values unescaped.
2042 &$ret: the value to return if your hook returns false.
2044 'HtmlPageLinkRendererEnd':
2045 Used when generating internal and interwiki links in LinkRenderer,
2046 just before the function returns a value. If you return true, an <a> element
2047 with HTML attributes $attribs and contents $html will be returned. If you
2048 return false, $ret will be returned.
2049 $linkRenderer: the LinkRenderer object
2050 $target: the LinkTarget object that the link is pointing to
2051 $isKnown: boolean indicating whether the page is known or not
2052 &$text: the contents that the <a> tag should have; either a plain, unescaped
2053 string or a HtmlArmor object.
2054 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2055 associative array form.
2056 &$ret: the value to return if your hook returns false.
2058 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2060 &$linksUpdate: the LinksUpdate object
2062 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2063 each link table insert. For example, pagelinks, imagelinks, externallinks.
2064 $linksUpdate: LinksUpdate object
2065 $table: the table to insert links to
2066 $insertions: an array of links to insert
2068 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2069 including delete and insert, has completed for all link tables
2070 &$linksUpdate: the LinksUpdate object
2071 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2073 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2074 &$linksUpdate: the LinksUpdate object
2076 'ListDefinedTags': When trying to find all defined tags.
2077 &$tags: The list of tags.
2079 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2080 $updater: A DatabaseUpdater subclass
2082 'LocalFile::getHistory': Called before file history query performed.
2083 &$file: the File object
2085 &$fields: select fields
2087 &$opts: query options
2088 &$join_conds: JOIN conditions
2090 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2091 $file: the File object
2092 $archiveName: name of an old file version or false if it's the current one
2094 'LocalisationCacheRecache': Called when loading the localisation data into
2096 $cache: The LocalisationCache object
2097 $code: language code
2098 &$alldata: The localisation data from core and extensions
2100 'LocalisationCacheRecacheFallback': Called for each language when merging
2101 fallback data into the cache.
2102 $cache: The LocalisationCache object
2103 $code: language code
2104 &$alldata: The localisation data from core and extensions. Note some keys may
2105 be omitted if they won't be merged into the final result.
2107 'LocalisationChecksBlacklist': When fetching the blacklist of
2108 localisation checks.
2109 &$blacklist: array of checks to blacklist. See the bottom of
2110 maintenance/language/checkLanguage.inc for the format of this variable.
2112 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2113 optional localisation messages
2114 &$ignored: Array of ignored message keys
2115 &$optional: Array of optional message keys
2117 'LocalUserCreated': Called when a local user has been created
2118 $user: User object for the created user
2119 $autocreated: Boolean, whether this was an auto-creation
2121 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2122 Special:Log for a specific log type
2123 $type: String of log type being displayed
2124 $logEventsList: LogEventsList object for context and access to the WebRequest
2125 &$input: string HTML of an input element (deprecated, use $formDescriptor instead)
2126 &$formDescriptor: array HTMLForm's form descriptor
2128 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2129 Returning false will prevent the string from being added to the OutputPage.
2130 &$s: html string to show for the log extract
2131 $types: String or Array Log types to show
2132 $page: String or Title The page title to show log entries for
2133 $user: String The user who made the log entries
2134 $param: Associative Array with the following additional options:
2135 - lim Integer Limit of items to show, default is 50
2136 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2137 - showIfEmpty boolean Set to false if you don't want any output in case the
2138 loglist is empty if set to true (default), "No matching items in log" is
2139 displayed if loglist is empty
2140 - msgKey Array If you want a nice box with a message, set this to the key of
2141 the message. First element is the message key, additional optional elements
2142 are parameters for the key that are processed with
2143 wfMessage()->params()->parseAsBlock()
2144 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2146 - wrap String Wrap the message in html (usually something like
2147 "<div ...>$1</div>").
2148 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2150 'LogException': Called before an exception (or PHP error) is logged. This is
2151 meant for integration with external error aggregation services; returning false
2152 will NOT prevent logging.
2153 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2154 $suppressed: true if the error was suppressed via
2155 error_reporting()/wfSuppressWarnings()
2157 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2158 error messages. Allows to add additional error messages (except messages already
2159 in LoginForm::$validErrorMessages).
2160 &$messages: Already added messages (inclusive messages from
2161 LoginForm::$validErrorMessages)
2163 'LogLine': Processes a single log entry on Special:Log.
2164 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2165 logging.log_type database field.
2166 $log_action: string for the type of log action (e.g. 'delete', 'block',
2167 'create2'). Corresponds to logging.log_action database field.
2168 $title: Title object that corresponds to logging.log_namespace and
2169 logging.log_title database fields.
2170 $paramArray: Array of parameters that corresponds to logging.log_params field.
2171 Note that only $paramArray[0] appears to contain anything.
2172 &$comment: string that corresponds to logging.log_comment database field, and
2173 which is displayed in the UI.
2174 &$revert: string that is displayed in the UI, similar to $comment.
2175 $time: timestamp of the log entry (added in 1.12)
2177 'LonelyPagesQuery': Allow extensions to modify the query used by
2178 Special:LonelyPages.
2179 &$tables: tables to join in the query
2180 &$conds: conditions for the query
2181 &$joinConds: join conditions for the query
2183 'MagicWordwgVariableIDs': When defining new magic words IDs.
2184 &$variableIDs: array of strings
2186 'MaintenanceUpdateAddParams': allow extensions to add params to the update.php
2188 &$params: array to populate with the params to be added. Array elements are keyed by
2189 the param name. Each param is an associative array that must include the following keys:
2190 - desc The description of the param to show on --help
2191 - require Is the param required? Defaults to false if not set.
2192 - withArg Is an argument required with this option? Defaults to false if not set.
2193 - shortName Character to use as short name, or false if none. Defaults to false if not set.
2194 - multiOccurrence Can this option be passed multiple times? Defaults to false if not set.
2196 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2198 $refreshLinks: RefreshLinks object
2200 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2201 Ideally, this hook should only be used to add variables that depend on
2202 the current page/request; static configuration should be added through
2203 ResourceLoaderGetConfigVars instead.
2204 &$vars: variable (or multiple variables) to be added into the output of
2205 Skin::makeVariablesScript
2206 $out: The OutputPage which called the hook, can be used to get the real title.
2208 'ManualLogEntryBeforePublish': Allows to access or modify log entry just before it is
2210 $logEntry: ManualLogEntry object
2212 'MarkPatrolled': Before an edit is marked patrolled.
2213 $rcid: ID of the revision to be marked patrolled
2214 &$user: the user (object) marking the revision as patrolled
2215 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2216 sysop in order to mark an edit patrolled.
2217 $auto: true if the edit is being marked as patrolled automatically
2218 &$tags: the tags to be applied to the patrol log entry
2220 'MarkPatrolledComplete': After an edit is marked patrolled.
2221 $rcid: ID of the revision marked as patrolled
2222 &$user: user (object) who marked the edit patrolled
2223 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2224 sysop to patrol the edit.
2225 $auto: true if the edit is being marked as patrolled automatically
2227 'ApiMaxLagInfo': When lag information is being requested via API. Use this to
2228 override lag information. Generally a hook function should only replace
2229 $lagInfo if the new $lagInfo['lag'] is greater than the current $lagInfo['lag'].
2230 &$lagInfo: Maximum lag information array. Fields in the array are:
2231 'lag' is the number of seconds of lag.
2232 'host' is the host name on which the lag exists.
2233 'type' is an indication of the type of lag,
2234 e.g. "db" for database replication lag or "jobqueue" for job queue size
2235 converted to pseudo-seconds.
2236 It is possible to add more fields and they will be returned to the user in
2239 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2240 something completely different, after the basic globals have been set up, but
2241 before ordinary actions take place.
2243 $article: Article on which the action will be performed
2244 $title: Title on which the action will be performed
2246 $request: $wgRequest
2247 $mediaWiki: The $mediawiki object
2249 'MediaWikiServices': Called when a global MediaWikiServices instance is
2250 initialized. Extensions may use this to define, replace, or wrap services.
2251 However, the preferred way to define a new service is
2252 the $wgServiceWiringFiles array.
2253 $services: MediaWikiServices
2255 'MessageCache::get': When fetching a message. Can be used to override the key
2256 for customisations. Given and returned message key must be in special format:
2257 1) first letter must be in lower case according to the content language.
2258 2) spaces must be replaced with underscores
2259 &$key: message key (string)
2261 'MessageCacheReplace': When a message page is changed. Useful for updating
2263 $title: name of the page changed.
2264 $text: new contents of the page.
2266 'MessagesPreLoad': When loading a message from the database.
2267 $title: title of the message (string)
2268 &$message: value (string), change it to the message you want to define
2269 $code: code (string) denoting the language to try.
2271 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2272 $mimeMagic: Instance of MimeAnalyzer.
2273 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2274 &$tail: More or equal than last 65558 bytes of the file in a string
2275 (in - Do not alter!).
2277 &$mime: MIME type (out).
2279 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2280 MIME type detected by considering the file extension.
2281 $mimeMagic: Instance of MimeAnalyzer.
2282 $ext: File extension.
2283 &$mime: MIME type (in/out).
2285 'MimeMagicInit': Before processing the list mapping MIME types to media types
2286 and the list mapping MIME types to file extensions.
2287 As an extension author, you are encouraged to submit patches to MediaWiki's
2288 core to add new MIME types to mime.types.
2289 $mimeMagic: Instance of MimeAnalyzer.
2290 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2291 for adding new MIME info to the list.
2292 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2293 for adding new MIME types to the list.
2295 'ModifyExportQuery': Modify the query used by the exporter.
2296 $db: The database object to be queried.
2297 &$tables: Tables in the query.
2298 &$conds: Conditions in the query.
2299 &$opts: Options for the query.
2300 &$join_conds: Join conditions for the query.
2302 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2304 $oldTitle: Title object of the current (old) location
2305 $newTitle: Title object of the new location
2306 $user: User making the move
2307 $reason: string of the reason provided by the user
2308 $status: Status object to pass error messages to
2310 'MovePageIsValidMove': Specify whether a page can be moved for technical
2312 $oldTitle: Title object of the current (old) location
2313 $newTitle: Title object of the new location
2314 $status: Status object to pass error messages to
2316 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2318 $index: Integer; the index of the namespace being checked.
2319 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2320 namespace are movable. Hooks may change this value to override the return
2321 value of NamespaceInfo::isMovable().
2323 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2324 $title: the diff page title (nullable)
2325 &$oldId: the actual old Id to use in the diff
2326 &$newId: the actual new Id to use in the diff (0 means current)
2327 $old: the ?old= param value from the url
2328 $new: the ?new= param value from the url
2330 'NewPagesLineEnding': Called before a NewPages line is finished.
2331 $page: the SpecialNewPages object
2332 &$ret: the HTML line
2333 $row: the database row for this page (the recentchanges record and a few extras
2334 - see NewPagesPager::getQueryInfo)
2335 &$classes: the classes to add to the surrounding <li>
2336 &$attribs: associative array of other HTML attributes for the <li> element.
2337 Currently only data attributes reserved to MediaWiki are allowed
2338 (see Sanitizer::isReservedDataAttribute).
2340 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2342 $wikiPage: the WikiPage edited
2343 $rev: the new revision
2344 $originalRevId: if the edit restores or repeats an earlier revision (such as a
2345 rollback or a null revision), the ID of that earlier revision. False otherwise.
2346 (Used to be called $baseID.)
2347 $user: the editing user
2348 &$tags: tags to apply to the edit and recent change
2350 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2351 return false to omit the line from RecentChanges and Watchlist special pages.
2352 &$changeslist: The OldChangesList instance.
2353 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2354 $rc: The RecentChange object.
2355 &$classes: array of css classes for the <li> element.
2356 &$attribs: associative array of other HTML attributes for the <li> element.
2357 Currently only data attributes reserved to MediaWiki are allowed
2358 (see Sanitizer::isReservedDataAttribute).
2360 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2361 can alter or append to the array of URLs for search & suggestion formats.
2362 &$urls: array of associative arrays with Url element attributes
2364 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2365 when a page view triggers a re-rendering of the page. This may happen
2366 particularly if the parser cache is split by user language, and no cached
2367 rendering of the page exists in the user's language. The hook is called
2368 before checking whether page_links_updated indicates that the links are up
2369 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2370 without triggering any updates.
2371 $page: the Page that was rendered.
2372 $title: the Title of the rendered page.
2373 $parserOutput: ParserOutput resulting from rendering the page.
2375 'OtherAutoblockLogLink': Get links to the autoblock log from extensions which
2376 autoblocks users and/or IP addresses too.
2377 &$otherBlockLink: An array with links to other autoblock logs
2379 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2380 users and/or IP addresses too.
2381 &$otherBlockLink: An array with links to other block logs
2382 $ip: The requested IP address or username
2384 'OutputPageAfterGetHeadLinksArray': Called in OutputPage#getHeadLinksArray right
2385 before returning the result.
2386 &$tags: array containing all <head> links generated so far. The array format is
2387 "link name or number => 'link HTML'".
2388 $out: the OutputPage object
2390 'OutputPageBeforeHTML': A page has been processed by the parser and the
2391 resulting HTML is about to be displayed.
2392 &$parserOutput: the parserOutput (object) that corresponds to the page
2393 &$text: the text that will be displayed, in HTML (string)
2395 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2396 body tag to allow for extensions to add attributes to the body of the page they
2397 might need. Or to allow building extensions to add body classes that aren't of
2398 high enough demand to be included in core.
2399 $out: The OutputPage which called the hook, can be used to get the real title
2400 $sk: The Skin that called OutputPage::headElement
2401 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2403 'OutputPageCheckLastModified': when checking if the page has been modified
2404 since the last visit.
2405 &$modifiedTimes: array of timestamps.
2406 The following keys are set: page, user, epoch
2407 $out: OutputPage object (since 1.28)
2409 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2410 categories. Implementations should return false if they generate the category
2411 links, so the default link generation is skipped.
2412 &$out: OutputPage instance (object)
2413 $categories: associative array, keys are category names, values are category
2414 types ("normal" or "hidden")
2415 &$links: array, intended to hold the result. Must be an associative array with
2416 category types as keys and arrays of HTML links as values.
2418 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2419 &$out: OutputPage instance (object)
2420 $parserOutput: parserOutput instance being added in $out
2422 'PageContentInsertComplete': After a new article is created.
2423 $wikiPage: WikiPage created
2424 $user: User creating the article
2425 $content: New content as a Content object
2426 $summary: Edit summary/comment
2427 $isMinor: Whether or not the edit was marked as minor
2428 $isWatch: (No longer used)
2429 $section: (No longer used)
2430 $flags: Flags passed to WikiPage::doEditContent()
2431 $revision: New Revision of the article
2433 'PageContentLanguage': Allows changing the language in which the content of a
2434 page is written. Defaults to the wiki content language.
2435 $title: Title object
2436 &$pageLang: the page content language. Input can be anything (under control of
2437 hook subscribers), but hooks should return Language objects. Language code
2438 strings are deprecated.
2439 $userLang: the user language (Language object)
2441 'PageContentSave': Before an article is saved.
2442 $wikiPage: the WikiPage (object) being saved
2443 $user: the user (object) saving the article
2444 $content: the new article content, as a Content object
2445 &$summary: CommentStoreComment object containing the edit comment. Can be replaced with a new one.
2446 $isminor: Boolean flag specifying if the edit was marked as minor.
2447 $iswatch: Previously a watch flag. Currently unused, always null.
2448 $section: Previously the section number being edited. Currently unused, always null.
2449 $flags: All EDIT_… flags (including EDIT_MINOR) as an integer number. See WikiPage::doEditContent
2450 documentation for flags' definition.
2451 $status: StatusValue object for the hook handlers resulting status. Either set $status->fatal() or
2452 return false to abort the save action.
2454 'PageContentSaveComplete': After an article has been updated.
2455 $wikiPage: WikiPage modified
2456 $user: User performing the modification
2457 $content: New content, as a Content object
2458 $summary: Edit summary/comment
2459 $isMinor: Whether or not the edit was marked as minor
2460 $isWatch: (No longer used)
2461 $section: (No longer used)
2462 $flags: Flags passed to WikiPage::doEditContent()
2463 $revision: New Revision of the article (can be null for edits that change
2465 $status: Status object about to be returned by doEditContent()
2466 $originalRevId: if the edit restores or repeats an earlier revision (such as a
2467 rollback or a null revision), the ID of that earlier revision. False otherwise.
2468 (Used to be called $baseRevId.)
2469 $undidRevId: the rev ID (or 0) this edit undid
2471 'PageDeletionDataUpdates': Called when constructing a list of DeferrableUpdate to be
2472 executed when a page is deleted.
2473 $title The Title of the page being deleted.
2474 $revision A RevisionRecord representing the page's current revision at the time of deletion.
2475 &$updates A list of DeferrableUpdate that can be manipulated by the hook handler.
2477 'PageHistoryBeforeList': When a history page list is about to be constructed.
2478 &$article: the article that the history is loading for
2479 $context: RequestContext object
2481 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2482 $historyAction: the action object
2483 &$row: the revision row for this line
2484 &$s: the string representing this parsed line
2485 &$classes: array containing the <li> element classes
2486 &$attribs: associative array of other HTML attributes for the <li> element.
2487 Currently only data attributes reserved to MediaWiki are allowed
2488 (see Sanitizer::isReservedDataAttribute).
2490 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2491 any output is generated, to allow batch lookups for prefetching information
2492 needed for display. If the hook handler returns false, the regular behavior of
2493 doBatchLookups() is skipped.
2494 $pager: the PageHistoryPager
2495 $result: a ResultWrapper representing the query result
2497 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2500 &$queryInfo: the query parameters
2502 'PageRenderingHash': NOTE: Consider using ParserOptionsRegister instead.
2503 Alter the parser cache option hash key. A parser extension
2504 which depends on user options should install this hook and append its values to
2506 &$confstr: reference to a hash key string which can be modified
2507 $user: User (object) requesting the page
2508 &$forOptions: array of options the hash is for
2510 'PageViewUpdates': Allow database (or other) changes to be made after a
2511 page view is seen by MediaWiki. Note this does not capture views made
2512 via external caches such as Squid.
2513 $wikipage: WikiPage (object) for the page being viewed.
2514 $user: User (object) for the user who is viewing.
2516 'ParserAfterParse': Called from Parser::parse() just after the call to
2517 Parser::internalParse() returns.
2518 &$parser: parser object
2519 &$text: text being parsed
2520 &$stripState: stripState used (object)
2522 'ParserAfterStrip': Called at end of parsing time.
2523 TODO: No more strip, deprecated ?
2524 &$parser: parser object
2525 &$text: text being parsed
2526 &$stripState: stripState used (object)
2528 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2529 &$parser: Parser object being used
2530 &$text: text that will be returned
2532 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2533 Parser::internalParseHalfParsed()
2534 &$parser: Parser object being used
2535 &$text: text that will be returned
2537 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2538 &$parser: Parser object
2539 &$text: text to parse
2540 &$stripState: StripState instance being used
2542 'ParserBeforeStrip': Called at start of parsing time.
2543 TODO: No more strip, deprecated ?
2544 &$parser: parser object
2545 &$text: text being parsed
2546 &$stripState: stripState used (object)
2548 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2549 &$parser: Parser object being used
2552 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2554 $parserCache: ParserCache object $parserOutput was stored in
2555 $parserOutput: ParserOutput object that was stored
2556 $title: Title of the page that was parsed to generate $parserOutput
2557 $popts: ParserOptions used for generating $parserOutput
2558 $revId: ID of the revision that was parsed to create $parserOutput
2560 'ParserClearState': Called at the end of Parser::clearState().
2561 &$parser: Parser object being cleared
2563 'ParserCloned': Called when the parser is cloned.
2564 $parser: Newly-cloned Parser object
2566 'ParserFetchTemplate': Called when the parser fetches a template
2567 $parser: Parser Parser object or false
2568 $title: Title object of the template to be fetched
2569 $rev: Revision object of the template
2570 &$text: Transclusion text of the template or false or null
2571 &$deps: Array of template dependencies with 'title', 'page_id', 'rev_id' keys
2573 'ParserFirstCallInit': Called when the parser initialises for the first time.
2574 &$parser: Parser object being cleared
2576 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2578 &$parser: Parser object
2579 &$varCache: array to store the value in case of multiples calls of the
2581 &$index: index (string) of the magic
2582 &$ret: value of the magic word (the hook should set it)
2583 &$frame: PPFrame object to use for expanding any template variables
2585 'ParserGetVariableValueTs': Use this to change the value of the time for the
2586 {{LOCAL...}} magic word.
2587 &$parser: Parser object
2588 &$time: actual time (timestamp)
2590 'ParserGetVariableValueVarCache': use this to change the value of the variable
2591 cache or return false to not use it.
2592 &$parser: Parser object
2593 &$varCache: variable cache (array)
2595 'ParserLimitReportFormat': Called for each row in the parser limit report that
2596 needs formatting. If nothing handles this hook, the default is to use "$key" to
2597 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2599 $key: Key for the limit report item (string)
2600 &$value: Value of the limit report item
2601 &$report: String onto which to append the data
2602 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2603 text intended for display in a monospaced font.
2604 $localize: If false, $report should be output in English.
2606 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2607 will include comments about size of the text parsed. Hooks should use
2608 $output->setLimitReportData() to populate data. Functions for this hook should
2609 not use $wgLang; do that in ParserLimitReportFormat instead.
2610 $parser: Parser object
2611 $output: ParserOutput object
2613 'ParserMakeImageParams': Called before the parser make an image link, use this
2614 to modify the parameters of the image.
2615 $title: title object representing the file
2616 $file: file object that will be used to create the image
2617 &$params: 2-D array of parameters
2618 $parser: Parser object that called the hook
2620 'ParserOptionsRegister': Register additional parser options. Note that if you
2621 change the default value for an option, all existing parser cache entries will
2622 be invalid. To avoid bugs, you'll need to handle that somehow (e.g. with the
2623 RejectParserCacheValue hook) because MediaWiki won't do it for you.
2624 &$defaults: Set the default value for your option here.
2625 &$inCacheKey: To fragment the parser cache on your option, set a truthy value
2627 &$lazyLoad: To lazy-initialize your option, set it null in $defaults and set a
2628 callable here. The callable is passed the ParserOptions object and the option
2631 'ParserOutputPostCacheTransform': Called from ParserOutput::getText() to do
2632 post-cache transforms.
2633 $parserOutput: The ParserOutput object.
2634 &$text: The text being transformed, before core transformations are done.
2635 &$options: The options array being used for the transformation.
2637 'ParserSectionCreate': Called each time the parser creates a document section
2638 from wikitext. Use this to apply per-section modifications to HTML (like
2639 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2640 can begin in one section and end in another. Make sure your code can handle
2641 that case gracefully. See the EditSectionClearerLink extension for an example.
2642 $parser: the calling Parser instance
2643 $section: the section number, zero-based, but section 0 is usually empty
2644 &$sectionContent: ref to the content of the section. modify this.
2645 $showEditLinks: boolean describing whether this section has an edit link
2647 'ParserTestGlobals': Allows to define globals for parser tests.
2648 &$globals: Array with all the globals which should be set for parser tests.
2649 The arrays keys serve as the globals names, its values are the globals values.
2651 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2652 run. Use when page save hooks require the presence of custom tables to ensure
2653 that tests continue to run properly.
2654 &$tables: array of table names
2656 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the
2658 $page: the WikiPage of the candidate edit
2659 $content: the Content object of the candidate edit
2660 $output: the ParserOutput result of the candidate edit
2661 $summary: the change summary of the candidate edit
2662 $user: the User considering the edit
2664 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2665 $user: User object whose policy you are modifying
2666 &$effectivePolicy: Array of policy statements that apply to this user
2668 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2670 $block: Block object (which is set to be autoblocking)
2671 &$blockIds: Array of block IDs of the autoblock
2673 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2674 my talk page, my contributions" etc).
2675 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2676 &$title: Title object representing the current page
2677 $skin: SkinTemplate object providing context (e.g. to check if the user is
2680 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2681 &$user: User performing the action
2682 $action: Action being performed
2683 &$result: Whether or not the action should be prevented
2684 Change $result and return false to give a definitive answer, otherwise
2685 the built-in rate limiting checks are used, if enabled.
2686 $incrBy: Amount to increment counter by
2688 'PlaceNewSection': Override placement of new sections. Return false and put the
2689 merged text into $text to override the default behavior.
2690 $wikipage: WikiPage object
2691 $oldtext: the text of the article before editing
2692 $subject: subject of the new section
2693 &$text: text of the new section
2695 'PostLoginRedirect': Modify the post login redirect behavior.
2696 Occurs after signing up or logging in, allows for interception of redirect.
2697 &$returnTo: The page name to return to, as a string
2698 &$returnToQuery: array of url parameters, mapping parameter names to values
2699 &$type: type of login redirect as string;
2700 error: display a return to link ignoring $wgRedirectOnLogin
2701 signup: display a return to link using $wgRedirectOnLogin if needed
2702 success: display a return to link using $wgRedirectOnLogin if needed
2703 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2705 'PreferencesFormPreSave': Override preferences being saved
2706 $formData: array of user submitted data
2707 $form: HTMLForm object, also a ContextSource
2708 $user: User object with preferences to be saved set
2709 &$result: boolean indicating success
2710 $oldUserOptions: array with user old options (before save)
2712 'PreferencesGetLegend': Override the text used for the <legend> of a
2713 preferences section.
2714 $form: the HTMLForm object. This is a ContextSource as well
2715 $key: the section name
2716 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2719 'PrefixSearchBackend': DEPRECATED since 1.27! Override
2720 SearchEngine::completionSearchBackend instead.
2721 Override the title prefix search used for OpenSearch and
2722 AJAX search suggestions. Put results into &$results outparam and return false.
2723 $ns: array of int namespace keys to search in
2724 $search: search term (not guaranteed to be conveniently normalized)
2725 $limit: maximum number of results to return
2726 &$results: out param: array of page names (strings)
2727 $offset: number of results to offset from the beginning
2729 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2730 namespace from the search string so that extensions can attempt it.
2731 &$namespaces: array of int namespace keys to search in (change this if you can
2733 &$search: search term (replace this with term without the namespace if you can
2736 'PrefsEmailAudit': Called when user changes their email address.
2737 $user: User (object) changing his email address
2738 $oldaddr: old email address (string)
2739 $newaddr: new email address (string)
2741 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2743 $article: the title being (un)protected
2744 &$output: a string of the form HTML so far
2746 'ProtectionForm::save': Called when a protection form is submitted.
2747 $article: the Page being (un)protected
2748 &$errorMsg: an html message string of an error or an array of message name and
2750 $reasonstr: a string describing the reason page protection level is altered
2752 'ProtectionForm::showLogExtract': Called after the protection log extract is
2754 $article: the page the form is shown for
2755 $out: OutputPage object
2757 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2759 &$tables: Database tables to be used in the query
2760 &$conds: Conditions to be applied in the query
2761 &$joinConds: Join conditions to be applied in the query
2763 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2764 &$obj: RawAction object
2765 &$text: The text that's going to be the output
2767 'RecentChange_save': Called at the end of RecentChange::save().
2768 &$recentChange: RecentChange object
2770 'RecentChangesPurgeRows': Called when old recentchanges rows are purged, after
2771 deleting those rows but within the same transaction.
2772 $rows: The deleted rows as an array of recentchanges row objects (with up to
2773 $wgUpdateRowsPerQuery items).
2775 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2776 names such as "oldid" that are preserved when using redirecting special pages
2777 such as Special:MyPage and Special:MyTalk.
2778 &$redirectParams: An array of parameters preserved by redirecting special pages.
2780 'RejectParserCacheValue': Return false to reject an otherwise usable
2781 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2782 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2784 $parserOutput: ParserOutput value.
2785 $wikiPage: WikiPage object.
2786 $parserOptions: ParserOptions object.
2788 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2789 instance. Can be used by an extension override what skin is used in certain
2791 $context: (IContextSource) The RequestContext the skin is being created for.
2792 &$skin: A variable reference you may set a Skin instance or string key on to
2793 override the skin that will be used for the context.
2795 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2796 flagged to lack same-origin security. Return false to indicate the lack. Note
2797 if the "somehow" involves HTTP headers, you'll probably need to make sure
2798 the header is varied on.
2799 $request: The WebRequest object.
2801 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2802 $user: The user having their password expiration reset
2803 &$newExpire: The new expiration date
2805 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2806 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2807 to override its behavior. See the module docs for more information.
2808 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2810 $context: ResourceLoaderContext|null
2812 'ResourceLoaderGetConfigVars': Called at the end of
2813 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2814 configuration variables to JavaScript. Things that depend on the current page
2815 or request state must be added through MakeGlobalVariablesScript instead.
2816 Skin is made available for skin specific config.
2817 &$vars: [ variable name => value ]
2820 'ResourceLoaderJqueryMsgModuleMagicWords': Called in
2821 ResourceLoaderJqueryMsgModule to allow adding magic words for jQueryMsg.
2822 The value should be a string, and they can depend only on the
2823 ResourceLoaderContext.
2824 $context: ResourceLoaderContext
2825 &$magicWords: Associative array mapping all-caps magic word to a string value
2827 'ResourceLoaderRegisterModules': Right before modules information is required,
2828 such as when responding to a resource
2829 loader request or generating HTML output.
2830 &$resourceLoader: ResourceLoader object
2832 'ResourceLoaderTestModules': DEPRECATED since 1.33! Register ResourceLoader modules
2833 that are only available when `$wgEnableJavaScriptTest` is true. Use this for test
2834 suites and other test-only resources.
2835 &$testModules: one array of modules per test framework. The modules array
2836 follows the same format as `$wgResourceModules`. For example:
2837 $testModules['qunit']['ext.Example.test'] = [
2838 'localBasePath' => __DIR__ . '/tests/qunit',
2839 'remoteExtPath' => 'Example/tests/qunit',
2840 'script' => [ 'tests/qunit/foo.js' ],
2841 'dependencies' => [ 'ext.Example.foo' ]
2843 &$ResourceLoader: object
2845 'RevisionDataUpdates': Called when constructing a list of DeferrableUpdate to be
2846 executed to record secondary data about a revision.
2847 $title The Title of the page the revision belongs to
2848 $renderedRevision a RenderedRevision object representing the new revision and providing access
2849 to the RevisionRecord as well as ParserOutput of that revision.
2850 &$updates A list of DeferrableUpdate that can be manipulated by the hook handler.
2852 'RevisionRecordInserted': Called after a revision is inserted into the database.
2853 $revisionRecord: the RevisionRecord that has just been inserted.
2855 'RevisionInsertComplete': DEPRECATED since 1.31! Use RevisionRecordInserted hook
2856 instead. Called after a revision is inserted into the database.
2857 $revision: the Revision
2858 $data: DEPRECATED! Always null!
2859 $flags: DEPRECATED! Always null!
2861 'SearchableNamespaces': An option to modify which namespaces are searchable.
2862 &$arr: Array of namespaces ($nsId => $name) which will be used.
2864 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2865 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2867 $term: Search term string
2868 &$title: Outparam; set to $title object and return false for a match
2870 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2871 if nothing was found.
2872 $term: Search term string
2873 &$title: Outparam; set to $title object and return false for a match
2875 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2876 the normal operations.
2877 $allSearchTerms: Array of the search terms in all content languages
2878 &$titleResult: Outparam; the value to return. A Title object or null.
2880 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2882 $term: Search term string
2883 &$title: Current Title object that is being returned (null if none found).
2885 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2887 $title: Current Title object being displayed in search results.
2888 &$id: Revision ID (default is false, for latest)
2890 'SearchIndexFields': Add fields to search index mapping.
2891 &$fields: Array of fields, all implement SearchIndexField
2892 $engine: SearchEngine instance for which mapping is being built.
2894 'SearchDataForIndex': Add data to search document. Allows to add any data to
2895 the field map used to index the document.
2896 &$fields: Array of name => value pairs for fields
2897 $handler: ContentHandler for the content being indexed
2898 $page: WikiPage that is being indexed
2899 $output: ParserOutput that is produced from the page
2900 $engine: SearchEngine for which the indexing is intended
2902 'SearchResultsAugment': Allows extension to add its code to the list of search
2904 &$setAugmentors: List of whole-set augmentor objects, must implement
2906 &$rowAugmentors: List of per-row augmentor objects, must implement
2908 Note that lists should be in the format name => object and the names in both
2909 lists should be distinct.
2911 'SecondaryDataUpdates': DEPRECATED! Use RevisionDataUpdates or override
2912 ContentHandler::getSecondaryDataUpdates instead.
2913 Allows modification of the list of DataUpdates to perform when page content is modified.
2914 $title: Title of the page that is being edited.
2915 $oldContent: Content object representing the page's content before the edit.
2916 $recursive: bool indicating whether DataUpdates should trigger recursive
2917 updates (relevant mostly for LinksUpdate).
2918 $parserOutput: ParserOutput representing the rendered version of the page
2920 &$updates: a list of DataUpdate objects, to be modified or replaced by
2923 'SecuritySensitiveOperationStatus': Affect the return value from
2924 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2925 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2926 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2927 authentication isn't possible for the current session type.
2928 $operation: (string) The operation being checked.
2929 $session: (MediaWiki\Session\Session) The current session. The
2930 currently-authenticated user may be retrieved as $session->getUser().
2931 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2932 the time of last auth is unknown, or -1 if authentication is not possible.
2934 'SelfLinkBegin': Called before a link to the current article is displayed to
2935 allow the display of the link to be customized.
2936 $nt: the Title object
2937 &$html: html to display for the link
2938 &$trail: optional text to display before $html
2939 &$prefix: optional text to display after $html
2940 &$ret: the value to return if your hook returns false
2942 'SendWatchlistEmailNotification': Return true to send watchlist email
2944 $targetUser: the user whom to send watchlist email notification
2945 $title: the page title
2946 $enotif: EmailNotification object
2948 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2949 loaded from storage. Return false to prevent it from being used.
2950 &$reason: String rejection reason to be logged
2951 $info: MediaWiki\Session\SessionInfo being validated
2952 $request: WebRequest being loaded from
2953 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2954 $data: Array|false Data array for the MediaWiki\Session\Session
2956 'SessionMetadata': Add metadata to a session being saved.
2957 $backend: MediaWiki\Session\SessionBackend being saved.
2958 &$metadata: Array Metadata to be stored. Add new keys here.
2959 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2960 request and 0+ FauxRequests.
2962 'SetupAfterCache': Called in Setup.php, after cache objects are set
2964 'ShortPagesQuery': Allow extensions to modify the query used by
2966 &$tables: tables to join in the query
2967 &$conds: conditions for the query
2968 &$joinConds: join conditions for the query
2969 &$options: options for the query
2971 'ShowMissingArticle': Called when generating the output for a non-existent page.
2972 $article: The article object corresponding to the page
2974 'ShowSearchHit': Customize display of search hit.
2975 $searchPage: The SpecialSearch instance.
2976 $result: The SearchResult to show
2977 $terms: Search terms, for highlighting (unreliable as search engine dependent).
2978 &$link: HTML of link to the matching page. May be modified.
2979 &$redirect: HTML of redirect info. May be modified.
2980 &$section: HTML of matching section. May be modified.
2981 &$extract: HTML of content extract. May be modified.
2982 &$score: HTML of score. May be modified.
2983 &$size: HTML of page size. May be modified.
2984 &$date: HTML of of page modification date. May be modified.
2985 &$related: HTML of additional info for the matching page. May be modified.
2986 &$html: May be set to the full HTML that should be used to represent the search
2987 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2988 function returned false.
2990 'ShowSearchHitTitle': Customise display of search hit title/link.
2991 &$title: Title to link to
2992 &$titleSnippet: Label for the link representing the search result. Typically the
2994 $result: The SearchResult object
2995 $terms: array of search terms extracted by SearchDatabase search engines
2996 (may not be populated by other search engines).
2997 $specialSearch: The SpecialSearch object
2998 &$query: Array of query string parameters for the link representing the search
3000 &$attributes: Array of title link attributes, can be modified by extension.
3002 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
3003 Warning: This hook is run on each display. You should consider to use
3004 'SkinBuildSidebar' that is aggressively cached.
3006 &$bar: Sidebar content
3007 Modify $bar to add or modify sidebar portlets.
3009 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
3010 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
3011 the sitenotice/anonnotice.
3014 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
3015 allow the normal method of notice selection/rendering to work, or change the
3016 value of $siteNotice and return false to alter it.
3017 &$siteNotice: HTML returned as the sitenotice
3020 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
3022 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
3023 the stock bottom scripts.
3025 'SkinAfterContent': Allows extensions to add text after the page content and
3026 article metadata. This hook should work in all skins. Set the &$data variable to
3027 the text you're going to add.
3028 &$data: (string) Text to be printed out directly (without parsing)
3031 'SkinBuildSidebar': At the end of Skin::buildSidebar().
3033 &$bar: Sidebar contents
3034 Modify $bar to add or modify sidebar portlets.
3036 'SkinCopyrightFooter': Allow for site and per-namespace customization of
3038 $title: displayed page title
3039 $type: 'normal' or 'history' for old/diff views
3040 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
3041 message must be in HTML format, not wikitext!
3042 &$link: overridable HTML link to be passed into the message as $1
3043 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
3046 'SkinEditSectionLinks': Modify the section edit links
3047 $skin: Skin object rendering the UI
3048 $title: Title object for the title being linked to (may not be the same as
3049 the page title, if the section is included from a template)
3050 $section: The designation of the section being pointed to, to be included in
3051 the link, like "§ion=$section"
3052 $tooltip: The default tooltip. Escape before using.
3053 By default, this is wrapped in the 'editsectionhint' message.
3054 &$result: Array containing all link detail arrays. Each link detail array should
3055 contain the following keys:
3056 - targetTitle - Target Title object
3057 - text - String for the text
3058 - attribs - Array of attributes
3059 - query - Array of query parameters to add to the URL
3060 $lang: The language code to use for the link in the wfMessage function
3062 'SkinGetPoweredBy': TODO
3063 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
3064 the MediaWiki icon but plain text instead.
3067 'SkinPreloadExistence': Supply titles that should be added to link existence
3068 cache before the page is rendered.
3069 &$titles: Array of Title objects
3072 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
3073 If false is returned $subpages will be used instead of the HTML
3074 subPageSubtitle() generates.
3075 If true is returned, $subpages will be ignored and the rest of
3076 subPageSubtitle() will run.
3077 &$subpages: Subpage links HTML
3079 $out: OutputPage object
3081 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
3083 &$sktemplate: SkinTemplate object
3084 &$nav_urls: array of tabs
3085 &$revid: The revision id of the permanent link
3086 &$revid2: The revision id of the permanent link, second time
3088 'SkinTemplateGetLanguageLink': After building the data for a language link from
3089 which the actual html is constructed.
3090 &$languageLink: array containing data about the link. The following keys can be
3091 modified: href, text, title, class, lang, hreflang. Each of them is a string.
3092 $languageLinkTitle: Title object belonging to the external language link.
3093 $title: Title object of the page the link belongs to.
3094 $outputPage: The OutputPage object the links are built from.
3096 'SkinTemplateNavigation': Called on content pages after the tabs have been
3097 added, but before variants have been added.
3098 &$sktemplate: SkinTemplate object
3099 &$links: Structured navigation links. This is used to alter the navigation for
3100 skins which use buildNavigationUrls such as Vector.
3102 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
3103 tab is added but before variants have been added.
3104 &$sktemplate: SkinTemplate object
3105 &$links: Structured navigation links. This is used to alter the navigation for
3106 skins which use buildNavigationUrls such as Vector.
3108 'SkinTemplateNavigation::Universal': Called on both content and special pages
3109 after variants have been added.
3110 &$sktemplate: SkinTemplate object
3111 &$links: Structured navigation links. This is used to alter the navigation for
3112 skins which use buildNavigationUrls such as Vector.
3114 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
3116 &$sktemplate: SkinTemplate object
3117 &$tpl: QuickTemplate engine object
3119 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
3120 &$sktemplate: SkinTemplate object
3121 &$res: set to true to prevent active tabs
3123 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
3124 You can either create your own array, or alter the parameters for
3126 &$sktemplate: The SkinTemplate instance.
3127 $title: Title instance for the page.
3128 $message: Visible label of tab.
3129 $selected: Whether this is a selected tab.
3130 $checkEdit: Whether or not the action=edit query should be added if appropriate.
3131 &$classes: Array of CSS classes to apply.
3132 &$query: Query string to add to link.
3134 &$result: Complete assoc. array if you want to return true.
3136 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
3137 been rendered (useful for adding more).
3138 &$sk: The QuickTemplate based skin template running the hook.
3139 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3140 extensions that add support for BaseTemplateToolbox should watch for this
3141 dummy parameter with "$dummy=false" in their code and return without echoing
3142 any HTML to avoid creating duplicate toolbox items.
3144 'SoftwareInfo': Called by Special:Version for returning information about the
3146 &$software: The array of software in format 'name' => 'version'. See
3147 SpecialVersion::softwareInformation().
3149 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3150 $sp: SpecialPage object, for context
3151 &$fields: Current HTMLForm fields
3153 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3154 $id: User id number, only provided for backwards-compatibility
3155 $user: User object representing user contributions are being fetched for
3156 $sp: SpecialPage instance, providing context
3158 'SpecialContributions::formatRow::flags': Called before rendering a
3159 Special:Contributions row.
3160 $context: IContextSource object
3161 $row: Revision information from the database
3162 &$flags: List of flags on this row
3164 'SpecialContributions::getForm::filters': Called with a list of filters to render
3165 on Special:Contributions.
3166 $sp: SpecialContributions object, for context
3167 &$filters: List of filters rendered as HTML
3169 'SpecialListusersDefaultQuery': Called right before the end of
3170 UsersPager::getDefaultQuery().
3171 $pager: The UsersPager instance
3172 &$query: The query array to be returned
3174 'SpecialListusersFormatRow': Called right before the end of
3175 UsersPager::formatRow().
3176 &$item: HTML to be returned. Will be wrapped in an <li> after the hook finishes
3177 $row: Database row object
3179 'SpecialListusersHeader': Called after adding the submit button in
3180 UsersPager::getPageHeader().
3181 $pager: The UsersPager instance
3182 &$out: The header HTML
3184 'SpecialListusersHeaderForm': Called before adding the submit button in
3185 UsersPager::getPageHeader().
3186 $pager: The UsersPager instance
3187 &$out: The header HTML
3189 'SpecialListusersQueryInfo': Called right before the end of.
3190 UsersPager::getQueryInfo()
3191 $pager: The UsersPager instance
3192 &$query: The query array to be returned
3194 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3195 $type: String of the log type
3196 $request: WebRequest object for getting the value provided by the current user
3197 &$qc: Array for query conditions to add
3199 'SpecialMovepageAfterMove': Called after moving a page.
3200 &$movePage: MovePageForm object
3201 &$oldTitle: old title (object)
3202 &$newTitle: new title (object)
3204 'SpecialMuteModifyFormFields': Add more fields to Special:Mute
3205 $sp: SpecialPage object, for context
3206 &$fields: Current HTMLForm fields descriptors
3208 'SpecialNewpagesConditions': Called when building sql query for
3210 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3211 $opts: FormOptions object containing special page options
3212 &$conds: array of WHERE conditionals for query
3213 &$tables: array of tables to be queried
3214 &$fields: array of columns to select
3215 &$join_conds: join conditions for the tables
3217 'SpecialNewPagesFilters': Called after building form options at NewPages.
3218 $special: the special page object
3219 &$filters: associative array of filter definitions. The keys are the HTML
3220 name/URL parameters. Each key maps to an associative array with a 'msg'
3221 (message key) and a 'default' value.
3223 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3224 this hook to remove a core special page or conditionally register special pages.
3225 &$list: list (array) of core special pages
3227 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3228 $special: the SpecialPage object
3229 $subPage: the subpage string or null if no subpage was specified
3231 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3232 Return false to prevent execution.
3233 $special: the SpecialPage object
3234 $subPage: the subpage string or null if no subpage was specified
3236 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3237 $name: name of the special page
3238 &$form: HTMLForm object
3240 'SpecialPasswordResetOnSubmit': When executing a form submission on
3241 Special:PasswordReset.
3242 &$users: array of User objects.
3243 $data: array of data submitted by the user
3244 &$error: string, error code (message key) used to describe to error (out
3245 parameter). The hook needs to return false when setting this, otherwise it
3246 will have no effect.
3248 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3249 use this to change some selection criteria or substitute a different title.
3250 &$randstr: The random number from wfRandom()
3251 &$isRedir: Boolean, whether to select a redirect or non-redirect
3252 &$namespaces: An array of namespace indexes to get the title from
3253 &$extra: An array of extra SQL statements
3254 &$title: If the hook returns false, a Title object to use instead of the
3255 result from the normal query
3257 'SpecialRecentChangesPanel': Called when building form options in
3258 SpecialRecentChanges.
3259 &$extraOpts: array of added items, to which can be added
3260 $opts: FormOptions for this request
3262 'SpecialResetTokensTokens': Called when building token list for
3264 &$tokens: array of token information arrays in the format of
3266 'preference' => '<preference-name>',
3267 'label-message' => '<message-key>',
3270 'SpecialSearchCreateLink': Called when making the message to create a page or
3271 go to the existing page.
3272 $t: title object searched for
3273 &$params: an array of the default message name and page title (as parameter)
3275 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3276 canceled and a normal search will be performed. Returning true without setting
3277 $url does a standard redirect to $title. Setting $url redirects to the
3279 $term: The string the user searched for
3280 $title: The title the 'go' feature has decided to forward the user to
3281 &$url: Initially null, hook subscribers can set this to specify the final url to
3284 'SpecialSearchNogomatch': Called when the 'Go' feature is triggered (generally
3285 from autocomplete search other than the main bar on Special:Search) and the
3286 target doesn't exist. Full text search results are generated after this hook is
3288 &$title: title object generated from the text entered by the user
3290 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3291 the advanced form, a.k.a. power search box.
3292 &$showSections: an array to add values with more options to
3293 $term: the search term (not a title object)
3294 &$opts: an array of hidden options (containing 'redirs' and 'profile')
3296 'SpecialSearchProfileForm': Allows modification of search profile forms.
3297 $search: special page object
3298 &$form: String: form html
3299 $profile: String: current search profile
3300 $term: String: search term
3301 $opts: Array: key => value of hidden options for inclusion in custom forms
3303 'SpecialSearchProfiles': Allows modification of search profiles.
3304 &$profiles: profiles, which can be modified.
3306 'SpecialSearchResults': Called before search result display
3307 $term: string of search term
3308 &$titleMatches: empty or ISearchResultSet object
3309 &$textMatches: empty or ISearchResultSet object
3311 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3312 on the search results page. Useful for including an external search
3313 provider. To disable the output of MediaWiki search output, return
3315 $specialSearch: SpecialSearch object ($this)
3317 $term: Search term specified by the user
3319 'SpecialSearchResultsAppend': Called immediately before returning HTML
3320 on the search results page. Useful for including a feedback link.
3321 $specialSearch: SpecialSearch object ($this)
3323 $term: Search term specified by the user
3325 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3326 $search: SpecialSearch special page object
3327 $profile: String: current search profile
3328 $engine: the search engine
3330 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3331 &$extraStats: Array to save the new stats
3332 $extraStats['<name of statistic>'] => <value>;
3333 <value> can be an array with the keys "name" and "number":
3334 "name" is the HTML to be displayed in the name column
3335 "number" is the number to be displayed.
3336 or, <value> can be the number to be displayed and <name> is the
3337 message key to use in the name column,
3338 $context: IContextSource object
3340 'SpecialTrackingCategories::preprocess': Called after LinkBatch on
3341 Special:TrackingCategories
3342 $specialPage: The SpecialTrackingCategories object
3343 $trackingCategories: Array of data from Special:TrackingCategories with msg and
3346 'SpecialTrackingCategories::generateCatLink': Called for each cat link on
3347 Special:TrackingCategories
3348 $specialPage: The SpecialTrackingCategories object
3349 $catTitle: The Title object of the linked category
3350 &$html: The Result html
3352 'SpecialUploadComplete': Called after successfully uploading a file from
3354 &$form: The SpecialUpload object
3356 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3357 $wgVersion: Current $wgVersion for you to use
3358 &$versionUrl: Raw url to link to (eg: release notes)
3360 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3361 SpecialWatchlist. Allows extensions to register custom values they have
3362 inserted to rc_type so they can be returned as part of the watchlist.
3363 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3365 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3366 URL for a title when we have no other parameters on the URL. Gives a chance for
3367 extensions that alter page view behavior radically to abort that redirect or
3369 $request: WebRequest
3370 $title: Title of the currently found title obj
3371 $output: OutputPage object
3373 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3374 rendered (by ThumbnailImage:toHtml method).
3375 $thumbnail: the ThumbnailImage object
3376 &$attribs: image attribute array
3377 &$linkAttribs: image link attribute array
3379 'TitleArrayFromResult': Called when creating an TitleArray object from a
3381 &$titleArray: set this to an object to override the default object returned
3382 $res: database result used to create the object
3384 'TitleExists': Called when determining whether a page exists at a given title.
3385 $title: The title being tested.
3386 &$exists: Whether the title exists.
3388 'TitleGetEditNotices': Allows extensions to add edit notices
3389 $title: The Title object for the page the edit notices are for
3390 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3391 &$notices: Array of notices. Keys are i18n message keys, values are
3392 parseAsBlock()ed messages.
3394 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3395 that can be applied.
3396 $title: The title in question.
3397 &$types: The types of protection available.
3399 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3400 overriding default behavior for determining if a page exists. If $isKnown is
3401 kept as null, regular checks happen. If it's a boolean, this value is returned
3402 by the isKnown method.
3403 $title: Title object that is being checked
3404 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3406 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3407 that this hook is not called for interwiki pages or pages in immovable
3408 namespaces: for these, isMovable() always returns false.
3409 $title: Title object that is being checked
3410 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3411 Hooks may change this value to override the return value of
3415 'TitleMove': Before moving an article (title).
3418 $user: user who does the move
3419 $reason: string of the reason provided by the user
3420 &$status: Status object. To abort the move, add a fatal error to this object
3421 (i.e. call $status->fatal()).
3423 'TitleMoveStarting': Before moving an article (title), but just after the atomic
3427 $user: user who does the move
3429 'TitleMoveComplete': After moving an article (title), post-commit.
3432 &$user: user who did the move
3433 $pageid: database ID of the page that's been moved
3434 $redirid: database ID of the created redirect
3435 $reason: reason for the move
3436 $revision: the Revision created by the move
3438 'TitleMoveCompleting': After moving an article (title), pre-commit.
3441 $user: user who did the move
3442 $pageid: database ID of the page that's been moved
3443 $redirid: database ID of the created redirect
3444 $reason: reason for the move
3445 $revision: the Revision created by the move
3447 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3448 or override the quick permissions check.
3449 $title: The Title object being accessed
3450 $user: The User performing the action
3451 $action: Action being performed
3452 &$errors: Array of errors
3453 $doExpensiveQueries: Whether to do expensive DB queries
3454 $short: Whether to return immediately on first error
3456 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3457 adding the default error message if nothing allows the user to read the page. If
3458 a handler wants a title to *not* be whitelisted, it should also return false.
3459 $title: Title object being checked against
3460 $user: Current user object
3461 &$whitelisted: Boolean value of whether this title is whitelisted
3463 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3464 $title: Title object to purge
3465 &$urls: An array of URLs to purge from the caches, to be manipulated.
3467 'UnblockUser': Before an IP address or user is unblocked.
3468 &$block: The Block object about to be saved
3469 &$user: The user performing the unblock (not the one being unblocked)
3470 &$reason: If the hook is aborted, the error message to be returned in an array
3472 'UnblockUserComplete': After an IP address or user has been unblocked.
3473 $block: The Block object that was saved
3474 $user: The user who performed the unblock (not the one being unblocked)
3476 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3477 PageArchive object has been created but before any further processing is done.
3478 &$archive: PageArchive object
3479 $title: Title object of the page that we're viewing
3481 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3482 PageArchive object has been created but before any further processing is done.
3483 &$archive: PageArchive object
3484 $title: Title object of the page that we're viewing
3486 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3487 the site is not in read-only mode, that the Title object is not null and after
3488 a PageArchive object has been constructed but before performing any further
3490 &$archive: PageArchive object
3491 $title: Title object of the page that we're about to undelete
3493 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3494 $title: title object related to the revision
3495 $rev: revision (object) that will be viewed
3497 'UnitTestsAfterDatabaseSetup': Called right after MediaWiki's test
3498 infrastructure has finished creating/duplicating core tables for unit tests.
3499 $database: Database in question
3500 $prefix: Table prefix to be used in unit tests
3502 'UnitTestsBeforeDatabaseTeardown': Called right before MediaWiki tears down its
3503 database infrastructure used for unit tests.
3505 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3506 Since 1.24: Paths pointing to a directory will be recursively scanned for
3507 test case files matching the suffix "Test.php".
3508 &$paths: list of test cases and directories to search.
3510 'UnwatchArticle': Before a watch is removed from an article.
3511 &$user: user watching
3512 &$page: WikiPage object to be removed
3513 &$status: Status object to be returned if the hook returns false
3515 'UnwatchArticleComplete': After a watch is removed from an article.
3516 $user: user that watched
3517 &$page: WikiPage object that was watched
3519 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3520 &$formattedPageStatus: list of valid page states
3522 'UploadComplete': Upon completion of a file upload.
3523 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3524 $uploadBase->getLocalFile().
3526 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3527 $type: (string) the requested upload type
3528 &$className: the class name of the Upload instance to be created
3530 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3531 poke at member variables like $mUploadDescription before the file is saved.
3532 Do not use this hook to break upload processing.
3533 This will return the user to a blank form with no error message;
3534 use UploadVerifyUpload or UploadVerifyFile instead.
3535 &$upload: SpecialUpload object
3537 'UploadForm:getInitialPageText': After the initial page text for file uploads
3538 is generated, to allow it to be altered.
3539 &$pageText: the page text
3540 $msg: array of header messages
3541 $config: Config object
3543 'UploadForm:initial': Before the upload form is generated. You might set the
3544 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3545 text (HTML) either before or after the editform.
3546 &$upload: SpecialUpload object
3548 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3550 &$descriptor: (array) the HTMLForm descriptor
3552 'UploadFormSourceDescriptors': after the standard source inputs have been
3553 added to the descriptor
3554 &$descriptor: (array) the HTMLForm descriptor
3555 &$radio: Boolean, if source type should be shown as radio button
3556 $selectedSourceType: The selected source type
3558 'UploadStashFile': Before a file is stashed (uploaded to stash).
3559 Note that code which has not been updated for MediaWiki 1.28 may not call this
3560 hook. If your extension absolutely, positively must prevent some files from
3561 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3562 $upload: (object) An instance of UploadBase, with all info about the upload
3563 $user: (object) An instance of User, the user uploading this file
3564 $props: (array|null) File properties, as returned by
3565 MWFileProps::getPropsFromPath(). Note this is not always guaranteed to be set,
3566 e.g. in test scenarios. Call MWFileProps::getPropsFromPath() yourself in case
3567 you need the information.
3568 &$error: output: If the file stashing should be prevented, set this to the
3569 reason in the form of [ messagename, param1, param2, ... ] or a
3570 MessageSpecifier instance (you might want to use ApiMessage to provide machine
3571 -readable details for the API).
3573 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3574 in most cases over UploadVerification.
3575 $upload: (object) an instance of UploadBase, with all info about the upload
3576 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3577 Handlers will typically only apply for specific MIME types.
3578 &$error: (object) output: true if the file is valid. Otherwise, set this to the
3579 reason in the form of [ messagename, param1, param2, ... ] or a
3580 MessageSpecifier instance (you might want to use ApiMessage to provide machine
3581 -readable details for the API).
3583 'UploadVerifyUpload': Upload verification, based on both file properties like
3584 MIME type (same as UploadVerifyFile) and the information entered by the user
3585 (upload comment, file page contents etc.).
3586 $upload: (object) An instance of UploadBase, with all info about the upload
3587 $user: (object) An instance of User, the user uploading this file
3588 $props: (array|null) File properties, as returned by
3589 MWFileProps::getPropsFromPath(). Note this is not always guaranteed to be set,
3590 e.g. in test scenarios. Call MWFileProps::getPropsFromPath() yourself in case
3591 you need the information.
3592 $comment: (string) Upload log comment (also used as edit summary)
3593 $pageText: (string) File description page text (only used for new uploads)
3594 &$error: output: If the file upload should be prevented, set this to the reason
3595 in the form of [ messagename, param1, param2, ... ] or a MessageSpecifier
3596 instance (you might want to use ApiMessage to provide machine-readable details
3599 'UserIsBot': when determining whether a user is a bot account
3601 &$isBot: whether this is user a bot or not (boolean)
3603 'User::mailPasswordInternal': before creation and mailing of a user's new
3605 &$user: the user who sent the message out
3606 &$ip: IP of the user who sent the message out
3607 &$u: the account whose new password will be set
3609 'UserAddGroup': Called when adding a group or changing a group's expiry; return
3610 false to override stock group addition.
3611 $user: the user object that is to have a group added
3612 &$group: the group to add; can be modified
3613 &$expiry: the expiry time in TS_MW format, or null if the group is not to
3614 expire; can be modified
3616 'UserArrayFromResult': Called when creating an UserArray object from a database
3618 &$userArray: set this to an object to override the default object returned
3619 $res: database result used to create the object
3621 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3622 want to display an error message, try getUserPermissionsErrors.
3623 &$title: Title object being checked against
3624 &$user: Current user object
3625 $action: Action being checked
3626 &$result: Pointer to result returned if hook returns false. If null is returned,
3627 userCan checks are continued by internal code.
3629 'UserCanSendEmail': To override User::canSendEmail() permission check.
3630 &$user: User (object) whose permission is being checked
3631 &$canSend: bool set on input, can override on output
3633 'UserClearNewTalkNotification': Called when clearing the "You have new
3634 messages!" message, return false to not delete it.
3635 &$user: User (object) that will clear the message
3636 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3638 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3639 &$user: User to get groups for
3640 &$groups: Current effective groups
3642 'UserGetAllRights': After calculating a list of all available rights.
3643 &$rights: Array of rights, which may be added to.
3645 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3646 before returning the options to the caller. Warning: This hook is called for
3647 every call to User::getDefaultOptions(), which means it's potentially called
3648 dozens or hundreds of times. You may want to cache the results of non-trivial
3649 operations in your hook function for this reason.
3650 &$defaultOptions: Array of preference keys and their default values.
3652 'UserGetEmail': Called when getting an user email address.
3654 &$email: email, change this to override local email
3656 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3657 email authentication.
3659 &$timestamp: timestamp, change this to override local email authentication
3662 'UserGetLanguageObject': Called when getting user's interface language object.
3664 &$code: Language code that will be used to create the object
3665 $context: IContextSource object
3667 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3668 &$reservedUsernames: $wgReservedUsernames
3670 'UserGetRights': Called in User::getRights().
3671 $user: User to get rights for
3672 &$rights: Current rights
3674 'UserGetRightsRemove': Called in User::getRights(). This hook override
3675 the UserGetRights hook. It can be used to remove rights from user
3676 and ensure that will not be reinserted by the other hook callbacks
3677 therefore this hook should not be used to add any rights, use UserGetRights instead.
3678 $user: User to get rights for
3679 &$rights: Current rights
3681 'UserGroupsChanged': Called after user groups are changed.
3682 $user: User whose groups changed
3683 $added: Groups added
3684 $removed: Groups removed
3685 $performer: User who performed the change, false if via autopromotion
3686 $reason: The reason, if any, given by the user performing the change,
3687 false if via autopromotion.
3688 $oldUGMs: An associative array (group name => UserGroupMembership object) of
3689 the user's group memberships before the change.
3690 $newUGMs: An associative array (group name => UserGroupMembership object) of
3691 the user's current group memberships.
3693 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3694 specific block exemptions).
3695 $user: User in question
3696 $title: Title of the page in question
3697 &$blocked: Out-param, whether or not the user is blocked from that page.
3698 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3699 to edit their own user talk pages.
3701 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3703 $ip: User's IP address
3704 &$blocked: Whether the user is blocked, to be modified by the hook
3705 &$block: The Block object, to be modified by the hook
3707 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3708 false if a UserGetRights hook might remove the named right.
3709 $right: The user right being checked
3711 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3712 $user: User in question.
3713 &$hidden: Set true if the user's name should be hidden.
3715 'UserIsLocked': Check if the user is locked. See User::isLocked().
3716 $user: User in question.
3717 &$locked: Set true if the user should be locked.
3719 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3720 environmental means; occurs after session is loaded.
3721 $user: user object being loaded
3723 'UserLoadDefaults': Called when loading a default user.
3727 'UserLoadFromDatabase': Called when loading a user from the database.
3729 &$s: database query object
3731 'UserLoadOptions': When user options/preferences are being loaded from the
3734 &$options: Options, can be modified.
3736 'UserLoggedIn': Called after a user is logged in
3737 $user: User object for the logged-in user
3739 'UserLoginComplete': Show custom content after a user has logged in via the Web
3740 interface. For functionality that needs to run after any login (API or web) use
3742 &$user: the user object that was created on login
3743 &$inject_html: Any HTML to inject after the "logged in" message.
3744 $direct: (bool) The hook is called directly after a successful login. This will
3745 only happen once per login. A UserLoginComplete call with direct=false can
3746 happen when the user visits the login page while already logged in.
3748 'UserLogout': Before a user logs out.
3749 &$user: the user object that is about to be logged out
3751 'UserLogoutComplete': After a user has logged out.
3752 &$user: the user object _after_ logout (won't have name, ID, etc.)
3753 &$inject_html: Any HTML to inject after the "logged out" message.
3754 $oldName: name of the user before logout (string)
3756 'UserMailerChangeReturnPath': Called to generate a VERP return address
3757 when UserMailer sends an email, with a bounce handling extension.
3758 $to: Array of MailAddress objects for the recipients
3759 &$returnPath: The return address string
3761 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3762 to split up an email with multiple the To: field into separate emails.
3763 &$to: array of MailAddress objects; unset the ones which should be mailed
3766 'UserMailerTransformContent': Called in UserMailer::send() to change email
3767 contents. Extensions can block sending the email by returning false and setting
3769 $to: array of MailAdresses of the targets
3770 $from: MailAddress of the sender
3771 &$body: email body, either a string (for plaintext emails) or an array with
3772 'text' and 'html' keys
3773 &$error: should be set to an error message string
3775 'UserMailerTransformMessage': Called in UserMailer::send() to change email after
3776 it has gone through the MIME transform. Extensions can block sending the email
3777 by returning false and setting $error.
3778 $to: array of MailAdresses of the targets
3779 $from: MailAddress of the sender
3780 &$subject: email subject (not MIME encoded)
3781 &$headers: email headers (except To: and Subject:) as an array of header
3783 &$body: email body (in MIME format) as a string
3784 &$error: should be set to an error message string
3786 'UserRemoveGroup': Called when removing a group; return false to override stock
3788 $user: the user object that is to have a group removed
3789 &$group: the group to be removed, can be modified
3791 'UserRequiresHTTPS': Called to determine whether a user needs
3792 to be switched to HTTPS.
3793 $user: User in question.
3794 &$https: Boolean whether $user should be switched to HTTPS.
3796 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3797 have been requested to be reset. This hook can be used to exclude certain
3798 options from being reset even when the user has requested all prefs to be reset,
3799 because certain options might be stored in the user_properties database table
3800 despite not being visible and editable via Special:Preferences.
3801 $user: the User (object) whose preferences are being reset
3802 &$newOptions: array of new (site default) preferences
3803 $options: array of the user's old preferences
3804 $resetKinds: array containing the kinds of preferences to reset
3806 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3808 &$user: user retrieving new talks messages
3809 &$talks: array of new talks page(s)
3811 'UserSaveOptions': Called just before saving user preferences. Hook handlers can
3812 either add or manipulate options, or reset one back to it's default to block
3813 changing it. Hook handlers are also allowed to abort the process by returning
3814 false, e.g. to save to a global profile instead. Compare to the UserSaveSettings
3815 hook, which is called after the preferences have been saved.
3816 $user: The User for which the options are going to be saved
3817 &$options: The users options as an associative array, modifiable
3819 'UserSaveSettings': Called directly after user preferences (user_properties in
3820 the database) have been saved. Compare to the UserSaveOptions hook, which is
3822 $user: The User for which the options have been saved
3824 'UserSendConfirmationMail': Called just before a confirmation email is sent to
3825 a user. Hook handlers can modify the email that will be sent.
3826 $user: The User for which the confirmation email is going to be sent
3827 &$mail: Associative array describing the email, with the following keys:
3828 - subject: Subject line of the email
3829 - body: Email body. Can be a string, or an array with keys 'text' and 'html'
3830 - from: User object, or null meaning $wgPasswordSender will be used
3831 - replyTo: MailAddress object or null
3832 $info: Associative array with additional information:
3833 - type: 'created' if the user's account was just created; 'set' if the user
3834 set an email address when they previously didn't have one; 'changed' if
3835 the user had an email address and changed it
3836 - ip: The IP address from which the user set/changed their email address
3837 - confirmURL: URL the user should visit to confirm their email
3838 - invalidateURL: URL the user should visit to invalidate confirmURL
3839 - expiration: time and date when confirmURL expires
3841 'UserSetCookies': DEPRECATED since 1.27! If you're trying to replace core
3842 session cookie handling, you want to create a subclass of
3843 MediaWiki\Session\CookieSessionProvider instead. Otherwise, you can no longer
3844 count on user data being saved to cookies versus some other mechanism.
3845 Called when setting user cookies.
3847 &$session: session array, will be added to the session
3848 &$cookies: cookies array mapping cookie name to its value
3850 'UserSetEmail': Called when changing user email address.
3852 &$email: new email, change this to override new email address
3854 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3855 email authentication.
3857 &$timestamp: new timestamp, change this to override local email
3858 authentication timestamp
3860 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3861 "Foobar (Talk | Contribs | Block)".
3862 $userId: User id of the current user
3863 $userText: User name of the current user
3864 &$items: Array of user tool links as HTML fragments
3866 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3867 extensions providing user group data from an alternate source a chance to add
3868 their data into the cache array so that things like global user groups are
3869 displayed correctly in Special:ListUsers.
3870 $dbr: Read-only database handle
3871 $userIds: Array of user IDs whose groups we should look up
3872 &$cache: Array of user ID -> (array of internal group name (e.g. 'sysop') ->
3873 UserGroupMembership object)
3874 &$groups: Array of group name -> bool true mappings for members of a given user
3877 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3878 FormatMetadata::getExtendedMeta (return false means cache will be
3879 invalidated and GetExtendedMetadata hook called again).
3880 $timestamp: The timestamp metadata was generated
3881 $file: The file the metadata is for
3883 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3884 used to alter the SQL query which gets the list of wanted pages.
3885 &$wantedPages: WantedPagesPage object
3886 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3888 'WatchArticle': Before a watch is added to an article.
3889 &$user: user that will watch
3890 &$page: WikiPage object to be watched
3891 &$status: Status object to be returned if the hook returns false
3893 'WatchArticleComplete': After a watch is added to an article.
3894 &$user: user that watched
3895 &$page: WikiPage object watched
3897 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3898 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3899 $watchedItemQueryService: Service object
3901 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3902 form, used to manipulate the list of pages or preload data based on that list.
3903 &$watchlistInfo: array of watchlisted pages in
3904 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3906 'WatchlistEditorBuildRemoveLine': when building remove lines in
3907 Special:Watchlist/edit.
3908 &$tools: array of extra links
3909 $title: Title object
3910 $redirect: whether the page is a redirect
3912 &$link: HTML link to title
3914 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3916 $router: The PathRouter instance
3918 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3919 Return false to prevent setting of the cookie.
3920 &$name: Cookie name passed to WebResponse::setcookie()
3921 &$value: Cookie value passed to WebResponse::setcookie()
3922 &$expire: Cookie expiration, as for PHP's setcookie()
3923 &$options: Options passed to WebResponse::setcookie()
3925 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3926 run a MediaWiki cli script.
3927 &$script: MediaWiki cli script path
3928 &$parameters: Array of arguments and options to the script
3929 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3932 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3933 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3934 &$qp: The list of QueryPages
3936 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3937 $row: The DB row of the entry.
3938 $title: The Title of the page where the link comes FROM
3939 $target: The Title of the page where the link goes TO
3940 &$props: Array of HTML strings to display after the title.
3942 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3943 dumps. One, and only one hook should set this, and return false.
3944 &$tables: Database tables to use in the SELECT query
3945 &$opts: Options to use for the query
3946 &$join: Join conditions
3948 'WikiPageDeletionUpdates': DEPRECATED! Use PageDeletionDataUpdates or
3949 override ContentHandler::getDeletionDataUpdates instead.
3950 Manipulates the list of DeferrableUpdates to be applied when a page is deleted.
3952 $content: the Content to generate updates for, or null in case the page revision
3953 could not be loaded. The delete will succeed despite this.
3954 &$updates: the array of objects that implement DeferrableUpdate. Hook function
3955 may want to add to it.
3957 'WikiPageFactory': Override WikiPage class used for a title
3958 $title: Title of the page
3959 &$page: Variable to set the created WikiPage to.
3961 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3962 extra metadata to be added.
3963 $obj: The XmlDumpWriter object.
3964 &$out: The output string.
3965 $row: The database row for the page.
3966 $title: The title of the page.
3968 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3970 &$obj: The XmlDumpWriter object.
3971 &$out: The text being output.
3972 $row: The database row for the revision being dumped. DEPRECATED, use $rev instead.
3973 $text: The revision text to be dumped. DEPRECATED, use $rev instead.
3974 $rev: The RevisionRecord that is being dumped to XML
3976 More hooks might be available but undocumented, you can execute
3977 "php maintenance/findHooks.php" to find hidden ones.