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 ) {
78 if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
80 # code to actually show the article goes here
82 Hooks::run( 'ArticleShowComplete', array( &$article ) );
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle( $article ) {
100 function reverseForExport( $article ) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array( 'someFunction', $someData );
143 $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array( $object, 'someMethod' );
147 $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
148 $wgHooks['EventName'][] = array( $object ); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction( $param1, $param2 )
157 someFunction( $someData, $param1, $param2 )
160 $object->onEventName( $param1, $param2 )
162 $object->someMethod( $param1, $param2 )
163 # object with method and data
164 $object->someMethod( $someData, $param1, $param2 )
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
174 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'brion' );
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * No return value (or null): the hook has operated successfully. Previously,
182 true was required. This is the default since MediaWiki 1.23.
183 * "some string": an error occurred; processing should stop and the error
184 should be shown to the user
185 * false: the hook has successfully done the work necessary and the calling
188 The last result would be for cases where the hook function replaces the main
189 functionality. For example, if you wanted to authenticate users to a custom
190 system (LDAP, another PHP program, whatever), you could do:
192 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
194 function ldapLogin( $username, $password ) {
199 Returning false makes less sense for events where the action is complete, and
200 will normally be ignored.
202 Note that none of the examples made use of create_function() as a way to
203 attach a function to a hook. This is known to cause problems (notably with
204 Special:Version), and should be avoided when at all possible.
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
215 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216 # protect the article
217 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
222 Hooks::run() returns true if the calling function should continue processing
223 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
224 error occurred, or one of the hooks handled the action already). Checking the
225 return value matters more for "before" hooks than for "complete" hooks.
227 Hooks::run() was added in MediaWiki 1.18, before that the global function
228 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can be changed)
232 into the hook code. Also note that earlier versions of wfRunHooks took a
233 variable number of arguments; the array() calling protocol came about after
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if you're going
239 to add events to the MediaWiki code.
241 'AbortAutoAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
242 Return false to cancel automated local account creation, where normally
243 authentication against an external auth plugin would be creating a local
245 $user: the User object about to be created (read-only, incomplete)
246 &$abortMsg: out parameter: name of error message to be displayed to user
248 'AbortAutoblock': Return false to cancel an autoblock.
249 $autoblockip: The IP going to be autoblocked.
250 &$block: The block from which the autoblock is coming.
252 'AbortDiffCache': Can be used to cancel the caching of a diff.
253 &$diffEngine: DifferenceEngine object
255 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
256 $editor: The User who made the change.
257 $title: The Title of the page that was edited.
258 $rc: The current RecentChange object.
260 'AbortLogin': DEPRECATED! Create a PreAuthenticationProvider instead.
261 Return false to cancel account login.
262 $user: the User object being authenticated against
263 $password: the password being submitted, not yet checked for validity
264 &$retval: a LoginForm class constant to return from authenticateUserData();
265 default is LoginForm::ABORTED. Note that the client may be using a machine
266 API rather than the HTML user interface.
267 &$msg: the message identifier for abort reason (new in 1.18, not available
270 'AbortNewAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
271 Return false to cancel explicit account creation.
272 $user: the User object about to be created (read-only, incomplete)
273 &$msg: out parameter: HTML to display on abort
274 &$status: out parameter: Status object to return, replaces the older $msg param
276 Create the object with Status::newFatal() to ensure proper API error
277 messages are returned when creating account through API clients.
279 'AbortTalkPageEmailNotification': Return false to cancel talk page email
281 $targetUser: the user whom to send talk page email notification
282 $title: the page title
284 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
285 $name: name of the action
286 &$form: HTMLForm object
287 $article: Article object
289 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
290 Allows to change the fields on the form that will be generated.
291 $name: name of the action
292 &$fields: HTMLForm descriptor array
293 $article: Article object
295 'AddNewAccount': DEPRECATED! Use LocalUserCreated.
296 After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
301 are created. Can be used to omit specific feeds from being outputted. You must not use
302 this hook to add feeds, use OutputPage::addFeedLink() instead.
303 &$feedLinks: Array of created feed links
305 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
306 before OutputPage::sendCacheControl() and final ob_end_flush() which
307 will send the buffered output to the client. This allows for last-minute
308 modification of the output within the buffer by using ob_get_clean().
309 $output: The OutputPage object where output() was called
311 'AfterImportPage': When a page import is completed.
312 $title: Title under which the revisions were imported
313 $foreignTitle: ForeignTitle object based on data provided by the XML file
314 $revCount: Number of revisions in the XML file
315 $sRevCount: Number of successfully imported revisions
316 $pageInfo: associative array of page information
318 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
319 just before adding its HTML to parser output.
320 $parser: Parser object that called the hook
321 $ig: Gallery, an object of one of the gallery classes (inheriting from
323 &$html: HTML generated by the gallery
325 'AlternateEdit': Before checking if a user can edit a page and before showing
326 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
327 $editPage: the EditPage object
329 'AlternateEditPreview': Before generating the preview of the page when editing
330 ( EditPage::getPreviewText() ).
331 Return false and set $previewHTML and $parserOutput to output custom page
333 $editPage: the EditPage object
334 &$content: the Content object for the text field from the edit page
335 &$previewHTML: Text to be placed into the page for the preview
336 &$parserOutput: the ParserOutput object for the preview
338 'AlternateUserMailer': Called before mail is sent so that mail could be logged
339 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
340 the regular method of sending mail. Return a string to return a php-mail-error
341 message containing the error. Returning true will continue with sending email
343 $headers: Associative array of headers for the email
344 $to: MailAddress object or array
346 $subject: Subject of the email
347 $body: Body of the message
349 'APIAfterExecute': After calling the execute() method of an API module. Use
350 this to extend core API modules.
351 &$module: Module object
353 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
354 &$main: ApiMain object
356 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
357 authenticate and authorize API clients before executing the module. Return
358 false and set a message to cancel the request.
359 $module: Module object
361 &$message: API message to die with. Specific values accepted depend on the
363 * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
364 pass to ApiBase::dieWithError().
365 * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
366 * Earlier: A key or key+parameters in ApiBase::$messageMap.
368 'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
369 Before saving a page with api.php?action=edit, after
370 processing request parameters. Return false to let the request fail, returning
371 an error message or an <edit result="Failure"> tag if $resultArr was filled.
372 Unlike for example 'EditFilterMergedContent' this also being run on undo.
373 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
374 for the API and it's recommended to use it instead of this hook.
375 $editPage: the EditPage object
376 $text: the text passed to the API. Note that this includes only the single
377 section for section edit, and is not necessarily the final text in case of
378 automatically resolved edit conflicts.
379 &$resultArr: data in this array will be added to the API result
381 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
382 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
383 this hook may cancel the hook to signal that the item is not viewable in the
385 $row: A row of data from ContribsPager. The set of data returned by
386 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
388 $context: An IContextSource implementation.
389 &$feedItem: Set this to a FeedItem instance if the callback can handle the
390 provided row. This is provided to the hook as a null, if it is non null then
391 another callback has already handled the hook.
393 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
394 highlighting, add output to $context->getOutput() and return false.
395 $context: An IContextSource.
396 $text: Text to be highlighted.
397 $mime: MIME type of $text.
398 $format: API format code for $text.
400 'APIGetAllowedParams': Use this hook to modify a module's parameters.
401 &$module: ApiBase Module object
402 &$params: Array of parameters
403 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
405 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
406 Use this hook to modify a module's description.
407 &$module: ApiBase Module object
408 &$desc: String description, or array of description strings
410 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
411 $module: ApiBase Module object
412 &$msg: Array of Message objects
414 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
416 Use this hook to modify a module's parameter descriptions.
417 &$module: ApiBase Module object
418 &$desc: Array of parameter descriptions
420 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
422 $module: ApiBase Module object
423 &$msg: Array of arrays of Message objects
425 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
426 $module: ApiBase Module object
427 &$help: Array of HTML strings to be joined for the output.
428 $options: Array Options passed to ApiHelp::getHelp
429 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
430 the page and values as for Linker::generateTOC().
432 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
433 module manager. Can be used to conditionally register API modules.
434 $moduleManager: ApiModuleManager Module manager instance
436 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
437 an exception is thrown during API action execution.
438 $apiMain: Calling ApiMain instance.
439 $e: Exception object.
441 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
442 extensions to adjust the ParserOptions before parsing.
443 $options: ParserOptions object
444 $title: Title to be parsed
445 $params: Parameter array for the API module
446 $module: API module (which is also a ContextSource)
447 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
448 &$suppressCache: Set true if cache should be suppressed.
450 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
451 can alter or append to the array.
452 &$results: array with integer keys to associative arrays. Keys in associative
454 - title: Title object.
455 - redirect from: Title or null.
456 - extract: Description for this result.
457 - extract trimmed: If truthy, the extract will not be trimmed to
458 $wgOpenSearchDescriptionLength.
459 - image: Thumbnail for this result. Value is an array with subkeys 'source'
460 (url), 'width', 'height', 'alt', 'align'.
461 - url: Url for the given title.
463 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
464 module manager. Can be used to conditionally register API query modules.
465 $moduleManager: ApiModuleManager Module manager instance
467 'APIQueryAfterExecute': After calling the execute() method of an
468 action=query submodule. Use this to extend core API modules.
469 &$module: Module object
471 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
472 database query has returned. An API query module wanting to use this hook
473 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
475 $module: ApiQueryBase module in question
476 $result: ResultWrapper|bool returned from the IDatabase::select()
477 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
478 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
481 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
482 database query is made. WARNING: It would be very easy to misuse this hook and
483 break the module! Any joins added *must* join on a unique key of the target
484 table unless you really know what you're doing. An API query module wanting to
485 use this hook should see the ApiQueryBase::select() and
486 ApiQueryBase::processRow() documentation.
487 $module: ApiQueryBase module in question
488 &$tables: array of tables to be queried
489 &$fields: array of columns to select
490 &$conds: array of WHERE conditionals for query
491 &$query_options: array of options for the database request
492 &$join_conds: join conditions for the tables
493 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
494 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
496 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
497 the database result is processed. Return false to stop processing the result
498 set. An API query module wanting to use this hook should see the
499 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
500 $module: ApiQueryBase module in question
501 $row: stdClass Database result row
502 &$data: array to be included in the ApiResult.
503 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
504 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
506 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
507 an action=query submodule. Use this to extend core API modules.
508 &$module: Module object
509 &$resultPageSet: ApiPageSet object
511 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
512 Use this hook to add custom tokens to prop=info. Every token has an action,
513 which will be used in the intoken parameter and in the output
514 (actiontoken="..."), and a callback function which should return the token, or
515 false if the user isn't allowed to obtain it. The prototype of the callback
516 function is func($pageid, $title), where $pageid is the page ID of the page the
517 token is requested for and $title is the associated Title object. In the hook,
518 just add your callback to the $tokenFunctions array and return true (returning
519 false makes no sense).
520 &$tokenFunctions: array(action => callback)
522 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
524 Use this hook to add custom tokens to list=recentchanges. Every token has an
525 action, which will be used in the rctoken parameter and in the output
526 (actiontoken="..."), and a callback function which should return the token, or
527 false if the user isn't allowed to obtain it. The prototype of the callback
528 function is func($pageid, $title, $rc), where $pageid is the page ID of the
529 page associated to the revision the token is requested for, $title the
530 associated Title object and $rc the associated RecentChange object. In the
531 hook, just add your callback to the $tokenFunctions array and return true
532 (returning false makes no sense).
533 &$tokenFunctions: array(action => callback)
535 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
536 Use this hook to add custom tokens to prop=revisions. Every token has an
537 action, which will be used in the rvtoken parameter and in the output
538 (actiontoken="..."), and a callback function which should return the token, or
539 false if the user isn't allowed to obtain it. The prototype of the callback
540 function is func($pageid, $title, $rev), where $pageid is the page ID of the
541 page associated to the revision the token is requested for, $title the
542 associated Title object and $rev the associated Revision object. In the hook,
543 just add your callback to the $tokenFunctions array and return true (returning
544 false makes no sense).
545 &$tokenFunctions: array(action => callback)
547 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
548 sites general information.
549 $module: the current ApiQuerySiteInfo module
550 &$results: array of results, add things here
552 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
553 sites statistics information.
554 &$results: array of results, add things here
556 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
557 action=query&meta=tokens. Note that most modules will probably be able to use
558 the 'csrf' token instead of creating their own token types.
559 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
560 and key to pass to Session::getToken() )
562 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
563 Use this hook to add custom token to list=users. Every token has an action,
564 which will be used in the ustoken parameter and in the output
565 (actiontoken="..."), and a callback function which should return the token, or
566 false if the user isn't allowed to obtain it. The prototype of the callback
567 function is func($user) where $user is the User object. In the hook, just add
568 your callback to the $tokenFunctions array and return true (returning false
570 &$tokenFunctions: array(action => callback)
572 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
573 $module: ApiQueryWatchlist instance
574 $watchedItem: WatchedItem instance
575 $recentChangeInfo: Array of recent change info data
576 &$vals: Associative array of data to be output for the row
578 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
579 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
580 $module: ApiQueryWatchlist instance
581 $params: Array of parameters, as would be returned by $module->extractRequestParams()
582 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
584 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
585 should have its own entry in the $apis array and have a unique name, passed as
586 key for the array that represents the service data. In this data array, the
587 key-value-pair identified by the apiLink key is required.
588 &$apis: array of services
590 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
591 Use this hook to extend action=tokens with new token types.
592 &$tokenTypes: supported token types in format 'type' => callback function
593 used to retrieve this type of tokens.
595 'ApiValidatePassword': Called from ApiValidatePassword.
596 $module: ApiValidatePassword instance.
599 'Article::MissingArticleConditions': Before fetching deletion & move log entries
600 to display a message of a non-existing page being deleted/moved, give extensions
601 a chance to hide their (unrelated) log entries.
602 &$conds: Array of query conditions (all of which have to be met; conditions will
603 AND in the final query)
604 $logTypes: Array of log types being queried
606 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
608 After fetching content of an article from the database.
609 &$article: the article (object) being loaded from the database
610 &$content: the content (string) of the article
612 'ArticleAfterFetchContentObject': After fetching content of an article from the
614 &$article: the article (object) being loaded from the database
615 &$content: the content of the article, as a Content object
617 'ArticleConfirmDelete': Before writing the confirmation form for article
619 $article: the article (object) being deleted
620 $output: the OutputPage object
621 &$reason: the reason (string) the article is being deleted
623 'ArticleContentOnDiff': Before showing the article content below a diff. Use
624 this to change the content in this area or how it is loaded.
625 $diffEngine: the DifferenceEngine
626 $output: the OutputPage object
628 'ArticleContentViewCustom': Allows to output the text of the article in a
629 different format than wikitext. Note that it is preferable to implement proper
630 handing for a custom data type using the ContentHandler facility.
631 $content: content of the page, as a Content object
632 $title: title of the page
633 $output: reference to $wgOut
635 'ArticleDelete': Before an article is deleted.
636 &$wikiPage: the WikiPage (object) being deleted
637 &$user: the user (object) deleting the article
638 &$reason: the reason (string) the article is being deleted
639 &$error: if the deletion was prohibited, the (raw HTML) error message to display
641 &$status: Status object, modify this to throw an error. Overridden by $error
643 $suppress: Whether this is a suppression deletion or not (added in 1.27)
645 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
646 $title: Title of the article that has been deleted.
647 $outputPage: OutputPage that can be used to append the output.
649 'ArticleDeleteComplete': After an article is deleted.
650 &$wikiPage: the WikiPage that was deleted
651 &$user: the user that deleted the article
652 $reason: the reason the article was deleted
653 $id: id of the article that was deleted
654 $content: the Content of the deleted page (or null, when deleting a broken page)
655 $logEntry: the ManualLogEntry used to record the deletion
656 $archivedRevisionCount: the number of revisions archived during the deletion
658 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
660 &$wikiPage: WikiPage (object) of the user talk page
661 $recipient: User (object) who's talk page was edited
663 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
664 article has been changed.
665 &$wikiPage: the WikiPage (object)
666 &$editInfo: data holder that includes the parser output ($editInfo->output) for
667 that page after the change
668 $changed: bool for if the page was changed
670 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
671 recentchanges table, return false to not delete old entries.
672 &$wikiPage: WikiPage (object) being modified
674 'ArticleFromTitle': when creating an article object from a title object using
675 Wiki::articleFromTitle().
676 &$title: Title (object) used to create the article object
677 &$article: Article (object) that will be returned
678 $context: IContextSource (object)
680 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
681 After a new article is created.
682 $wikiPage: WikiPage created
683 $user: User creating the article
685 $summary: Edit summary/comment
686 $isMinor: Whether or not the edit was marked as minor
687 $isWatch: (No longer used)
688 $section: (No longer used)
689 $flags: Flags passed to WikiPage::doEditContent()
690 $revision: New Revision of the article
692 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
693 $targetTitle: target title (object)
694 $destTitle: destination title (object)
696 'ArticlePageDataAfter': After loading data of an article from the database.
697 &$wikiPage: WikiPage (object) whose data were loaded
698 &$row: row (object) returned from the database server
700 'ArticlePageDataBefore': Before loading data of an article from the database.
701 &$wikiPage: WikiPage (object) that data will be loaded
702 &$fields: fields (array) to load from the database
704 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
705 $wikiPage: the WikiPage being saved
706 $popts: parser options to be used for pre-save transformation
708 'ArticleProtect': Before an article is protected.
709 &$wikiPage: the WikiPage being protected
710 &$user: the user doing the protection
711 $protect: Set of restriction keys
712 $reason: Reason for protect
714 'ArticleProtectComplete': After an article is protected.
715 &$wikiPage: the WikiPage that was protected
716 &$user: the user who did the protection
717 $protect: Set of restriction keys
718 $reason: Reason for protect
720 'ArticlePurge': Before executing "&action=purge".
721 &$wikiPage: WikiPage (object) to purge
723 'ArticleRevisionUndeleted': After an article revision is restored.
724 &$title: the article title
725 $revision: the revision
726 $oldPageID: the page ID of the revision when archived (may be null)
728 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
729 revisions of an article.
730 $title: Title object of the article
731 $ids: Ids to set the visibility for
732 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
733 examined to determine exactly what visibility bits have changed for each
734 revision. This array is of the form
735 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
737 'ArticleRollbackComplete': After an article rollback is completed.
738 $wikiPage: the WikiPage that was edited
739 $user: the user who did the rollback
740 $revision: the revision the page was reverted back to
741 $current: the reverted revision
743 'ArticleSave': DEPRECATED! Use PageContentSave instead.
744 Before an article is saved.
745 $wikiPage: the WikiPage (object) being saved
746 $user: the user (object) saving the article
747 $text: the new article text
748 $summary: the article summary (comment)
753 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
754 After an article has been updated.
755 $wikiPage: WikiPage modified
756 $user: User performing the modification
758 $summary: Edit summary/comment
759 $isMinor: Whether or not the edit was marked as minor
760 $isWatch: (No longer used)
761 $section: (No longer used)
762 $flags: Flags passed to WikiPage::doEditContent()
763 $revision: New Revision of the article
764 $status: Status object about to be returned by doEditContent()
765 $baseRevId: the rev ID (or false) this edit was based on
767 'ArticleUndelete': When one or more revisions of an article are restored.
768 &$title: Title corresponding to the article restored
769 $create: Whether or not the restoration caused the page to be created (i.e. it
770 didn't exist before).
771 $comment: The comment associated with the undeletion.
772 $oldPageId: ID of page previously deleted (from archive table)
774 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
775 $pageArchive: the PageArchive object
776 &$logEntry: ManualLogEntry object
777 $user: User who is performing the log action
779 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
780 the user is redirected back to the page.
781 $article: the article
782 &$sectionanchor: The section anchor link (e.g. "#overview" )
783 &$extraq: Extra query parameters which can be added via hooked functions
785 'ArticleViewFooter': After showing the footer section of an ordinary page view
786 $article: Article object
787 $patrolFooterShown: boolean whether patrol footer is shown
789 'ArticleViewHeader': Before the parser cache is about to be tried for article
791 &$article: the article
792 &$pcache: whether to try the parser cache or not
793 &$outputDone: whether the output for this page finished or not. Set to
794 a ParserOutput object to both indicate that the output is done and what
795 parser output was used.
797 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
798 redirect was followed.
799 &$article: target article (object)
801 'AuthChangeFormFields': After converting a field information array obtained
802 from a set of AuthenticationRequest classes into a form descriptor; hooks
803 can tweak the array to change how login etc. forms should look.
804 $requests: array of AuthenticationRequests the fields are created from
805 $fieldInfo: field information array (union of all AuthenticationRequest::getFieldInfo() responses).
806 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
807 to change the order of the fields.
808 $action: one of the AuthManager::ACTION_* constants.
810 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
811 for a reason other than misconfiguration or session loss. No return data is
812 accepted; this hook is for auditing only.
813 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
814 $user: The User object being authenticated against, or null if authentication
815 failed before getting that far.
816 $username: A guess at the user name being authenticated, or null if we can't
819 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
820 Called when creating a local account for an user logged in from an external
821 authentication method.
822 $user: User object created locally
824 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
825 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
826 extension to set it programmatically to a variable class.
827 &$auth: the $wgAuth object, probably a stub
829 'AutopromoteCondition': Check autopromote condition for user.
830 $type: condition type
833 &$result: result of checking autopromote condition
835 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
836 certain title are fetched.
838 $title: title of the page to which backlinks are sought
839 &$conds: query conditions
841 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
845 'BadImage': When checking against the bad image list. Change $bad and return
846 false to override. If an image is "bad", it is not rendered inline in wiki
847 pages or galleries in category pages.
848 $name: Image name being checked
849 &$bad: Whether or not the image is "bad"
851 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
852 custom HTML after the section. Any uses of the hook need to handle escaping.
853 $template: BaseTemplate
854 $portlet: string portlet name
857 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
858 and returning it for the skin to output. You can add items to the toolbox while
859 still letting the skin make final decisions on skin-specific markup conventions
861 &$sk: The BaseTemplate base skin template
862 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
863 BaseTemplate::makeListItem for details on the format of individual items
864 inside of this array.
866 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
867 "noarticletext-nopermission" at Article::showMissingArticle().
868 $article: article object
870 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
871 override how the redirect is output by modifying, or by returning false, and
872 letting standard HTTP rendering take place.
873 ATTENTION: This hook is likely to be removed soon due to overall design of the
875 $context: IContextSource object
876 &$redirect: string URL, modifiable
878 'BeforeInitialize': Before anything is initialized in
879 MediaWiki::performRequest().
880 &$title: Title being used for request
882 &$output: OutputPage object
884 $request: WebRequest object
885 $mediaWiki: Mediawiki object
887 'BeforePageDisplay': Prior to outputting a page.
888 &$out: OutputPage object
891 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
892 override how the redirect is output by modifying, or by returning false and
893 taking over the output.
894 $out: OutputPage object
895 &$redirect: URL, modifiable
896 &$code: HTTP code (eg '301' or '302'), modifiable
898 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
899 $parser: Parser object
901 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
902 as a key then the file will appear as a broken thumbnail.
903 &$descQuery: query string to add to thumbnail URL
905 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
906 $parser: Parser object
907 $title: title of the template
908 &$skip: skip this template and link it?
909 &$id: the id of the revision being parsed
911 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
912 &$parser: Parser object
913 &$ig: ImageGallery object
915 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
917 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
918 to a newly created user account.
919 &$injected_html: Any HTML to inject after the "logged in" message of a newly
922 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
923 normalizations have been performed, except for the $wgMaxImageArea check.
925 &$params: Array of parameters
926 &$checkImageAreaHookResult: null, set to true or false to override the
927 $wgMaxImageArea check result.
929 'BitmapHandlerTransform': before a file is transformed, gives extension the
930 possibility to transform it themselves
931 $handler: BitmapHandler
933 &$scalerParams: Array with scaler parameters
934 &$mto: null, set to a MediaTransformOutput
936 'BlockIp': Before an IP address or user is blocked.
937 &$block: the Block object about to be saved
938 &$user: the user _doing_ the block (not the one being blocked)
939 &$reason: if the hook is aborted, the error message to be returned in an array
941 'BlockIpComplete': After an IP address or user is blocked.
942 $block: the Block object that was saved
943 $user: the user who did the block (not the one being blocked)
944 $priorBlock: the Block object for the prior block or null if there was none
946 'BookInformation': Before information output on Special:Booksources.
947 $isbn: ISBN to show information for
948 $output: OutputPage object in use
950 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
951 to be able to access the wiki via HTTPS.
952 $ip: The IP address in human-readable form
953 &$canDo: This reference should be set to false if the client may not be able
956 'CanonicalNamespaces': For extensions adding their own namespaces or altering
958 Note that if you need to specify namespace protection or content model for
959 a namespace that is added in a CanonicalNamespaces hook handler, you
960 should do so by altering $wgNamespaceProtection and
961 $wgNamespaceContentModels outside the handler, in top-level scope. The
962 point at which the CanonicalNamespaces hook fires is too late for altering
963 these variables. This applies even if the namespace addition is
964 conditional; it is permissible to declare a content model and protection
965 for a namespace and then decline to actually register it.
966 &$namespaces: Array of namespace numbers with corresponding canonical names
968 'CategoryAfterPageAdded': After a page is added to a category.
969 $category: Category that page was added to
970 $wikiPage: WikiPage that was added
972 'CategoryAfterPageRemoved': After a page is removed from a category.
973 $category: Category that page was removed from
974 $wikiPage: WikiPage that was removed
975 $id: the page ID (original ID in case of page deletions)
977 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
978 &$catpage: CategoryPage instance
980 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
981 in a Category page. Gives extensions the opportunity to batch load any
982 related data about the pages.
983 $type: The category type. Either 'page', 'file' or 'subcat'
984 $res: Query result from DatabaseBase::select()
986 'CategoryViewer::generateLink': Before generating an output link allow
987 extensions opportunity to generate a more specific or relevant link.
988 $type: The category type. Either 'page', 'img' or 'subcat'
989 $title: Title object for the categorized page
990 $html: Requested html content of anchor
991 &$link: Returned value. When set to a non-null value by a hook subscriber
992 this value will be used as the anchor instead of Linker::link
994 'ChangeAuthenticationDataAudit': Called when user changes his password.
995 No return data is accepted; this hook is for auditing only.
996 $req: AuthenticationRequest object describing the change (and target user)
997 $status: StatusValue with the result of the action
999 'ChangePasswordForm': DEPRECATED! Use AuthChangeFormFields or security levels.
1000 For extensions that need to add a field to the ChangePassword form via the
1002 &$extraFields: An array of arrays that hold fields like would be passed to the
1005 'ChangesListInitRows': Batch process change list rows prior to rendering.
1006 $changesList: ChangesList instance
1007 $rows: The data that will be rendered. May be a ResultWrapper instance or
1010 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
1011 &$changesList: ChangesList instance.
1012 &$articlelink: HTML of link to article (already filled-in).
1013 &$s: HTML of row that is being constructed.
1014 &$rc: RecentChange instance.
1015 $unpatrolled: Whether or not we are showing unpatrolled changes.
1016 $watched: Whether or not the change is watched by the user.
1018 'ChangesListSpecialPageFilters': Called after building form options on pages
1019 inheriting from ChangesListSpecialPage (in core: RecentChanges,
1020 RecentChangesLinked and Watchlist).
1021 $special: ChangesListSpecialPage instance
1022 &$filters: associative array of filter definitions. The keys are the HTML
1023 name/URL parameters. Each key maps to an associative array with a 'msg'
1024 (message key) and a 'default' value.
1026 'ChangesListSpecialPageQuery': Called when building SQL query on pages
1027 inheriting from ChangesListSpecialPage (in core: RecentChanges,
1028 RecentChangesLinked and Watchlist).
1029 $name: name of the special page, e.g. 'Watchlist'
1030 &$tables: array of tables to be queried
1031 &$fields: array of columns to select
1032 &$conds: array of WHERE conditionals for query
1033 &$query_options: array of options for the database request
1034 &$join_conds: join conditions for the tables
1035 $opts: FormOptions for this request
1037 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
1038 removed from all revisions and log entries to which it was applied). This gives
1039 extensions a chance to take it off their books.
1040 $tag: name of the tag
1041 &$status: Status object. Add warnings to this as required. There is no point
1042 setting errors, as the deletion has already been partly carried out by this
1045 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1046 from the UI (Special:Tags) or via the API. You could use this hook if you want
1047 to reserve a specific "namespace" of tags, or something similar.
1048 $tag: name of the tag
1049 $user: user initiating the action
1050 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1051 using `$status->warning()`. Errors and warnings will be relayed to the user.
1052 If you set an error, the user will be unable to create the tag.
1054 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1055 deleted from the UI (Special:Tags) or via the API. The default is that tags
1056 defined using the ListDefinedTags hook are not allowed to be deleted unless
1057 specifically allowed. If you wish to allow deletion of the tag, set
1058 `$status = Status::newGood()` to allow deletion, and then `return false` from
1059 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1060 out custom deletion actions.
1061 $tag: name of the tag
1062 $user: user initiating the action
1063 &$status: Status object. See above.
1065 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1066 uses are in active use.
1067 &$tags: list of all active tags. Append to this array.
1069 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1070 ChangeTags::updateTags function. Params:
1071 $addedTags: tags effectively added in the update
1072 $removedTags: tags effectively removed in the update
1073 $prevTags: tags that were present prior to the update
1074 $rc_id: recentchanges table id
1075 $rev_id: revision table id
1076 $log_id: logging table id
1078 $rc: RecentChange being tagged when the tagging accompanies the action or null
1079 $user: User who performed the tagging when the tagging is subsequent to the action or null
1081 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1082 $collationName: Name of the collation in question
1083 &$collationObject: Null. Replace with a subclass of the Collation class that
1084 implements the collation given in $collationName.
1086 'ConfirmEmailComplete': Called after a user's email has been confirmed
1088 $user: user (object) whose email is being confirmed
1090 'ContentAlterParserOutput': Modify parser output for a given content object.
1091 Called by Content::getParserOutput after parsing has finished. Can be used
1092 for changes that depend on the result of the parsing but have to be done
1093 before LinksUpdate is called (such as adding tracking categories based on
1095 $content: The Content to render
1096 $title: Title of the page, as context
1097 $parserOutput: ParserOutput to manipulate
1099 'ContentGetParserOutput': Customize parser output for a given content object,
1100 called by AbstractContent::getParserOutput. May be used to override the normal
1101 model-specific rendering of page content.
1102 $content: The Content to render
1103 $title: Title of the page, as context
1104 $revId: The revision ID, as context
1105 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1106 the output can only depend on parameters provided to this hook function, not
1108 $generateHtml: boolean, indicating whether full HTML should be generated. If
1109 false, generation of HTML may be skipped, but other information should still
1110 be present in the ParserOutput object.
1111 &$output: ParserOutput, to manipulate or replace
1113 'ContentHandlerDefaultModelFor': Called when the default content model is
1114 determined for a given title. May be used to assign a different model for that
1116 $title: the Title in question
1117 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1119 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1120 a given content model name, but no entry for that model exists in
1122 $modeName: the requested content model name
1123 &$handler: set this to a ContentHandler object, if desired.
1125 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1126 be used on a given page. This is especially useful to prevent some content
1127 models to be used in some special location.
1128 $contentModel: ID of the content model in question
1129 $title: the Title in question.
1130 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1131 Handler functions that modify $ok should generally return false to prevent
1132 further hooks from further modifying $ok.
1134 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1135 &$pager: Pager object for contributions
1136 &$queryInfo: The query for the contribs Pager
1138 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1140 &$data: an array of results of all contribs queries
1141 $pager: The ContribsPager object hooked into
1142 $offset: Index offset, inclusive
1143 $limit: Exact query limit
1144 $descending: Query direction, false for ascending, true for descending
1146 'ContributionsLineEnding': Called before a contributions HTML line is finished
1147 $page: SpecialPage object for contributions
1148 &$ret: the HTML line
1149 $row: the DB row for this line
1150 &$classes: the classes to add to the surrounding <li>
1152 'ContributionsToolLinks': Change tool links above Special:Contributions
1153 $id: User identifier
1154 $title: User page title
1155 &$tools: Array of tool links
1156 $specialPage: SpecialPage instance for context and services. Can be either
1157 SpecialContributions or DeletedContributionsPage. Extensions should type
1158 hint against a generic SpecialPage though.
1160 'ConvertContent': Called by AbstractContent::convert when a conversion to
1161 another content model is requested.
1162 Handler functions that modify $result should generally return false to disable
1163 further attempts at conversion.
1164 $content: The Content object to be converted.
1165 $toModel: The ID of the content model to convert to.
1166 $lossy: boolean indicating whether lossy conversion is allowed.
1167 &$result: Output parameter, in case the handler function wants to provide a
1168 converted Content object. Note that $result->getContentModel() must return
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 'DatabaseOraclePostInit': Called after initialising an Oracle database
1178 $db: the DatabaseOracle object
1180 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1181 for Special:DeletedContributions
1182 Similar to ContribsPager::reallyDoQuery
1183 &$data: an array of results of all contribs queries
1184 $pager: The DeletedContribsPager object hooked into
1185 $offset: Index offset, inclusive
1186 $limit: Exact query limit
1187 $descending: Query direction, false for ascending, true for descending
1189 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1191 Similar to ContributionsLineEnding
1192 $page: SpecialPage object for DeletedContributions
1193 &$ret: the HTML line
1194 $row: the DB row for this line
1195 &$classes: the classes to add to the surrounding <li>
1197 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1198 after the new revision's content has been loaded into the class member variable
1199 $differenceEngine->mNewContent but before returning true from this function.
1200 $differenceEngine: DifferenceEngine object
1202 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1203 DifferenceEngine::loadText() after the new revision's content has been loaded
1204 into the class member variable $differenceEngine->mNewContent but before
1205 checking if the variable's value is null.
1206 This hook can be used to inject content into said class member variable.
1207 $differenceEngine: DifferenceEngine object
1209 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1210 which is shown both on the diff header as well as on the bottom of a page, usually
1211 wrapped in a span element which has class="patrollink".
1212 $differenceEngine: DifferenceEngine object
1213 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1214 $rcid: Recent change ID (rc_id) for this change (int)
1216 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1217 For example the rcid might be set to zero due to the user being the same as the
1218 performer of the change but an extension might still want to show it under certain
1220 &$rcid: rc_id (int) of the change or 0
1221 $differenceEngine: DifferenceEngine object
1222 $change: RecentChange object
1223 $user: User object representing the current user
1225 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1226 contains information about the new revision, such as the revision's author, whether
1227 the revision was marked as a minor edit or not, etc.
1228 $differenceEngine: DifferenceEngine object
1229 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1230 include things like revision author info, revision comment, RevisionDelete link and more
1231 $formattedRevisionTools: Array containing revision tools, some of which may have
1232 been injected with the DiffRevisionTools hook
1233 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1234 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1235 $newminor: String indicating if the new revision was marked as a minor edit
1236 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1237 whether we should show just the diff; passed in as a query string parameter to the
1238 various URLs constructed here (i.e. $nextlink)
1239 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1240 to use the RevisionDelete feature
1241 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1243 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1244 contains information about the old revision, such as the revision's author, whether
1245 the revision was marked as a minor edit or not, etc.
1246 $differenceEngine: DifferenceEngine object
1247 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1248 include things like revision author info, revision comment, RevisionDelete link and more
1249 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1250 $oldminor: String indicating if the old revision was marked as a minor edit
1251 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1252 whether we should show just the diff; passed in as a query string parameter to the
1253 various URLs constructed here (i.e. $prevlink)
1254 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1255 to use the RevisionDelete feature
1256 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1258 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1259 there is no old revision
1260 &$oldHeader: empty string by default
1262 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1263 Return false to not add parser output via OutputPage's addParserOutput method.
1264 $differenceEngine: DifferenceEngine object
1265 $out: OutputPage object
1266 $parserOutput: ParserOutput object
1267 $wikiPage: WikiPage object
1269 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1270 point and return false to not show the final "mark as patrolled" link on the bottom
1272 This hook has no arguments.
1274 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1275 eventually gets sent to the OutputPage object.
1276 $differenceEngine: DifferenceEngine object
1278 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1279 body (without header) in cases when there is no old revision or the old and new
1280 revisions are identical.
1281 $differenceEngine: DifferenceEngine object
1283 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1284 object into the diff view
1285 $out: OutputPage object
1287 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1288 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1289 Return false in order to prevent displaying the missing revision message
1290 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1291 $differenceEngine: DifferenceEngine object
1293 'DiffRevisionTools': Override or extend the revision tools available from the
1294 diff view, i.e. undo, etc.
1295 $newRev: Revision object of the "new" revision
1296 &$links: Array of HTML links
1297 $oldRev: Revision object of the "old" revision (may be null)
1298 $user: Current user object
1300 'DiffViewHeader': Called before diff display
1301 $diff: DifferenceEngine object that's calling
1302 $oldRev: Revision object of the "old" revision (may be null/invalid)
1303 $newRev: Revision object of the "new" revision
1305 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1307 &$article: article (object) being viewed
1308 &$oldid: oldid (int) being viewed
1310 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1311 Override the HTML generated for section edit links
1312 $skin: Skin object rendering the UI
1313 $title: Title object for the title being linked to (may not be the same as
1314 the page title, if the section is included from a template)
1315 $section: The designation of the section being pointed to, to be included in
1316 the link, like "§ion=$section"
1317 $tooltip: The default tooltip. Escape before using.
1318 By default, this is wrapped in the 'editsectionhint' message.
1319 &$result: The HTML to return, prefilled with the default plus whatever other
1320 changes earlier hooks have made
1321 $lang: The language code to use for the link in the wfMessage function
1323 'EditFilter': Perform checks on an edit
1324 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1325 $text: Contents of the edit box
1326 $section: Section being edited
1327 &$error: Error message to return
1328 $summary: Edit summary for page
1330 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1331 Post-section-merge edit filter.
1332 $editor: EditPage instance (object)
1333 $text: content of the edit box
1334 &$error: error message to return
1335 $summary: Edit summary for page
1337 'EditFilterMergedContent': Post-section-merge edit filter.
1338 This may be triggered by the EditPage or any other facility that modifies page
1339 content. Use the $status object to indicate whether the edit should be allowed,
1340 and to provide a reason for disallowing it. Return false to abort the edit, and
1341 true to continue. Returning true if $status->isOK() returns false means "don't
1342 save but continue user interaction", e.g. show the edit form.
1343 $status->apiHookResult can be set to an array to be returned by api.php
1344 action=edit. This is used to deliver captchas.
1345 $context: object implementing the IContextSource interface.
1346 $content: content of the edit box, as a Content object.
1347 $status: Status object to represent errors, etc.
1348 $summary: Edit summary for page
1349 $user: the User object representing the user whois performing the edit.
1350 $minoredit: whether the edit was marked as minor by the user.
1352 'EditFormInitialText': Allows modifying the edit form when editing existing
1354 $editPage: EditPage object
1356 'EditFormPreloadText': Allows population of the edit form when creating
1358 &$text: Text to preload with
1359 &$title: Title object representing the page being created
1361 'EditPage::attemptSave': Called before an article is
1362 saved, that is before WikiPage::doEditContent() is called
1363 $editpage_Obj: the current EditPage object
1365 'EditPage::attemptSave:after': Called after an article save attempt
1366 $editpage_Obj: the current EditPage object
1367 $status: the resulting Status object
1368 $resultDetails: Result details array
1370 'EditPage::importFormData': allow extensions to read additional data
1372 $editpage: EditPage instance
1373 $request: Webrequest
1374 return value is ignored (should always return true)
1376 'EditPage::showEditForm:fields': allows injection of form field into edit form
1377 Return value is ignored (should always return true)
1378 &$editor: the EditPage instance for reference
1379 &$out: an OutputPage instance to write to
1381 'EditPage::showEditForm:initial': before showing the edit form
1382 Return false to halt editing; you'll need to handle error messages, etc.
1383 yourself. Alternatively, modifying $error and returning true will cause the
1384 contents of $error to be echoed at the top of the edit form as wikitext.
1385 Return true without altering $error to allow the edit to proceed.
1386 &$editor: EditPage instance (object)
1387 &$out: an OutputPage instance to write to
1389 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1390 but for the read-only 'view source' variant of the edit form.
1391 Return value is ignored (should always return true)
1392 $editor: EditPage instance (object)
1393 &$out: an OutputPage instance to write to
1395 'EditPage::showStandardInputs:options': allows injection of form fields into
1396 the editOptions area
1397 Return value is ignored (should always be true)
1398 $editor: EditPage instance (object)
1399 $out: an OutputPage instance to write to
1400 &$tabindex: HTML tabindex of the last edit check/button
1402 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1403 when there's an edit conflict. Return false to halt normal diff output; in
1404 this case you're responsible for computing and outputting the entire "conflict"
1405 part, i.e., the "difference between revisions" and "your text" headers and
1407 &$editor: EditPage instance
1408 &$out: OutputPage instance
1410 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1411 textarea in the edit form.
1412 &$editpage: The current EditPage object
1413 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1414 &$tabindex: HTML tabindex of the last edit check/button
1416 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1418 &$editpage: The current EditPage object
1419 &$checks: Array of edit checks like "watch this page"/"minor edit"
1420 &$tabindex: HTML tabindex of the last edit check/button
1422 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1423 textarea in the edit form.
1424 &$toolbar: The toolbar HTMl
1426 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1427 contribution/copyright notice.
1428 $title: title of page being edited
1429 &$msg: localization message name, overridable. Default is either
1430 'copyrightwarning' or 'copyrightwarning2'.
1432 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1433 "Show changes". Note that it is preferable to implement diff handling for
1434 different data types using the ContentHandler facility.
1435 $editPage: EditPage object
1436 &$newtext: wikitext that will be used as "your version"
1438 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1439 previewed. Note that it is preferable to implement previews for different data
1440 types using the ContentHandler facility.
1441 $editPage: EditPage object
1442 &$content: Content object to be previewed (may be replaced by hook function)
1444 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1445 Allow modifying the wikitext that will be previewed. Note that it is preferable
1446 to implement previews for different data types using the ContentHandler
1448 $editPage: EditPage object
1449 &$toparse: wikitext that will be parsed
1451 'EditPageNoSuchSection': When a section edit request is given for an
1452 non-existent section
1453 &$editpage: The current EditPage object
1454 &$res: the HTML of the error text
1456 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1457 of terms of service summary link that might exist separately from the copyright
1459 $title: title of page being edited
1460 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1462 'EmailConfirmed': When checking that the user's email address is "confirmed".
1463 This runs before the other checks, such as anonymity and the real check; return
1464 true to allow those checks to occur, and false if checking is done.
1465 &$user: User being checked
1466 &$confirmed: Whether or not the email address is confirmed
1468 'EmailUser': Before sending email from one user to another.
1469 &$to: MailAddress object of receiving user
1470 &$from: MailAddress object of sending user
1471 &$subject: subject of the mail
1472 &$text: text of the mail
1473 &$error: Out-param for an error. Should be set to a Status object or boolean false.
1475 'EmailUserCC': Before sending the copy of the email to the author.
1476 &$to: MailAddress object of receiving user
1477 &$from: MailAddress object of sending user
1478 &$subject: subject of the mail
1479 &$text: text of the mail
1481 'EmailUserComplete': After sending email from one user to another.
1482 $to: MailAddress object of receiving user
1483 $from: MailAddress object of sending user
1484 $subject: subject of the mail
1485 $text: text of the mail
1487 'EmailUserForm': After building the email user form object.
1488 &$form: HTMLForm object
1490 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1492 $user: The user who is trying to email another user.
1493 $editToken: The user's edit token.
1494 &$hookErr: Out-param for the error. Passed as the parameters to
1495 OutputPage::showErrorPage.
1497 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1498 group of changes in EnhancedChangesList.
1499 Hook subscribers can return false to omit this line from recentchanges.
1500 $changesList: EnhancedChangesList object
1501 &$links: The links that were generated by EnhancedChangesList
1502 $block: The RecentChanges objects in that block
1504 'EnhancedChangesListModifyLineData': to alter data used to build
1505 a grouped recent change inner line in EnhancedChangesList.
1506 Hook subscribers can return false to omit this line from recentchanges.
1507 $changesList: EnhancedChangesList object
1508 &$data: An array with all the components that will be joined in order to create the line
1509 $block: An array of RecentChange objects in that block
1510 $rc: The RecentChange object for this line
1511 &$classes: An array of classes to change
1513 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1514 a non-grouped recent change line in EnhancedChangesList.
1515 $changesList: EnhancedChangesList object
1516 &$data: An array with all the components that will be joined in order to create the line
1517 $rc: The RecentChange object for this line
1519 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1521 $ip: The ip address of the user
1523 'ExtensionTypes': Called when generating the extensions credits, use this to
1524 change the tables headers.
1525 &$extTypes: associative array of extensions types
1527 'ExtractThumbParameters': DEPRECATED! Media handler should override
1528 MediaHandler::parseParamString instead.
1529 Called when extracting thumbnail parameters from a thumbnail file name.
1530 $thumbname: the base name of the thumbnail file
1531 &$params: the currently extracted params (has source name, temp or archived
1534 'FetchChangesList': When fetching the ChangesList derivative for a particular
1536 $user: User the list is being fetched for
1537 &$skin: Skin object to be used with the list
1538 &$list: List object (defaults to NULL, change it to an object instance and
1539 return false override the list derivative used)
1541 'FileDeleteComplete': When a file is deleted.
1542 &$file: reference to the deleted file
1543 &$oldimage: in case of the deletion of an old image, the name of the old file
1544 &$article: in case all revisions of the file are deleted a reference to the
1545 WikiFilePage associated with the file.
1546 &$user: user who performed the deletion
1549 'FileTransformed': When a file is transformed and moved into storage.
1550 $file: reference to the File object
1551 $thumb: the MediaTransformOutput object
1552 $tmpThumbPath: The temporary file system path of the transformed file
1553 $thumbPath: The permanent storage path of the transformed file
1555 'FileUndeleteComplete': When a file is undeleted
1556 $title: title object to the file
1557 $fileVersions: array of undeleted versions. Empty if all versions were restored
1558 $user: user who performed the undeletion
1561 'FileUpload': When a file upload occurs.
1562 $file: Image object representing the file that was uploaded
1563 $reupload: Boolean indicating if there was a previously another image there or
1565 $hasDescription: Boolean indicating that there was already a description page
1566 and a new one from the comment wasn't created (since 1.17)
1568 'FormatAutocomments': When an autocomment is formatted by the Linker.
1569 &$comment: Reference to the accumulated comment. Initially null, when set the
1570 default code will be skipped.
1571 $pre: Boolean, true if there is text before this autocomment
1572 $auto: The extracted part of the parsed comment before the call to the hook.
1573 $post: Boolean, true if there is text after this autocomment
1574 $title: An optional title object used to links to sections. Can be null.
1575 $local: Boolean indicating whether section links should refer to local page.
1576 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1577 autocomment originated; null for the local wiki. Added in 1.26, should default
1578 to null in handler functions, for backwards compatibility.
1580 'GalleryGetModes': Get list of classes that can render different modes of a
1582 &$modeArray: An associative array mapping mode names to classes that implement
1583 that mode. It is expected all registered classes are a subclass of
1586 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1588 $user: user to promote.
1589 &$promote: groups that will be added.
1591 'GetBlockedStatus': after loading blocking status of an user from the database
1592 &$user: user (object) being checked
1594 'GetCacheVaryCookies': Get cookies that should vary cache options.
1595 $out: OutputPage object
1596 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1597 that have to vary cache options
1599 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1601 &$title: Title object of page
1602 &$url: string value as output (out parameter, can modify)
1603 $query: query options passed to Title::getCanonicalURL()
1605 'GetDefaultSortkey': Override the default sortkey for a page.
1606 $title: Title object that we need to get a sortkey for
1607 &$sortkey: Sortkey to use.
1609 'GetDifferenceEngine': Called when getting a new difference engine interface
1610 object Return false for valid object in $differenceEngine or true for the
1611 default difference engine.
1612 $context: IContextSource context to be used for diff
1613 $old: Revision ID to show and diff with
1614 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1615 $refreshCache: If set, refreshes the diff cache
1616 $unhide: If set, allow viewing deleted revs
1617 &$differenceEngine: output parameter, difference engine object to be used for
1620 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1621 underscore) magic words. Called by MagicWord.
1622 &$doubleUnderscoreIDs: array of strings
1624 'GetExtendedMetadata': Get extended file metadata for the API
1625 &$combinedMeta: Array of the form:
1626 'MetadataPropName' => array(
1627 value' => prop value,
1628 'source' => 'name of hook'
1630 $file: File object of file in question
1631 $context: RequestContext (including language to use)
1632 $single: Only extract the current language; if false, the prop value should
1633 be in the metadata multi-language array format:
1634 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1635 &$maxCacheTime: how long the results can be cached
1637 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1638 &$title: Title object of page
1639 &$url: string value as output (out parameter, can modify)
1640 $query: query options passed to Title::getFullURL()
1642 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1643 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1645 &$output: string for the output timestamp
1646 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1647 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1648 $user: User whose preferences are being used to make timestamp
1649 $lang: Language that will be used to render the timestamp
1651 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1652 &$title: Title object of page
1653 &$url: string value as output (out parameter, can modify)
1654 $query: query options passed to Title::getInternalURL()
1656 'GetIP': modify the ip of the current user (called only once).
1657 &$ip: string holding the ip as determined so far
1659 'GetLinkColours': modify the CSS class of an array of page links.
1660 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1662 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
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 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 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 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1718 checked for. Use instead of userCan for most cases. Return false if the user
1719 can't do it, and populate $result with the reason in the form of
1720 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1721 might want to use ApiMessage to provide machine-readable details for the API).
1722 For consistency, error messages
1723 should be plain text with no special coloring, bolding, etc. to show that
1724 they're errors; presenting them properly to the user as errors is done by the
1726 &$title: Title object being checked against
1727 &$user: Current user object
1728 $action: Action being checked
1729 &$result: User permissions error to add. If none, return true.
1731 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1732 called only if expensive checks are enabled. Add a permissions error when
1733 permissions errors are checked for. Return false if the user can't do it, and
1734 populate $result with the reason in the form of array( messagename, param1,
1735 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1736 to provide machine-readable details for the API). For consistency, error
1737 messages should be plain text with no
1738 special coloring, bolding, etc. to show that they're errors; presenting them
1739 properly to the user as errors is done by the caller.
1740 &$title: Title object being checked against
1741 &$user: Current user object
1742 $action: Action being checked
1743 &$result: User permissions error to add. If none, return true.
1745 'GitViewers': Called when generating the list of git viewers for
1746 Special:Version, use this to change the list.
1747 &$extTypes: associative array of repo URLS to viewer URLs.
1749 'HistoryRevisionTools': Override or extend the revision tools available from the
1750 page history view, i.e. undo, rollback, etc.
1751 $rev: Revision object
1752 &$links: Array of HTML links
1753 $prevRev: Revision object, next in line in page history, or null
1754 $user: Current user object
1756 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1758 $context: An IContextSource object with information about the request being
1761 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1762 image insertion. You can skip the default logic entirely by returning false, or
1763 just modify a few things using call-by-reference.
1765 &$title: Title object of the image
1766 &$file: File object, or false if it doesn't exist
1767 &$frameParams: Various parameters with special meanings; see documentation in
1768 includes/Linker.php for Linker::makeImageLink
1769 &$handlerParams: Various parameters with special meanings; see documentation in
1770 includes/Linker.php for Linker::makeImageLink
1771 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1772 &$res: Final HTML output, used if you return false
1774 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1775 the image on an image page.
1776 &$imagePage: ImagePage object ($this)
1779 'ImagePageAfterImageLinks': Called after the image links section on an image
1781 $imagePage: ImagePage object ($this)
1782 &$html: HTML for the hook to add
1784 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1785 $imagePage: ImagePage object ($this)
1787 &$line: the HTML of the history line
1788 &$css: the line CSS class
1790 'ImagePageFindFile': Called when fetching the file associated with an image
1792 $page: ImagePage object
1794 &$displayFile: displayed File object
1796 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1797 $page: ImagePage object
1798 &$toc: Array of <li> strings
1800 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1802 &$title: the Title object of the file as it would appear for the upload page
1803 &$path: the original file and path name when img_auth was invoked by the web
1805 &$name: the name only component of the file
1806 &$result: The location to pass back results of the hook routine (only used if
1808 $result[0]=The index of the header message
1809 $result[1]=The index of the body text message
1810 $result[2 through n]=Parameters passed to body text message. Please note the
1811 header message cannot receive/use parameters.
1813 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1814 Return false to stop further processing of the tag
1815 $reader: XMLReader object
1816 $logInfo: Array of information
1818 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1819 Return false to stop further processing of the tag
1820 $reader: XMLReader object
1821 &$pageInfo: Array of information
1823 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1824 Return false to stop further processing of the tag
1825 $reader: XMLReader object
1826 $pageInfo: Array of page information
1827 $revisionInfo: Array of revision information
1829 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1830 Return false to stop further processing of the tag
1831 $reader: XMLReader object
1833 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1834 Return false to stop further processing of the tag
1835 $reader: XMLReader object
1836 $revisionInfo: Array of information
1838 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1839 and edit summaries for transwiki imports.
1840 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1841 &$pageTitle: String that contains page title.
1843 'ImportSources': Called when reading from the $wgImportSources configuration
1844 variable. Can be used to lazy-load the import sources list.
1845 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1846 comment in DefaultSettings.php for the detail of how to structure this array.
1848 'InfoAction': When building information to display on the action=info page.
1849 $context: IContextSource object
1850 &$pageInfo: Array of information
1852 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1853 &$title: Title object for the current page
1854 &$request: WebRequest
1855 &$ignoreRedirect: boolean to skip redirect check
1856 &$target: Title/string of redirect target
1857 &$article: Article object
1859 'InternalParseBeforeLinks': during Parser's internalParse method before links
1860 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1861 &$parser: Parser object
1862 &$text: string containing partially parsed text
1863 &$stripState: Parser's internal StripState object
1865 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1866 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1867 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1868 template/parser function execution which respect nowiki and HTML-comments.
1869 &$parser: Parser object
1870 &$text: string containing partially parsed text
1871 &$stripState: Parser's internal StripState object
1873 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1874 Return true without providing an interwiki to continue interwiki search.
1875 $prefix: interwiki prefix we are looking for.
1876 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1877 iw_trans and optionally iw_api and iw_wikiid.
1879 'InvalidateEmailComplete': Called after a user's email has been invalidated
1881 $user: user (object) whose email is being invalidated
1883 'IRCLineURL': When constructing the URL to use in an IRC notification.
1884 Callee may modify $url and $query, URL will be constructed as $url . $query
1885 &$url: URL to index.php
1886 &$query: Query string
1887 $rc: RecentChange object that triggered url generation
1889 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1890 &$article: article (object) being checked
1892 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1893 &$ip: IP being check
1894 &$result: Change this value to override the result of IP::isTrustedProxy()
1896 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1897 $url: URL used to upload from
1898 &$allowed: Boolean indicating if uploading is allowed for given URL
1900 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1901 instance to return false if the domain name doesn't match your organization.
1902 $addr: The e-mail address entered by the user
1903 &$result: Set this and return false to override the internal checks
1905 'isValidPassword': Override the result of User::isValidPassword()
1906 $password: The password entered by the user
1907 &$result: Set this and return false to override the internal checks
1908 $user: User the password is being validated for
1910 'Language::getMessagesFileName':
1911 $code: The language code or the language we're looking for a messages file for
1912 &$file: The messages file path, you can override this to change the location.
1914 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1915 $wgExtensionMessagesFiles instead.
1916 Use this to define synonyms of magic words depending of the language
1917 &$magicExtensions: associative array of magic words synonyms
1918 $lang: language code (string)
1920 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1921 remove namespaces. Do not use this hook to add namespaces. Use
1922 CanonicalNamespaces for that.
1923 &$namespaces: Array of namespaces indexed by their numbers
1925 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1926 listed in $wgExtensionMessagesFiles instead.
1927 Use to define aliases of special pages names depending of the language
1928 &$specialPageAliases: associative array of magic words synonyms
1929 $lang: language code (string)
1931 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1932 &$names: array of language code => language name
1933 $code: language of the preferred translations
1935 'LanguageLinks': Manipulate a page's language links. This is called
1936 in various places to allow extensions to define the effective language
1938 $title: The page's Title.
1939 &$links: Array with elements of the form "language:title" in the order
1940 that they will be output.
1941 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1942 Currently unused, but planned to provide support for marking individual
1943 language links in the UI, e.g. for featured articles.
1945 'LanguageSelector': Hook to change the language selector available on a page.
1946 $out: The output page.
1947 $cssClassName: CSS class name of the language selector.
1949 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1950 Used when generating internal and interwiki links in
1951 Linker::link(), before processing starts. Return false to skip default
1952 processing and return $ret. See documentation for Linker::link() for details on
1953 the expected meanings of parameters.
1954 $skin: the Skin object
1955 $target: the Title that the link is pointing to
1956 &$html: the contents that the <a> tag should have (raw HTML); null means
1958 &$customAttribs: the HTML attributes that the <a> tag should have, in
1959 associative array form, with keys and values unescaped. Should be merged
1960 with default values, with a value of false meaning to suppress the
1962 &$query: the query string to add to the generated URL (the bit after the "?"),
1963 in associative array form, with keys and values unescaped.
1964 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1965 &$ret: the value to return if your hook returns false.
1967 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1968 Used when generating internal and interwiki links in Linker::link(),
1969 just before the function returns a value. If you return true, an <a> element
1970 with HTML attributes $attribs and contents $html will be returned. If you
1971 return false, $ret will be returned.
1972 $skin: the Skin object
1973 $target: the Title object that the link is pointing to
1974 $options: the options. Will always include either 'known' or 'broken', and may
1975 include 'noclasses'.
1976 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1977 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1978 associative array form.
1979 &$ret: the value to return if your hook returns false.
1981 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1983 &$url: the image url
1984 &$alt: the image's alt text
1985 &$img: the new image HTML (if returning false)
1987 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1990 &$text: the link text
1991 &$link: the new link HTML (if returning false)
1992 &$attribs: the attributes to be applied.
1993 $linkType: The external link type
1995 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1997 $title: the Title object that the link is pointing to
1998 $file: the File object or false if broken link
1999 &$html: the link text
2000 &$attribs: the attributes to be applied
2001 &$ret: the value to return if your hook returns false
2003 'HtmlPageLinkRendererBegin':
2004 Used when generating internal and interwiki links in
2005 LinkRenderer, before processing starts. Return false to skip default
2006 processing and return $ret.
2007 $linkRenderer: the LinkRenderer object
2008 $target: the LinkTarget that the link is pointing to
2009 &$text: the contents that the <a> tag should have; either a plain, unescaped
2010 string or a HtmlArmor object; null means "default".
2011 &$customAttribs: the HTML attributes that the <a> tag should have, in
2012 associative array form, with keys and values unescaped. Should be merged
2013 with default values, with a value of false meaning to suppress the
2015 &$query: the query string to add to the generated URL (the bit after the "?"),
2016 in associative array form, with keys and values unescaped.
2017 &$ret: the value to return if your hook returns false.
2019 'HtmlPageLinkRendererEnd':
2020 Used when generating internal and interwiki links in LinkRenderer,
2021 just before the function returns a value. If you return true, an <a> element
2022 with HTML attributes $attribs and contents $html will be returned. If you
2023 return false, $ret will be returned.
2024 $linkRenderer: the LinkRenderer object
2025 $target: the LinkTarget object that the link is pointing to
2026 $isKnown: boolean indicating whether the page is known or not
2027 &$text: the contents that the <a> tag should have; either a plain, unescaped
2028 string or a HtmlArmor object.
2029 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2030 associative array form.
2031 &$ret: the value to return if your hook returns false.
2033 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2035 &$linksUpdate: the LinksUpdate object
2037 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2038 each link table insert. For example, pagelinks, imagelinks, externallinks.
2039 $linksUpdate: LinksUpdate object
2040 $table: the table to insert links to
2041 $insertions: an array of links to insert
2043 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2044 including delete and insert, has completed for all link tables
2045 &$linksUpdate: the LinksUpdate object
2046 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2048 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2049 &$linksUpdate: the LinksUpdate object
2051 'ListDefinedTags': When trying to find all defined tags.
2052 &$tags: The list of tags.
2054 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2055 $updater: A DatabaseUpdater subclass
2057 'LocalFile::getHistory': Called before file history query performed.
2058 &$file: the File object
2060 &$fields: select fields
2062 &$opts: query options
2063 &$join_conds: JOIN conditions
2065 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2066 $file: the File object
2067 $archiveName: name of an old file version or false if it's the current one
2069 'LocalisationCacheRecache': Called when loading the localisation data into
2071 $cache: The LocalisationCache object
2072 $code: language code
2073 &$alldata: The localisation data from core and extensions
2074 &$purgeBlobs: whether to purge/update the message blobs via
2075 MessageBlobStore::clear()
2077 'LocalisationCacheRecacheFallback': Called for each language when merging
2078 fallback data into the cache.
2079 $cache: The LocalisationCache object
2080 $code: language code
2081 &$alldata: The localisation data from core and extensions. Note some keys may
2082 be omitted if they won't be merged into the final result.
2084 'LocalisationChecksBlacklist': When fetching the blacklist of
2085 localisation checks.
2086 &$blacklist: array of checks to blacklist. See the bottom of
2087 maintenance/language/checkLanguage.inc for the format of this variable.
2089 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2090 optional localisation messages
2091 &$ignored: Array of ignored message keys
2092 &$optional: Array of optional message keys
2094 'LocalUserCreated': Called when a local user has been created
2095 $user: User object for the created user
2096 $autocreated: Boolean, whether this was an auto-creation
2098 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2099 Special:Log for a specific log type
2100 $type: String of log type being displayed
2101 $logEventsList: LogEventsList object for context and access to the WebRequest
2102 &$input: string HTML of an input element
2104 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2105 Returning false will prevent the string from being added to the OutputPage.
2106 &$s: html string to show for the log extract
2107 $types: String or Array Log types to show
2108 $page: String or Title The page title to show log entries for
2109 $user: String The user who made the log entries
2110 $param: Associative Array with the following additional options:
2111 - lim Integer Limit of items to show, default is 50
2112 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2113 - showIfEmpty boolean Set to false if you don't want any output in case the
2114 loglist is empty if set to true (default), "No matching items in log" is
2115 displayed if loglist is empty
2116 - msgKey Array If you want a nice box with a message, set this to the key of
2117 the message. First element is the message key, additional optional elements
2118 are parameters for the key that are processed with
2119 wfMessage()->params()->parseAsBlock()
2120 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2122 - wrap String Wrap the message in html (usually something like
2123 "<div ...>$1</div>").
2124 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2126 'LogException': Called before an exception (or PHP error) is logged. This is
2127 meant for integration with external error aggregation services; returning false
2128 will NOT prevent logging.
2129 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2130 $suppressed: true if the error was suppressed via
2131 error_reporting()/wfSuppressWarnings()
2133 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2134 error messages. Allows to add additional error messages (except messages already
2135 in LoginForm::$validErrorMessages).
2136 &$messages: Already added messages (inclusive messages from
2137 LoginForm::$validErrorMessages)
2139 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2140 Called during login to allow extensions the opportunity to inform a user that
2141 their username doesn't exist for a specific reason, instead of letting the
2142 login form give the generic error message that the account does not exist. For
2143 example, when the account has been renamed or deleted.
2144 $user: the User object being authenticated against.
2145 &$msg: the message identifier for abort reason, or an array to pass a message
2148 'LogLine': Processes a single log entry on Special:Log.
2149 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2150 logging.log_type database field.
2151 $log_action: string for the type of log action (e.g. 'delete', 'block',
2152 'create2'). Corresponds to logging.log_action database field.
2153 $title: Title object that corresponds to logging.log_namespace and
2154 logging.log_title database fields.
2155 $paramArray: Array of parameters that corresponds to logging.log_params field.
2156 Note that only $paramArray[0] appears to contain anything.
2157 &$comment: string that corresponds to logging.log_comment database field, and
2158 which is displayed in the UI.
2159 &$revert: string that is displayed in the UI, similar to $comment.
2160 $time: timestamp of the log entry (added in 1.12)
2162 'LonelyPagesQuery': Allow extensions to modify the query used by
2163 Special:LonelyPages.
2164 &$tables: tables to join in the query
2165 &$conds: conditions for the query
2166 &$joinConds: join conditions for the query
2168 'MagicWordwgVariableIDs': When defining new magic words IDs.
2169 &$variableIDs: array of strings
2171 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2173 $refreshLinks: RefreshLinks object
2175 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2176 Ideally, this hook should only be used to add variables that depend on
2177 the current page/request; static configuration should be added through
2178 ResourceLoaderGetConfigVars instead.
2179 &$vars: variable (or multiple variables) to be added into the output of
2180 Skin::makeVariablesScript
2181 $out: The OutputPage which called the hook, can be used to get the real title.
2183 'MarkPatrolled': Before an edit is marked patrolled.
2184 $rcid: ID of the revision to be marked patrolled
2185 &$user: the user (object) marking the revision as patrolled
2186 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2187 sysop in order to mark an edit patrolled.
2188 $auto: true if the edit is being marked as patrolled automatically
2190 'MarkPatrolledComplete': After an edit is marked patrolled.
2191 $rcid: ID of the revision marked as patrolled
2192 &$user: user (object) who marked the edit patrolled
2193 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2194 sysop to patrol the edit.
2195 $auto: true if the edit is being marked as patrolled automatically
2197 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2198 something completely different, after the basic globals have been set up, but
2199 before ordinary actions take place.
2201 $article: Article on which the action will be performed
2202 $title: Title on which the action will be performed
2204 $request: $wgRequest
2205 $mediaWiki: The $mediawiki object
2207 'MediaWikiServices': Called when a global MediaWikiServices instance is
2208 initialized. Extensions may use this to define, replace, or wrap services.
2209 However, the preferred way to define a new service is
2210 the $wgServiceWiringFiles array.
2211 $services: MediaWikiServices
2213 'MessageCache::get': When fetching a message. Can be used to override the key
2214 for customisations. Given and returned message key must be in special format:
2215 1) first letter must be in lower case according to the content language.
2216 2) spaces must be replaced with underscores
2217 &$key: message key (string)
2219 'MessageCacheReplace': When a message page is changed. Useful for updating
2221 $title: name of the page changed.
2222 $text: new contents of the page.
2224 'MessagesPreLoad': When loading a message from the database.
2225 $title: title of the message (string)
2226 &$message: value (string), change it to the message you want to define
2228 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2229 $mimeMagic: Instance of MimeMagic.
2230 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2231 &$tail: More or equal than last 65558 bytes of the file in a string
2232 (in - Do not alter!).
2234 &$mime: MIME type (out).
2236 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2237 MIME type detected by considering the file extension.
2238 $mimeMagic: Instance of MimeMagic.
2239 $ext: File extension.
2240 &$mime: MIME type (in/out).
2242 'MimeMagicInit': Before processing the list mapping MIME types to media types
2243 and the list mapping MIME types to file extensions.
2244 As an extension author, you are encouraged to submit patches to MediaWiki's
2245 core to add new MIME types to mime.types.
2246 $mimeMagic: Instance of MimeMagic.
2247 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2248 for adding new MIME info to the list.
2249 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2250 for adding new MIME types to the list.
2252 'ModifyExportQuery': Modify the query used by the exporter.
2253 $db: The database object to be queried.
2254 &$tables: Tables in the query.
2255 &$conds: Conditions in the query.
2256 &$opts: Options for the query.
2257 &$join_conds: Join conditions for the query.
2259 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2261 $oldTitle: Title object of the current (old) location
2262 $newTitle: Title object of the new location
2263 $user: User making the move
2264 $reason: string of the reason provided by the user
2265 $status: Status object to pass error messages to
2267 'MovePageIsValidMove': Specify whether a page can be moved for technical
2269 $oldTitle: Title object of the current (old) location
2270 $newTitle: Title object of the new location
2271 $status: Status object to pass error messages to
2273 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2275 $index: Integer; the index of the namespace being checked.
2276 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2277 namespace are movable. Hooks may change this value to override the return
2278 value of MWNamespace::isMovable().
2280 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2281 $title: the diff page title (nullable)
2282 &$oldId: the actual old Id to use in the diff
2283 &$newId: the actual new Id to use in the diff (0 means current)
2284 $old: the ?old= param value from the url
2285 $new: the ?new= param value from the url
2287 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2289 $wikiPage: the WikiPage edited
2290 $rev: the new revision
2291 $baseID: the revision ID this was based off, if any
2292 $user: the editing user
2294 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2295 return false to omit the line from RecentChanges and Watchlist special pages.
2296 &$changeslist: The OldChangesList instance.
2297 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2298 $rc: The RecentChange object.
2299 &$classes: array of css classes for the <li> element
2301 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2302 can alter or append to the array of URLs for search & suggestion formats.
2303 &$urls: array of associative arrays with Url element attributes
2305 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2306 when a page view triggers a re-rendering of the page. This may happen
2307 particularly if the parser cache is split by user language, and no cached
2308 rendering of the page exists in the user's language. The hook is called
2309 before checking whether page_links_updated indicates that the links are up
2310 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2311 without triggering any updates.
2312 $page: the Page that was rendered.
2313 $title: the Title of the rendered page.
2314 $parserOutput: ParserOutput resulting from rendering the page.
2316 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2317 users and/or IP addresses too.
2318 &$otherBlockLink: An array with links to other block logs
2319 $ip: The requested IP address or username
2321 'OutputPageBeforeHTML': A page has been processed by the parser and the
2322 resulting HTML is about to be displayed.
2323 &$parserOutput: the parserOutput (object) that corresponds to the page
2324 &$text: the text that will be displayed, in HTML (string)
2326 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2327 body tag to allow for extensions to add attributes to the body of the page they
2328 might need. Or to allow building extensions to add body classes that aren't of
2329 high enough demand to be included in core.
2330 $out: The OutputPage which called the hook, can be used to get the real title
2331 $sk: The Skin that called OutputPage::headElement
2332 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2334 'OutputPageCheckLastModified': when checking if the page has been modified
2335 since the last visit.
2336 &$modifiedTimes: array of timestamps.
2337 The following keys are set: page, user, epoch
2338 $out: OutputPage object (since 1.28)
2340 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2341 categories. Implementations should return false if they generate the category
2342 links, so the default link generation is skipped.
2343 &$out: OutputPage instance (object)
2344 $categories: associative array, keys are category names, values are category
2345 types ("normal" or "hidden")
2346 &$links: array, intended to hold the result. Must be an associative array with
2347 category types as keys and arrays of HTML links as values.
2349 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2350 &$out: OutputPage instance (object)
2351 $parserOutput: parserOutput instance being added in $out
2353 'PageContentInsertComplete': After a new article is created.
2354 $wikiPage: WikiPage created
2355 $user: User creating the article
2356 $content: New content as a Content object
2357 $summary: Edit summary/comment
2358 $isMinor: Whether or not the edit was marked as minor
2359 $isWatch: (No longer used)
2360 $section: (No longer used)
2361 $flags: Flags passed to WikiPage::doEditContent()
2362 $revision: New Revision of the article
2364 'PageContentLanguage': Allows changing the language in which the content of a
2365 page is written. Defaults to the wiki content language ($wgContLang).
2366 $title: Title object
2367 &$pageLang: the page content language (either an object or a language code)
2368 $wgLang: the user language
2370 'PageContentSave': Before an article is saved.
2371 $wikiPage: the WikiPage (object) being saved
2372 $user: the user (object) saving the article
2373 $content: the new article content, as a Content object
2374 $summary: the article summary (comment)
2375 $isminor: minor flag
2376 $iswatch: watch flag
2379 'PageContentSaveComplete': After an article has been updated.
2380 $wikiPage: WikiPage modified
2381 $user: User performing the modification
2382 $content: New content, as a Content object
2383 $summary: Edit summary/comment
2384 $isMinor: Whether or not the edit was marked as minor
2385 $isWatch: (No longer used)
2386 $section: (No longer used)
2387 $flags: Flags passed to WikiPage::doEditContent()
2388 $revision: New Revision of the article (can be null for edits that change
2390 $status: Status object about to be returned by doEditContent()
2391 $baseRevId: the rev ID (or false) this edit was based on
2393 'PageHistoryBeforeList': When a history page list is about to be constructed.
2394 &$article: the article that the history is loading for
2395 $context: RequestContext object
2397 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2398 $historyAction: the action object
2399 &$row: the revision row for this line
2400 &$s: the string representing this parsed line
2401 &$classes: array containing the <li> element classes
2403 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2404 any output is generated, to allow batch lookups for prefetching information
2405 needed for display. If the hook handler returns false, the regular behavior of
2406 doBatchLookups() is skipped.
2407 $pager: the PageHistoryPager
2408 $result: a ResultWrapper representing the query result
2410 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2413 &$queryInfo: the query parameters
2415 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2416 which depends on user options should install this hook and append its values to
2418 &$confstr: reference to a hash key string which can be modified
2419 $user: User (object) requesting the page
2420 &$forOptions: array of options the hash is for
2422 'PageViewUpdates': Allow database (or other) changes to be made after a
2423 page view is seen by MediaWiki. Note this does not capture views made
2424 via external caches such as Squid.
2425 $wikipage: WikiPage (object) for the page being viewed.
2426 $user: User (object) for the user who is viewing.
2428 'ParserAfterParse': Called from Parser::parse() just after the call to
2429 Parser::internalParse() returns.
2430 &$parser: parser object
2431 &$text: text being parsed
2432 &$stripState: stripState used (object)
2434 'ParserAfterStrip': Called at end of parsing time.
2435 TODO: No more strip, deprecated ?
2436 &$parser: parser object
2437 &$text: text being parsed
2438 &$stripState: stripState used (object)
2440 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2441 &$parser: Parser object being used
2442 &$text: text that will be returned
2444 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2445 Parser::internalParseHalfParsed()
2446 &$parser: Parser object being used
2447 &$text: text that will be returned
2449 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2450 &$parser: Parser object
2451 &$text: text to parse
2452 &$stripState: StripState instance being used
2454 'ParserBeforeStrip': Called at start of parsing time.
2455 TODO: No more strip, deprecated ?
2456 &$parser: parser object
2457 &$text: text being parsed
2458 &$stripState: stripState used (object)
2460 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2461 &$parser: Parser object being used
2464 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2466 $parserCache: ParserCache object $parserOutput was stored in
2467 $parserOutput: ParserOutput object that was stored
2468 $title: Title of the page that was parsed to generate $parserOutput
2469 $popts: ParserOptions used for generating $parserOutput
2470 $revId: ID of the revision that was parsed to create $parserOutput
2472 'ParserClearState': Called at the end of Parser::clearState().
2473 &$parser: Parser object being cleared
2475 'ParserCloned': Called when the parser is cloned.
2476 $parser: Newly-cloned Parser object
2478 'ParserFetchTemplate': Called when the parser fetches a template
2479 $parser: Parser Parser object or false
2480 $title: Title object of the template to be fetched
2481 $rev: Revision object of the template
2482 &$text: Transclusion text of the template or false or null
2483 &$deps: Array of template dependencies with 'title', 'page_id', 'rev_id' keys
2485 'ParserFirstCallInit': Called when the parser initialises for the first time.
2486 &$parser: Parser object being cleared
2488 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2490 &$parser: Parser object
2491 &$varCache: array to store the value in case of multiples calls of the
2493 &$index: index (string) of the magic
2494 &$ret: value of the magic word (the hook should set it)
2495 &$frame: PPFrame object to use for expanding any template variables
2497 'ParserGetVariableValueTs': Use this to change the value of the time for the
2498 {{LOCAL...}} magic word.
2499 &$parser: Parser object
2500 &$time: actual time (timestamp)
2502 'ParserGetVariableValueVarCache': use this to change the value of the variable
2503 cache or return false to not use it.
2504 &$parser: Parser object
2505 &$varCache: variable cache (array)
2507 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2508 ParserLimitReportFormat instead.
2509 Called at the end of Parser:parse() when the parser will
2510 include comments about size of the text parsed.
2511 $parser: Parser object
2512 &$limitReport: text that will be included (without comment tags)
2514 'ParserLimitReportFormat': Called for each row in the parser limit report that
2515 needs formatting. If nothing handles this hook, the default is to use "$key" to
2516 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2518 $key: Key for the limit report item (string)
2519 &$value: Value of the limit report item
2520 &$report: String onto which to append the data
2521 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2522 text intended for display in a monospaced font.
2523 $localize: If false, $report should be output in English.
2525 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2526 will include comments about size of the text parsed. Hooks should use
2527 $output->setLimitReportData() to populate data. Functions for this hook should
2528 not use $wgLang; do that in ParserLimitReportFormat instead.
2529 $parser: Parser object
2530 $output: ParserOutput object
2532 'ParserMakeImageParams': Called before the parser make an image link, use this
2533 to modify the parameters of the image.
2534 $title: title object representing the file
2535 $file: file object that will be used to create the image
2536 &$params: 2-D array of parameters
2537 $parser: Parser object that called the hook
2539 'ParserSectionCreate': Called each time the parser creates a document section
2540 from wikitext. Use this to apply per-section modifications to HTML (like
2541 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2542 can begin in one section and end in another. Make sure your code can handle
2543 that case gracefully. See the EditSectionClearerLink extension for an example.
2544 $parser: the calling Parser instance
2545 $section: the section number, zero-based, but section 0 is usually empty
2546 &$sectionContent: ref to the content of the section. modify this.
2547 $showEditLinks: boolean describing whether this section has an edit link
2549 'ParserTestGlobals': Allows to define globals for parser tests.
2550 &$globals: Array with all the globals which should be set for parser tests.
2551 The arrays keys serve as the globals names, its values are the globals values.
2553 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2554 run. Use when page save hooks require the presence of custom tables to ensure
2555 that tests continue to run properly.
2556 &$tables: array of table names
2558 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2559 $page: the WikiPage of the candidate edit
2560 $content: the Content object of the candidate edit
2561 $output: the ParserOutput result of the candidate edit
2562 $summary: the change summary of the candidate edit
2563 $user: the User considering the edit
2565 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2566 $user: User object whose policy you are modifying
2567 &$effectivePolicy: Array of policy statements that apply to this user
2569 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2571 $block: Block object (which is set to be autoblocking)
2572 &$blockIds: Array of block IDs of the autoblock
2574 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2575 my talk page, my contributions" etc).
2576 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2577 &$title: Title object representing the current page
2578 $skin: SkinTemplate object providing context (e.g. to check if the user is
2581 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2582 &$user: User performing the action
2583 $action: Action being performed
2584 &$result: Whether or not the action should be prevented
2585 Change $result and return false to give a definitive answer, otherwise
2586 the built-in rate limiting checks are used, if enabled.
2587 $incrBy: Amount to increment counter by
2589 'PlaceNewSection': Override placement of new sections. Return false and put the
2590 merged text into $text to override the default behavior.
2591 $wikipage: WikiPage object
2592 $oldtext: the text of the article before editing
2593 $subject: subject of the new section
2594 &$text: text of the new section
2596 'PostLoginRedirect': Modify the post login redirect behavior.
2597 Occurs after signing up or logging in, allows for interception of redirect.
2598 &$returnTo: The page name to return to, as a string
2599 &$returnToQuery: array of url parameters, mapping parameter names to values
2600 &$type: type of login redirect as string;
2601 error: display a return to link ignoring $wgRedirectOnLogin
2602 signup: display a return to link using $wgRedirectOnLogin if needed
2603 success: display a return to link using $wgRedirectOnLogin if needed
2604 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2606 'PreferencesFormPreSave': Override preferences being saved
2607 $formData: array of user submitted data
2608 $form: PreferencesForm object, also a ContextSource
2609 $user: User object with preferences to be saved set
2610 &$result: boolean indicating success
2612 'PreferencesGetLegend': Override the text used for the <legend> of a
2613 preferences section.
2614 $form: the PreferencesForm object. This is a ContextSource as well
2615 $key: the section name
2616 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2619 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2620 Override the title prefix search used for OpenSearch and
2621 AJAX search suggestions. Put results into &$results outparam and return false.
2622 $ns: array of int namespace keys to search in
2623 $search: search term (not guaranteed to be conveniently normalized)
2624 $limit: maximum number of results to return
2625 &$results: out param: array of page names (strings)
2626 $offset: number of results to offset from the beginning
2628 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2629 namespace from the search string so that extensions can attempt it.
2630 &$namespaces: array of int namespace keys to search in (change this if you can
2632 &$search: search term (replace this with term without the namespace if you can
2635 'PrefsEmailAudit': Called when user changes their email address.
2636 $user: User (object) changing his email address
2637 $oldaddr: old email address (string)
2638 $newaddr: new email address (string)
2640 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2642 $article: the title being (un)protected
2643 &$output: a string of the form HTML so far
2645 'ProtectionForm::save': Called when a protection form is submitted.
2646 $article: the Page being (un)protected
2647 &$errorMsg: an html message string of an error or an array of message name and
2649 $reasonstr: a string describing the reason page protection level is altered
2651 'ProtectionForm::showLogExtract': Called after the protection log extract is
2653 $article: the page the form is shown for
2654 $out: OutputPage object
2656 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2658 &$tables: Database tables to be used in the query
2659 &$conds: Conditions to be applied in the query
2660 &$joinConds: Join conditions to be applied in the query
2662 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2663 &$obj: RawAction object
2664 &$text: The text that's going to be the output
2666 'RecentChange_save': Called at the end of RecentChange::save().
2667 &$recentChange: RecentChange object
2669 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2670 names such as "oldid" that are preserved when using redirecting special pages
2671 such as Special:MyPage and Special:MyTalk.
2672 &$redirectParams: An array of parameters preserved by redirecting special pages.
2674 'RejectParserCacheValue': Return false to reject an otherwise usable
2675 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2676 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2678 $parserOutput: ParserOutput value.
2679 $wikiPage: WikiPage object.
2680 $parserOptions: ParserOptions object.
2682 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2683 instance. Can be used by an extension override what skin is used in certain
2685 $context: (IContextSource) The RequestContext the skin is being created for.
2686 &$skin: A variable reference you may set a Skin instance or string key on to
2687 override the skin that will be used for the context.
2689 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2690 flagged to lack same-origin security. Return false to indicate the lack. Note
2691 if the "somehow" involves HTTP headers, you'll probably need to make sure
2692 the header is varied on.
2693 $request: The WebRequest object.
2695 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2696 $user: The user having their password expiration reset
2697 &$newExpire: The new expiration date
2699 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2700 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2701 to override its behavior. See the module docs for more information.
2702 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2704 $context: ResourceLoaderContext|null
2706 'ResourceLoaderGetConfigVars': Called at the end of
2707 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2708 configuration variables to JavaScript. Things that depend on the current page
2709 or request state must be added through MakeGlobalVariablesScript instead.
2710 &$vars: array( variable name => value )
2712 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2713 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2714 context-based variables.
2715 &$lessVars: array of variables already added
2717 'ResourceLoaderRegisterModules': Right before modules information is required,
2718 such as when responding to a resource
2719 loader request or generating HTML output.
2720 &$resourceLoader: ResourceLoader object
2722 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2723 called after the addition of 'qunit' and MediaWiki testing resources.
2724 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2725 included in core, is fed using tests/qunit/QUnitTestResources.php.
2726 To add a new qunit module named 'myext.tests':
2727 $testModules['qunit']['myext.tests'] = array(
2728 'script' => 'extension/myext/tests.js',
2729 'dependencies' => <any module dependency you might have>
2731 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2732 added to any module.
2733 &$ResourceLoader: object
2735 'RevisionInsertComplete': Called after a revision is inserted into the database.
2736 &$revision: the Revision
2737 $data: the data stored in old_text. The meaning depends on $flags: if external
2738 is set, it's the URL of the revision text in external storage; otherwise,
2739 it's the revision text itself. In either case, if gzip is set, the revision
2741 $flags: a comma-delimited list of strings representing the options used. May
2742 include: utf8 (this will always be set for new revisions); gzip; external.
2744 'SearchableNamespaces': An option to modify which namespaces are searchable.
2745 &$arr: Array of namespaces ($nsId => $name) which will be used.
2747 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2748 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2750 $term: Search term string
2751 &$title: Outparam; set to $title object and return false for a match
2753 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2754 if nothing was found.
2755 $term: Search term string
2756 &$title: Outparam; set to $title object and return false for a match
2758 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2759 the normal operations.
2760 $allSearchTerms: Array of the search terms in all content languages
2761 &$titleResult: Outparam; the value to return. A Title object or null.
2763 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2765 $term: Search term string
2766 &$title: Current Title object that is being returned (null if none found).
2768 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2770 $title: Current Title object being displayed in search results.
2771 &$id: Revision ID (default is false, for latest)
2773 'SearchIndexFields': Add fields to search index mapping.
2774 &$fields: Array of fields, all implement SearchIndexField
2775 $engine: SearchEngine instance for which mapping is being built.
2777 'SearchDataForIndex': Add data to search document. Allows to add any data to
2778 the field map used to index the document.
2779 &$fields: Array of name => value pairs for fields
2780 $handler: ContentHandler for the content being indexed
2781 $page: WikiPage that is being indexed
2782 $output: ParserOutput that is produced from the page
2783 $engine: SearchEngine for which the indexing is intended
2785 'SearchResultsAugment': Allows extension to add its code to the list of search
2787 &$setAugmentors: List of whole-set augmentor objects, must implement ResultSetAugmentor
2788 &$rowAugmentors: List of per-row augmentor objects, must implement ResultAugmentor.
2789 Note that lists should be in the format name => object and the names in both lists should
2792 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2793 perform when page content is modified. Currently called by
2794 AbstractContent::getSecondaryDataUpdates.
2795 $title: Title of the page that is being edited.
2796 $oldContent: Content object representing the page's content before the edit.
2797 $recursive: bool indicating whether DataUpdates should trigger recursive
2798 updates (relevant mostly for LinksUpdate).
2799 $parserOutput: ParserOutput representing the rendered version of the page
2801 &$updates: a list of DataUpdate objects, to be modified or replaced by
2804 'SecuritySensitiveOperationStatus': Affect the return value from
2805 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2806 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2807 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2808 authentication isn't possible for the current session type.
2809 $operation: (string) The operation being checked.
2810 $session: (MediaWiki\Session\Session) The current session. The
2811 currently-authenticated user may be retrieved as $session->getUser().
2812 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2813 the time of last auth is unknown, or -1 if authentication is not possible.
2815 'SelfLinkBegin': Called before a link to the current article is displayed to
2816 allow the display of the link to be customized.
2817 $nt: the Title object
2818 &$html: html to display for the link
2819 &$trail: optional text to display before $html
2820 &$prefix: optional text to display after $html
2821 &$ret: the value to return if your hook returns false
2823 'SendWatchlistEmailNotification': Return true to send watchlist email
2825 $targetUser: the user whom to send watchlist email notification
2826 $title: the page title
2827 $enotif: EmailNotification object
2829 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2830 loaded from storage. Return false to prevent it from being used.
2831 &$reason: String rejection reason to be logged
2832 $info: MediaWiki\Session\SessionInfo being validated
2833 $request: WebRequest being loaded from
2834 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2835 $data: Array|false Data array for the MediaWiki\Session\Session
2837 'SessionMetadata': Add metadata to a session being saved.
2838 $backend: MediaWiki\Session\SessionBackend being saved.
2839 &$metadata: Array Metadata to be stored. Add new keys here.
2840 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2841 request and 0+ FauxRequests.
2843 'SetupAfterCache': Called in Setup.php, after cache objects are set
2845 'ShortPagesQuery': Allow extensions to modify the query used by
2847 &$tables: tables to join in the query
2848 &$conds: conditions for the query
2849 &$joinConds: join conditions for the query
2850 &$options: options for the query
2852 'ShowMissingArticle': Called when generating the output for a non-existent page.
2853 $article: The article object corresponding to the page
2855 'ShowSearchHit': Customize display of search hit.
2856 $searchPage: The SpecialSearch instance.
2857 $result: The SearchResult to show
2858 $terms: Search terms, for highlighting
2859 &$link: HTML of link to the matching page. May be modified.
2860 &$redirect: HTML of redirect info. May be modified.
2861 &$section: HTML of matching section. May be modified.
2862 &$extract: HTML of content extract. May be modified.
2863 &$score: HTML of score. May be modified.
2864 &$size: HTML of page size. May be modified.
2865 &$date: HTML of of page modification date. May be modified.
2866 &$related: HTML of additional info for the matching page. May be modified.
2867 &$html: May be set to the full HTML that should be used to represent the search
2868 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2869 function returned false.
2871 'ShowSearchHitTitle': Customise display of search hit title/link.
2872 &$title: Title to link to
2873 &$text: Text to use for the link
2874 $result: The search result
2875 $terms: The search terms entered
2876 $page: The SpecialSearch object
2877 &$query: Query string to be appended to the link
2879 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2880 Warning: This hook is run on each display. You should consider to use
2881 'SkinBuildSidebar' that is aggressively cached.
2883 &$bar: Sidebar content
2884 Modify $bar to add or modify sidebar portlets.
2886 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2887 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2888 the sitenotice/anonnotice.
2891 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2892 allow the normal method of notice selection/rendering to work, or change the
2893 value of $siteNotice and return false to alter it.
2894 &$siteNotice: HTML returned as the sitenotice
2897 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2899 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2900 the stock bottom scripts.
2902 'SkinAfterContent': Allows extensions to add text after the page content and
2903 article metadata. This hook should work in all skins. Set the &$data variable to
2904 the text you're going to add.
2905 &$data: (string) Text to be printed out directly (without parsing)
2908 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2910 &$bar: Sidebar contents
2911 Modify $bar to add or modify sidebar portlets.
2913 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2915 $title: displayed page title
2916 $type: 'normal' or 'history' for old/diff views
2917 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2918 message must be in HTML format, not wikitext!
2919 &$link: overridable HTML link to be passed into the message as $1
2920 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2923 'SkinEditSectionLinks': Modify the section edit links
2924 $skin: Skin object rendering the UI
2925 $title: Title object for the title being linked to (may not be the same as
2926 the page title, if the section is included from a template)
2927 $section: The designation of the section being pointed to, to be included in
2928 the link, like "§ion=$section"
2929 $tooltip: The default tooltip. Escape before using.
2930 By default, this is wrapped in the 'editsectionhint' message.
2931 &$result: Array containing all link detail arrays. Each link detail array should
2932 contain the following keys:
2933 - targetTitle - Target Title object
2934 - text - String for the text
2935 - attribs - Array of attributes
2936 - query - Array of query parameters to add to the URL
2937 - options - Array of options for Linker::link
2938 $lang: The language code to use for the link in the wfMessage function
2940 'SkinGetPoweredBy': TODO
2941 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2942 the MediaWiki icon but plain text instead.
2945 'SkinPreloadExistence': Supply titles that should be added to link existence
2946 cache before the page is rendered.
2947 &$titles: Array of Title objects
2950 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2951 If false is returned $subpages will be used instead of the HTML
2952 subPageSubtitle() generates.
2953 If true is returned, $subpages will be ignored and the rest of
2954 subPageSubtitle() will run.
2955 &$subpages: Subpage links HTML
2957 $out: OutputPage object
2959 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2961 &$sktemplate: SkinTemplate object
2962 &$nav_urls: array of tabs
2963 &$revid: The revision id of the permanent link
2964 &$revid2: The revision id of the permanent link, second time
2966 'SkinTemplateGetLanguageLink': After building the data for a language link from
2967 which the actual html is constructed.
2968 &$languageLink: array containing data about the link. The following keys can be
2969 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2970 $languageLinkTitle: Title object belonging to the external language link.
2971 $title: Title object of the page the link belongs to.
2972 $outputPage: The OutputPage object the links are built from.
2974 'SkinTemplateNavigation': Called on content pages after the tabs have been
2975 added, but before variants have been added.
2976 &$sktemplate: SkinTemplate object
2977 &$links: Structured navigation links. This is used to alter the navigation for
2978 skins which use buildNavigationUrls such as Vector.
2980 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2981 tab is added but before variants have been added.
2982 &$sktemplate: SkinTemplate object
2983 &$links: Structured navigation links. This is used to alter the navigation for
2984 skins which use buildNavigationUrls such as Vector.
2986 'SkinTemplateNavigation::Universal': Called on both content and special pages
2987 after variants have been added.
2988 &$sktemplate: SkinTemplate object
2989 &$links: Structured navigation links. This is used to alter the navigation for
2990 skins which use buildNavigationUrls such as Vector.
2992 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2994 &$sktemplate: SkinTemplate object
2995 &$tpl: QuickTemplate engine object
2997 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2998 &$sktemplate: SkinTemplate object
2999 &$res: set to true to prevent active tabs
3001 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
3002 You can either create your own array, or alter the parameters for
3004 &$sktemplate: The SkinTemplate instance.
3005 $title: Title instance for the page.
3006 $message: Visible label of tab.
3007 $selected: Whether this is a selected tab.
3008 $checkEdit: Whether or not the action=edit query should be added if appropriate.
3009 &$classes: Array of CSS classes to apply.
3010 &$query: Query string to add to link.
3012 &$result: Complete assoc. array if you want to return true.
3014 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
3015 been rendered (useful for adding more).
3016 &$sk: The QuickTemplate based skin template running the hook.
3017 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3018 extensions that add support for BaseTemplateToolbox should watch for this
3019 dummy parameter with "$dummy=false" in their code and return without echoing
3020 any HTML to avoid creating duplicate toolbox items.
3022 'SoftwareInfo': Called by Special:Version for returning information about the
3024 &$software: The array of software in format 'name' => 'version'. See
3025 SpecialVersion::softwareInformation().
3027 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3028 $sp: SpecialPage object, for context
3029 &$fields: Current HTMLForm fields
3031 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3032 $id: User id number, only provided for backwards-compatibility
3033 $user: User object representing user contributions are being fetched for
3034 $sp: SpecialPage instance, providing context
3036 'SpecialContributions::formatRow::flags': Called before rendering a
3037 Special:Contributions row.
3038 $context: IContextSource object
3039 $row: Revision information from the database
3040 &$flags: List of flags on this row
3042 'SpecialContributions::getForm::filters': Called with a list of filters to render
3043 on Special:Contributions.
3044 $sp: SpecialContributions object, for context
3045 &$filters: List of filters rendered as HTML
3047 'SpecialListusersDefaultQuery': Called right before the end of
3048 UsersPager::getDefaultQuery().
3049 $pager: The UsersPager instance
3050 &$query: The query array to be returned
3052 'SpecialListusersFormatRow': Called right before the end of
3053 UsersPager::formatRow().
3054 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
3055 $row: Database row object
3057 'SpecialListusersHeader': Called before closing the <fieldset> in
3058 UsersPager::getPageHeader().
3059 $pager: The UsersPager instance
3060 &$out: The header HTML
3062 'SpecialListusersHeaderForm': Called before adding the submit button in
3063 UsersPager::getPageHeader().
3064 $pager: The UsersPager instance
3065 &$out: The header HTML
3067 'SpecialListusersQueryInfo': Called right before the end of.
3068 UsersPager::getQueryInfo()
3069 $pager: The UsersPager instance
3070 &$query: The query array to be returned
3072 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3073 $type: String of the log type
3074 $request: WebRequest object for getting the value provided by the current user
3075 &$qc: Array for query conditions to add
3077 'SpecialMovepageAfterMove': Called after moving a page.
3078 &$movePage: MovePageForm object
3079 &$oldTitle: old title (object)
3080 &$newTitle: new title (object)
3082 'SpecialNewpagesConditions': Called when building sql query for
3084 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3085 $opts: FormOptions object containing special page options
3086 &$conds: array of WHERE conditionals for query
3087 &$tables: array of tables to be queried
3088 &$fields: array of columns to select
3089 &$join_conds: join conditions for the tables
3091 'SpecialNewPagesFilters': Called after building form options at NewPages.
3092 $special: the special page object
3093 &$filters: associative array of filter definitions. The keys are the HTML
3094 name/URL parameters. Each key maps to an associative array with a 'msg'
3095 (message key) and a 'default' value.
3097 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3098 this hook to remove a core special page or conditionally register special pages.
3099 &$list: list (array) of core special pages
3101 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3102 $special: the SpecialPage object
3103 $subPage: the subpage string or null if no subpage was specified
3105 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3106 Return false to prevent execution.
3107 $special: the SpecialPage object
3108 $subPage: the subpage string or null if no subpage was specified
3110 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3111 $name: name of the special page
3112 &$form: HTMLForm object
3114 'SpecialPasswordResetOnSubmit': When executing a form submission on
3115 Special:PasswordReset.
3116 &$users: array of User objects.
3117 $data: array of data submitted by the user
3118 &$error: string, error code (message key) used to describe to error (out
3119 parameter). The hook needs to return false when setting this, otherwise it
3120 will have no effect.
3122 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3123 use this to change some selection criteria or substitute a different title.
3124 &$randstr: The random number from wfRandom()
3125 &$isRedir: Boolean, whether to select a redirect or non-redirect
3126 &$namespaces: An array of namespace indexes to get the title from
3127 &$extra: An array of extra SQL statements
3128 &$title: If the hook returns false, a Title object to use instead of the
3129 result from the normal query
3131 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3133 Called after building form options at RecentChanges.
3134 $special: the special page object
3135 &$filters: associative array of filter definitions. The keys are the HTML
3136 name/URL parameters. Each key maps to an associative array with a 'msg'
3137 (message key) and a 'default' value.
3139 'SpecialRecentChangesPanel': Called when building form options in
3140 SpecialRecentChanges.
3141 &$extraOpts: array of added items, to which can be added
3142 $opts: FormOptions for this request
3144 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
3146 Called when building SQL query for SpecialRecentChanges and
3147 SpecialRecentChangesLinked.
3148 &$conds: array of WHERE conditionals for query
3149 &$tables: array of tables to be queried
3150 &$join_conds: join conditions for the tables
3151 $opts: FormOptions for this request
3152 &$query_options: array of options for the database request
3153 &$select: Array of columns to select
3155 'SpecialResetTokensTokens': Called when building token list for
3157 &$tokens: array of token information arrays in the format of
3159 'preference' => '<preference-name>',
3160 'label-message' => '<message-key>',
3163 'SpecialSearchCreateLink': Called when making the message to create a page or
3164 go to the existing page.
3165 $t: title object searched for
3166 &$params: an array of the default message name and page title (as parameter)
3168 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3169 canceled and a normal search will be performed. Returning true without setting
3170 $url does a standard redirect to $title. Setting $url redirects to the
3172 $term: The string the user searched for
3173 $title: The title the 'go' feature has decided to forward the user to
3174 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3176 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3177 target doesn't exist.
3178 &$title: title object generated from the text entered by the user
3180 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3181 the advanced form, a.k.a. power search box.
3182 &$showSections: an array to add values with more options to
3183 $term: the search term (not a title object)
3184 $opts: an array of hidden options (containing 'redirs' and 'profile')
3186 'SpecialSearchProfileForm': Allows modification of search profile forms.
3187 $search: special page object
3188 &$form: String: form html
3189 $profile: String: current search profile
3190 $term: String: search term
3191 $opts: Array: key => value of hidden options for inclusion in custom forms
3193 'SpecialSearchProfiles': Allows modification of search profiles.
3194 &$profiles: profiles, which can be modified.
3196 'SpecialSearchResults': Called before search result display
3197 $term: string of search term
3198 &$titleMatches: empty or SearchResultSet object
3199 &$textMatches: empty or SearchResultSet object
3201 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3202 on the search results page. Useful for including an external search
3203 provider. To disable the output of MediaWiki search output, return
3205 $specialSearch: SpecialSearch object ($this)
3207 $term: Search term specified by the user
3209 'SpecialSearchResultsAppend': Called immediately before returning HTML
3210 on the search results page. Useful for including a feedback link.
3211 $specialSearch: SpecialSearch object ($this)
3213 $term: Search term specified by the user
3215 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3216 $search: SpecialSearch special page object
3217 $profile: String: current search profile
3218 $engine: the search engine
3220 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3221 &$extraStats: Array to save the new stats
3222 $extraStats['<name of statistic>'] => <value>;
3223 <value> can be an array with the keys "name" and "number":
3224 "name" is the HTML to be displayed in the name column
3225 "number" is the number to be displayed.
3226 or, <value> can be the number to be displayed and <name> is the
3227 message key to use in the name column,
3228 $context: IContextSource object
3230 'SpecialTrackingCategories::preprocess': Called after LinkBatch on Special:TrackingCategories
3231 $specialPage: The SpecialTrackingCategories object
3232 $trackingCategories: Array of data from Special:TrackingCategories with msg and cats
3234 'SpecialTrackingCategories::generateCatLink': Called for each cat link on Special:TrackingCategories
3235 $specialPage: The SpecialTrackingCategories object
3236 $catTitle: The Title object of the linked category
3237 &$html: The Result html
3239 'SpecialUploadComplete': Called after successfully uploading a file from
3241 &$form: The SpecialUpload object
3243 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3244 $wgVersion: Current $wgVersion for you to use
3245 &$versionUrl: Raw url to link to (eg: release notes)
3247 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3249 Called after building form options at Watchlist.
3250 $special: the special page object
3251 &$filters: associative array of filter definitions. The keys are the HTML
3252 name/URL parameters. Each key maps to an associative array with a 'msg'
3253 (message key) and a 'default' value.
3255 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3256 SpecialWatchlist. Allows extensions to register custom values they have
3257 inserted to rc_type so they can be returned as part of the watchlist.
3258 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3260 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3261 Called when building sql query for SpecialWatchlist.
3262 &$conds: array of WHERE conditionals for query
3263 &$tables: array of tables to be queried
3264 &$join_conds: join conditions for the tables
3265 &$fields: array of query fields
3266 $opts: A FormOptions object with watchlist options for the current request
3268 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3269 URL for a title when we have no other parameters on the URL. Gives a chance for
3270 extensions that alter page view behavior radically to abort that redirect or
3272 $request: WebRequest
3273 $title: Title of the currently found title obj
3274 $output: OutputPage object
3276 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3277 rendered (by ThumbnailImage:toHtml method).
3278 $thumbnail: the ThumbnailImage object
3279 &$attribs: image attribute array
3280 &$linkAttribs: image link attribute array
3282 'TitleArrayFromResult': Called when creating an TitleArray object from a
3284 &$titleArray: set this to an object to override the default object returned
3285 $res: database result used to create the object
3287 'TitleExists': Called when determining whether a page exists at a given title.
3288 $title: The title being tested.
3289 &$exists: Whether the title exists.
3291 'TitleGetEditNotices': Allows extensions to add edit notices
3292 $title: The Title object for the page the edit notices are for
3293 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3294 &$notices: Array of notices. Keys are i18n message keys, values are
3295 parseAsBlock()ed messages.
3297 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3298 that can be applied.
3299 $title: The title in question.
3300 &$types: The types of protection available.
3302 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3303 overriding default behavior for determining if a page exists. If $isKnown is
3304 kept as null, regular checks happen. If it's a boolean, this value is returned
3305 by the isKnown method.
3306 $title: Title object that is being checked
3307 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3309 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3310 Called when determining if a page is a CSS or JS page.
3311 $title: Title object that is being checked
3312 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3313 Hooks may change this value to override the return value of
3314 Title::isCssOrJsPage().
3316 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3317 that this hook is not called for interwiki pages or pages in immovable
3318 namespaces: for these, isMovable() always returns false.
3319 $title: Title object that is being checked
3320 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3321 Hooks may change this value to override the return value of
3324 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3325 Called when determining if a page is a wikitext or should
3326 be handled by separate handler (via ArticleViewCustom).
3327 $title: Title object that is being checked
3328 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3329 Hooks may change this value to override the return value of
3330 Title::isWikitextPage()
3332 'TitleMove': Before moving an article (title).
3335 $user: user who does the move
3337 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3340 $user: user who does the move
3342 'TitleMoveComplete': After moving an article (title), post-commit.
3345 &$user: user who did the move
3346 $pageid: database ID of the page that's been moved
3347 $redirid: database ID of the created redirect
3348 $reason: reason for the move
3349 $revision: the Revision created by the move
3351 'TitleMoveCompleting': After moving an article (title), pre-commit.
3354 $user: user who did the move
3355 $pageid: database ID of the page that's been moved
3356 $redirid: database ID of the created redirect
3357 $reason: reason for the move
3358 $revision: the Revision created by the move
3360 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3361 or override the quick permissions check.
3362 $title: The Title object being accessed
3363 $user: The User performing the action
3364 $action: Action being performed
3365 &$errors: Array of errors
3366 $doExpensiveQueries: Whether to do expensive DB queries
3367 $short: Whether to return immediately on first error
3369 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3370 adding the default error message if nothing allows the user to read the page. If
3371 a handler wants a title to *not* be whitelisted, it should also return false.
3372 $title: Title object being checked against
3373 $user: Current user object
3374 &$whitelisted: Boolean value of whether this title is whitelisted
3376 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3377 $title: Title object to purge
3378 &$urls: An array of URLs to purge from the caches, to be manipulated.
3380 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3381 PageArchive object has been created but before any further processing is done.
3382 &$archive: PageArchive object
3383 $title: Title object of the page that we're viewing
3385 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3386 PageArchive object has been created but before any further processing is done.
3387 &$archive: PageArchive object
3388 $title: Title object of the page that we're viewing
3390 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3391 the site is not in read-only mode, that the Title object is not null and after
3392 a PageArchive object has been constructed but before performing any further
3394 &$archive: PageArchive object
3395 $title: Title object of the page that we're about to undelete
3397 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3398 $title: title object related to the revision
3399 $rev: revision (object) that will be viewed
3401 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3402 Since 1.24: Paths pointing to a directory will be recursively scanned for
3403 test case files matching the suffix "Test.php".
3404 &$paths: list of test cases and directories to search.
3406 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3408 $action: action name
3409 $article: article "acted on"
3411 'UnwatchArticle': Before a watch is removed from an article.
3412 &$user: user watching
3413 &$page: WikiPage object to be removed
3414 &$status: Status object to be returned if the hook returns false
3416 'UnwatchArticleComplete': After a watch is removed from an article.
3417 $user: user that watched
3418 &$page: WikiPage object that was watched
3420 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3421 &$formattedPageStatus: list of valid page states
3423 'UploadComplete': Upon completion of a file upload.
3424 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3425 $uploadBase->getLocalFile().
3427 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3428 $type: (string) the requested upload type
3429 &$className: the class name of the Upload instance to be created
3431 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3432 poke at member variables like $mUploadDescription before the file is saved. Do
3433 not use this hook to break upload processing. This will return the user to a
3434 blank form with no error message; use UploadVerification and UploadVerifyFile
3436 &$form: UploadForm object
3438 'UploadForm:initial': Before the upload form is generated. You might set the
3439 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3440 text (HTML) either before or after the editform.
3441 &$form: UploadForm object
3443 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3445 &$descriptor: (array) the HTMLForm descriptor
3447 'UploadFormSourceDescriptors': after the standard source inputs have been
3448 added to the descriptor
3449 &$descriptor: (array) the HTMLForm descriptor
3450 &$radio: Boolean, if source type should be shown as radio button
3451 $selectedSourceType: The selected source type
3453 'UploadStashFile': Before a file is stashed (uploaded to stash).
3454 Note that code which has not been updated for MediaWiki 1.28 may not call this
3455 hook. If your extension absolutely, positively must prevent some files from
3456 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3457 $upload: (object) An instance of UploadBase, with all info about the upload
3458 $user: (object) An instance of User, the user uploading this file
3459 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3460 &$error: output: If the file stashing should be prevented, set this to the reason
3461 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3462 instance (you might want to use ApiMessage to provide machine-readable details
3465 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3466 Additional chances to reject an uploaded file.
3467 $saveName: (string) destination file name
3468 $tempName: (string) filesystem path to the temporary file for checks
3469 &$error: (string) output: message key for message to show if upload canceled by
3470 returning false. May also be an array, where the first element is the message
3471 key and the remaining elements are used as parameters to the message.
3473 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3474 in most cases over UploadVerification.
3475 $upload: (object) an instance of UploadBase, with all info about the upload
3476 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3477 Handlers will typically only apply for specific MIME types.
3478 &$error: (object) output: true if the file is valid. Otherwise, set this to the reason
3479 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3480 instance (you might want to use ApiMessage to provide machine-readable details
3483 'UploadVerifyUpload': Upload verification, based on both file properties like
3484 MIME type (same as UploadVerifyFile) and the information entered by the user
3485 (upload comment, file page contents etc.).
3486 $upload: (object) An instance of UploadBase, with all info about the upload
3487 $user: (object) An instance of User, the user uploading this file
3488 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3489 $comment: (string) Upload log comment (also used as edit summary)
3490 $pageText: (string) File description page text (only used for new uploads)
3491 &$error: output: If the file upload should be prevented, set this to the reason
3492 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3493 instance (you might want to use ApiMessage to provide machine-readable details
3496 'UserIsBot': when determining whether a user is a bot account
3498 &$isBot: whether this is user a bot or not (boolean)
3500 'User::mailPasswordInternal': before creation and mailing of a user's new
3502 &$user: the user who sent the message out
3503 &$ip: IP of the user who sent the message out
3504 &$u: the account whose new password will be set
3506 'UserAddGroup': Called when adding a group; return false to override
3507 stock group addition.
3508 $user: the user object that is to have a group added
3509 &$group: the group to add, can be modified
3511 'UserArrayFromResult': Called when creating an UserArray object from a database
3513 &$userArray: set this to an object to override the default object returned
3514 $res: database result used to create the object
3516 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3517 want to display an error message, try getUserPermissionsErrors.
3518 &$title: Title object being checked against
3519 &$user: Current user object
3520 $action: Action being checked
3521 &$result: Pointer to result returned if hook returns false. If null is returned,
3522 userCan checks are continued by internal code.
3524 'UserCanSendEmail': To override User::canSendEmail() permission check.
3525 &$user: User (object) whose permission is being checked
3526 &$canSend: bool set on input, can override on output
3528 'UserClearNewTalkNotification': Called when clearing the "You have new
3529 messages!" message, return false to not delete it.
3530 &$user: User (object) that will clear the message
3531 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3533 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3534 Manipulate the login form.
3535 &$template: SimpleTemplate instance for the form
3537 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3538 &$user: User to get groups for
3539 &$groups: Current effective groups
3541 'UserGetAllRights': After calculating a list of all available rights.
3542 &$rights: Array of rights, which may be added to.
3544 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3545 before returning the options to the caller. Warning: This hook is called for
3546 every call to User::getDefaultOptions(), which means it's potentially called
3547 dozens or hundreds of times. You may want to cache the results of non-trivial
3548 operations in your hook function for this reason.
3549 &$defaultOptions: Array of preference keys and their default values.
3551 'UserGetEmail': Called when getting an user email address.
3553 &$email: email, change this to override local email
3555 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3556 email authentication.
3558 &$timestamp: timestamp, change this to override local email authentication
3561 'UserGetImplicitGroups': DEPRECATED!
3562 Called in User::getImplicitGroups().
3563 &$groups: List of implicit (automatically-assigned) groups
3565 'UserGetLanguageObject': Called when getting user's interface language object.
3567 &$code: Language code that will be used to create the object
3568 $context: IContextSource object
3570 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3571 &$reservedUsernames: $wgReservedUsernames
3573 'UserGetRights': Called in User::getRights().
3574 $user: User to get rights for
3575 &$rights: Current rights
3577 'UserGroupsChanged': Called after user groups are changed.
3578 $user: User whose groups changed
3579 $added: Groups added
3580 $removed: Groups removed
3581 $performer: User who performed the change, false if via autopromotion
3582 $reason: The reason, if any, given by the user performing the change,
3583 false if via autopromotion.
3585 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3586 specific block exemptions).
3587 $user: User in question
3588 $title: Title of the page in question
3589 &$blocked: Out-param, whether or not the user is blocked from that page.
3590 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3591 to edit their own user talk pages.
3593 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3595 $ip: User's IP address
3596 &$blocked: Whether the user is blocked, to be modified by the hook
3597 &$block: The Block object, to be modified by the hook
3599 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3600 false if a UserGetRights hook might remove the named right.
3601 $right: The user right being checked
3603 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3604 $user: User in question.
3605 &$hidden: Set true if the user's name should be hidden.
3607 'UserIsLocked': Check if the user is locked. See User::isLocked().
3608 $user: User in question.
3609 &$locked: Set true if the user should be locked.
3611 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3612 environmental means; occurs after session is loaded.
3613 $user: user object being loaded
3615 'UserLoadDefaults': Called when loading a default user.
3619 'UserLoadFromDatabase': Called when loading a user from the database.
3621 &$s: database query object
3623 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3624 Called to authenticate users on external/environmental means; occurs before
3626 $user: user object being loaded
3627 &$result: set this to a boolean value to abort the normal authentication
3630 'UserLoadOptions': When user options/preferences are being loaded from the
3633 &$options: Options, can be modified.
3635 'UserLoggedIn': Called after a user is logged in
3636 $user: User object for the logged-in user
3638 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3639 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3640 &$user: the user object that was created on login
3641 &$inject_html: Any HTML to inject after the "logged in" message.
3642 $direct: (bool) The hook is called directly after a successful login. This will only happen once
3643 per login. A UserLoginComplete call with direct=false can happen when the user visits the login
3644 page while already logged in.
3646 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3647 Manipulate the login form.
3648 &$template: QuickTemplate instance for the form
3650 'UserLogout': Before a user logs out.
3651 &$user: the user object that is about to be logged out
3653 'UserLogoutComplete': After a user has logged out.
3654 &$user: the user object _after_ logout (won't have name, ID, etc.)
3655 &$inject_html: Any HTML to inject after the "logged out" message.
3656 $oldName: name of the user before logout (string)
3658 'UserMailerChangeReturnPath': Called to generate a VERP return address
3659 when UserMailer sends an email, with a bounce handling extension.
3660 $to: Array of MailAddress objects for the recipients
3661 &$returnPath: The return address string
3663 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3664 to split up an email with multiple the To: field into separate emails.
3665 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3667 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3668 Extensions can block sending the email by returning false and setting $error.
3669 $to: array of MailAdresses of the targets
3670 $from: MailAddress of the sender
3671 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3672 &$error: should be set to an error message string
3674 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3675 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3676 $to: array of MailAdresses of the targets
3677 $from: MailAddress of the sender
3678 &$subject: email subject (not MIME encoded)
3679 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3680 &$body: email body (in MIME format) as a string
3681 &$error: should be set to an error message string
3683 'UserRemoveGroup': Called when removing a group; return false to override stock
3685 $user: the user object that is to have a group removed
3686 &$group: the group to be removed, can be modified
3688 'UserRequiresHTTPS': Called to determine whether a user needs
3689 to be switched to HTTPS.
3690 $user: User in question.
3691 &$https: Boolean whether $user should be switched to HTTPS.
3693 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3694 have been requested to be reset. This hook can be used to exclude certain
3695 options from being reset even when the user has requested all prefs to be reset,
3696 because certain options might be stored in the user_properties database table
3697 despite not being visible and editable via Special:Preferences.
3698 $user: the User (object) whose preferences are being reset
3699 &$newOptions: array of new (site default) preferences
3700 $options: array of the user's old preferences
3701 $resetKinds: array containing the kinds of preferences to reset
3703 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3705 &$user: user retrieving new talks messages
3706 &$talks: array of new talks page(s)
3708 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3709 After a user's group memberships are changed.
3710 &$user: User object that was changed
3711 $add: Array of strings corresponding to groups added
3712 $remove: Array of strings corresponding to groups removed
3714 'UserSaveOptions': Called just before saving user preferences/options.
3716 &$options: Options, modifiable
3718 'UserSaveSettings': Called when saving user settings.
3721 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3722 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3723 instead. Otherwise, you can no longer count on user data being saved to cookies
3724 versus some other mechanism.
3725 Called when setting user cookies.
3727 &$session: session array, will be added to the session
3728 &$cookies: cookies array mapping cookie name to its value
3730 'UserSetEmail': Called when changing user email address.
3732 &$email: new email, change this to override new email address
3734 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3735 email authentication.
3737 &$timestamp: new timestamp, change this to override local email
3738 authentication timestamp
3740 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3741 "Foobar (Talk | Contribs | Block)".
3742 $userId: User id of the current user
3743 $userText: User name of the current user
3744 &$items: Array of user tool links as HTML fragments
3746 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3747 extensions providing user group data from an alternate source a chance to add
3748 their data into the cache array so that things like global user groups are
3749 displayed correctly in Special:ListUsers.
3750 $dbr: Read-only database handle
3751 $userIds: Array of user IDs whose groups we should look up
3752 &$cache: Array of user ID -> internal user group name (e.g. 'sysop') mappings
3753 &$groups: Array of group name -> bool true mappings for members of a given user
3756 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3757 FormatMetadata::getExtendedMeta (return false means cache will be
3758 invalidated and GetExtendedMetadata hook called again).
3759 $timestamp: The timestamp metadata was generated
3760 $file: The file the metadata is for
3762 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3763 used to alter the SQL query which gets the list of wanted pages.
3764 &$wantedPages: WantedPagesPage object
3765 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3767 'WatchArticle': Before a watch is added to an article.
3768 &$user: user that will watch
3769 &$page: WikiPage object to be watched
3770 &$status: Status object to be returned if the hook returns false
3772 'WatchArticleComplete': After a watch is added to an article.
3773 &$user: user that watched
3774 &$page: WikiPage object watched
3776 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3777 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3778 $watchedItemQueryService: Service object
3780 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3781 form, used to manipulate the list of pages or preload data based on that list.
3782 &$watchlistInfo: array of watchlisted pages in
3783 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3785 'WatchlistEditorBuildRemoveLine': when building remove lines in
3786 Special:Watchlist/edit.
3787 &$tools: array of extra links
3788 $title: Title object
3789 $redirect: whether the page is a redirect
3791 &$link: HTML link to title
3793 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3795 $router: The PathRouter instance
3797 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3798 Return false to prevent setting of the cookie.
3799 &$name: Cookie name passed to WebResponse::setcookie()
3800 &$value: Cookie value passed to WebResponse::setcookie()
3801 &$expire: Cookie expiration, as for PHP's setcookie()
3802 &$options: Options passed to WebResponse::setcookie()
3804 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3805 run a MediaWiki cli script.
3806 &$script: MediaWiki cli script path
3807 &$parameters: Array of arguments and options to the script
3808 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3811 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3812 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3813 &$qp: The list of QueryPages
3815 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3816 $row: The DB row of the entry.
3817 $title: The Title of the page where the link comes FROM
3818 $target: The Title of the page where the link goes TO
3819 &$props: Array of HTML strings to display after the title.
3821 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3822 dumps. One, and only one hook should set this, and return false.
3823 &$tables: Database tables to use in the SELECT query
3824 &$opts: Options to use for the query
3825 &$join: Join conditions
3827 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3828 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3829 specific to a content model should be provided by the respective Content's
3830 getDeletionUpdates() method.
3832 $content: the Content to generate updates for (or null, if the Content could not be loaded
3834 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3836 'WikiPageFactory': Override WikiPage class used for a title
3837 $title: Title of the page
3838 &$page: Variable to set the created WikiPage to.
3840 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3841 extra metadata to be added.
3842 $obj: The XmlDumpWriter object.
3843 &$out: The output string.
3844 $row: The database row for the page.
3845 $title: The title of the page.
3847 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3849 &$obj: The XmlDumpWriter object.
3850 &$out: The text being output.
3851 $row: The database row for the revision.
3852 $text: The revision text.
3854 More hooks might be available but undocumented, you can execute
3855 "php maintenance/findHooks.php" to find hidden ones.