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 usage message to die with, as a message key or array
362 as accepted by ApiBase::dieUsageMsg.
364 'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
365 Before saving a page with api.php?action=edit, after
366 processing request parameters. Return false to let the request fail, returning
367 an error message or an <edit result="Failure"> tag if $resultArr was filled.
368 Unlike for example 'EditFilterMergedContent' this also being run on undo.
369 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
370 for the API and it's recommended to use it instead of this hook.
371 $editPage: the EditPage object
372 $text: the text passed to the API. Note that this includes only the single
373 section for section edit, and is not necessarily the final text in case of
374 automatically resolved edit conflicts.
375 &$resultArr: data in this array will be added to the API result
377 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
378 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
379 this hook may cancel the hook to signal that the item is not viewable in the
381 $row: A row of data from ContribsPager. The set of data returned by
382 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
384 $context: An IContextSource implementation.
385 &$feedItem: Set this to a FeedItem instance if the callback can handle the
386 provided row. This is provided to the hook as a null, if it is non null then
387 another callback has already handled the hook.
389 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
390 highlighting, add output to $context->getOutput() and return false.
391 $context: An IContextSource.
392 $text: Text to be highlighted.
393 $mime: MIME type of $text.
394 $format: API format code for $text.
396 'APIGetAllowedParams': Use this hook to modify a module's parameters.
397 &$module: ApiBase Module object
398 &$params: Array of parameters
399 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
401 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
402 Use this hook to modify a module's description.
403 &$module: ApiBase Module object
404 &$desc: String description, or array of description strings
406 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
407 $module: ApiBase Module object
408 &$msg: Array of Message objects
410 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
412 Use this hook to modify a module's parameter descriptions.
413 &$module: ApiBase Module object
414 &$desc: Array of parameter descriptions
416 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
418 $module: ApiBase Module object
419 &$msg: Array of arrays of Message objects
421 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
422 $module: ApiBase Module object
423 &$help: Array of HTML strings to be joined for the output.
424 $options: Array Options passed to ApiHelp::getHelp
425 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
426 the page and values as for Linker::generateTOC().
428 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
429 module manager. Can be used to conditionally register API modules.
430 $moduleManager: ApiModuleManager Module manager instance
432 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
433 an exception is thrown during API action execution.
434 $apiMain: Calling ApiMain instance.
435 $e: Exception object.
437 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
438 extensions to adjust the ParserOptions before parsing.
439 $options: ParserOptions object
440 $title: Title to be parsed
441 $params: Parameter array for the API module
442 $module: API module (which is also a ContextSource)
443 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
444 &$suppressCache: Set true if cache should be suppressed.
446 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
447 can alter or append to the array.
448 &$results: array with integer keys to associative arrays. Keys in associative
450 - title: Title object.
451 - redirect from: Title or null.
452 - extract: Description for this result.
453 - extract trimmed: If truthy, the extract will not be trimmed to
454 $wgOpenSearchDescriptionLength.
455 - image: Thumbnail for this result. Value is an array with subkeys 'source'
456 (url), 'width', 'height', 'alt', 'align'.
457 - url: Url for the given title.
459 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
460 module manager. Can be used to conditionally register API query modules.
461 $moduleManager: ApiModuleManager Module manager instance
463 'APIQueryAfterExecute': After calling the execute() method of an
464 action=query submodule. Use this to extend core API modules.
465 &$module: Module object
467 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
468 database query has returned. An API query module wanting to use this hook
469 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
471 $module: ApiQueryBase module in question
472 $result: ResultWrapper|bool returned from the IDatabase::select()
473 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
474 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
477 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
478 database query is made. WARNING: It would be very easy to misuse this hook and
479 break the module! Any joins added *must* join on a unique key of the target
480 table unless you really know what you're doing. An API query module wanting to
481 use this hook should see the ApiQueryBase::select() and
482 ApiQueryBase::processRow() documentation.
483 $module: ApiQueryBase module in question
484 &$tables: array of tables to be queried
485 &$fields: array of columns to select
486 &$conds: array of WHERE conditionals for query
487 &$query_options: array of options for the database request
488 &$join_conds: join conditions for the tables
489 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
490 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
492 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
493 the database result is processed. Return false to stop processing the result
494 set. An API query module wanting to use this hook should see the
495 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
496 $module: ApiQueryBase module in question
497 $row: stdClass Database result row
498 &$data: array to be included in the ApiResult.
499 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
500 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
502 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
503 an action=query submodule. Use this to extend core API modules.
504 &$module: Module object
505 &$resultPageSet: ApiPageSet object
507 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
508 Use this hook to add custom tokens to prop=info. Every token has an action,
509 which will be used in the intoken parameter and in the output
510 (actiontoken="..."), and a callback function which should return the token, or
511 false if the user isn't allowed to obtain it. The prototype of the callback
512 function is func($pageid, $title), where $pageid is the page ID of the page the
513 token is requested for and $title is the associated Title object. In the hook,
514 just add your callback to the $tokenFunctions array and return true (returning
515 false makes no sense).
516 &$tokenFunctions: array(action => callback)
518 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
520 Use this hook to add custom tokens to list=recentchanges. Every token has an
521 action, which will be used in the rctoken parameter and in the output
522 (actiontoken="..."), and a callback function which should return the token, or
523 false if the user isn't allowed to obtain it. The prototype of the callback
524 function is func($pageid, $title, $rc), where $pageid is the page ID of the
525 page associated to the revision the token is requested for, $title the
526 associated Title object and $rc the associated RecentChange object. In the
527 hook, just add your callback to the $tokenFunctions array and return true
528 (returning false makes no sense).
529 &$tokenFunctions: array(action => callback)
531 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
532 Use this hook to add custom tokens to prop=revisions. Every token has an
533 action, which will be used in the rvtoken parameter and in the output
534 (actiontoken="..."), and a callback function which should return the token, or
535 false if the user isn't allowed to obtain it. The prototype of the callback
536 function is func($pageid, $title, $rev), where $pageid is the page ID of the
537 page associated to the revision the token is requested for, $title the
538 associated Title object and $rev the associated Revision object. In the hook,
539 just add your callback to the $tokenFunctions array and return true (returning
540 false makes no sense).
541 &$tokenFunctions: array(action => callback)
543 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
544 sites general information.
545 $module: the current ApiQuerySiteInfo module
546 &$results: array of results, add things here
548 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
549 sites statistics information.
550 &$results: array of results, add things here
552 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
553 action=query&meta=tokens. Note that most modules will probably be able to use
554 the 'csrf' token instead of creating their own token types.
555 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
556 and key to pass to Session::getToken() )
558 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
559 Use this hook to add custom token to list=users. Every token has an action,
560 which will be used in the ustoken parameter and in the output
561 (actiontoken="..."), and a callback function which should return the token, or
562 false if the user isn't allowed to obtain it. The prototype of the callback
563 function is func($user) where $user is the User object. In the hook, just add
564 your callback to the $tokenFunctions array and return true (returning false
566 &$tokenFunctions: array(action => callback)
568 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
569 $module: ApiQueryWatchlist instance
570 $watchedItem: WatchedItem instance
571 $recentChangeInfo: Array of recent change info data
572 &$vals: Associative array of data to be output for the row
574 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
575 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
576 $module: ApiQueryWatchlist instance
577 $params: Array of parameters, as would be returned by $module->extractRequestParams()
578 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
580 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
581 should have its own entry in the $apis array and have a unique name, passed as
582 key for the array that represents the service data. In this data array, the
583 key-value-pair identified by the apiLink key is required.
584 &$apis: array of services
586 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
587 Use this hook to extend action=tokens with new token types.
588 &$tokenTypes: supported token types in format 'type' => callback function
589 used to retrieve this type of tokens.
591 'Article::MissingArticleConditions': Before fetching deletion & move log entries
592 to display a message of a non-existing page being deleted/moved, give extensions
593 a chance to hide their (unrelated) log entries.
594 &$conds: Array of query conditions (all of which have to be met; conditions will
595 AND in the final query)
596 $logTypes: Array of log types being queried
598 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
600 After fetching content of an article from the database.
601 &$article: the article (object) being loaded from the database
602 &$content: the content (string) of the article
604 'ArticleAfterFetchContentObject': After fetching content of an article from the
606 &$article: the article (object) being loaded from the database
607 &$content: the content of the article, as a Content object
609 'ArticleConfirmDelete': Before writing the confirmation form for article
611 $article: the article (object) being deleted
612 $output: the OutputPage object
613 &$reason: the reason (string) the article is being deleted
615 'ArticleContentOnDiff': Before showing the article content below a diff. Use
616 this to change the content in this area or how it is loaded.
617 $diffEngine: the DifferenceEngine
618 $output: the OutputPage object
620 'ArticleContentViewCustom': Allows to output the text of the article in a
621 different format than wikitext. Note that it is preferable to implement proper
622 handing for a custom data type using the ContentHandler facility.
623 $content: content of the page, as a Content object
624 $title: title of the page
625 $output: reference to $wgOut
627 'ArticleDelete': Before an article is deleted.
628 &$wikiPage: the WikiPage (object) being deleted
629 &$user: the user (object) deleting the article
630 &$reason: the reason (string) the article is being deleted
631 &$error: if the deletion was prohibited, the (raw HTML) error message to display
633 &$status: Status object, modify this to throw an error. Overridden by $error
635 $suppress: Whether this is a suppression deletion or not (added in 1.27)
637 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
638 $title: Title of the article that has been deleted.
639 $outputPage: OutputPage that can be used to append the output.
641 'ArticleDeleteComplete': After an article is deleted.
642 &$wikiPage: the WikiPage that was deleted
643 &$user: the user that deleted the article
644 $reason: the reason the article was deleted
645 $id: id of the article that was deleted
646 $content: the Content of the deleted page (or null, when deleting a broken page)
647 $logEntry: the ManualLogEntry used to record the deletion
648 $archivedRevisionCount: the number of revisions archived during the deletion
650 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
652 &$wikiPage: WikiPage (object) of the user talk page
653 $recipient: User (object) who's talk page was edited
655 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
656 article has been changed.
657 &$wikiPage: the WikiPage (object)
658 &$editInfo: data holder that includes the parser output ($editInfo->output) for
659 that page after the change
660 $changed: bool for if the page was changed
662 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
663 recentchanges table, return false to not delete old entries.
664 &$wikiPage: WikiPage (object) being modified
666 'ArticleFromTitle': when creating an article object from a title object using
667 Wiki::articleFromTitle().
668 &$title: Title (object) used to create the article object
669 &$article: Article (object) that will be returned
670 $context: IContextSource (object)
672 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
673 After a new article is created.
674 $wikiPage: WikiPage created
675 $user: User creating the article
677 $summary: Edit summary/comment
678 $isMinor: Whether or not the edit was marked as minor
679 $isWatch: (No longer used)
680 $section: (No longer used)
681 $flags: Flags passed to WikiPage::doEditContent()
682 $revision: New Revision of the article
684 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
685 $targetTitle: target title (object)
686 $destTitle: destination title (object)
688 'ArticlePageDataAfter': After loading data of an article from the database.
689 &$wikiPage: WikiPage (object) whose data were loaded
690 &$row: row (object) returned from the database server
692 'ArticlePageDataBefore': Before loading data of an article from the database.
693 &$wikiPage: WikiPage (object) that data will be loaded
694 &$fields: fields (array) to load from the database
696 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
697 $wikiPage: the WikiPage being saved
698 $popts: parser options to be used for pre-save transformation
700 'ArticleProtect': Before an article is protected.
701 &$wikiPage: the WikiPage being protected
702 &$user: the user doing the protection
703 $protect: Set of restriction keys
704 $reason: Reason for protect
706 'ArticleProtectComplete': After an article is protected.
707 &$wikiPage: the WikiPage that was protected
708 &$user: the user who did the protection
709 $protect: Set of restriction keys
710 $reason: Reason for protect
712 'ArticlePurge': Before executing "&action=purge".
713 &$wikiPage: WikiPage (object) to purge
715 'ArticleRevisionUndeleted': After an article revision is restored.
716 &$title: the article title
717 $revision: the revision
718 $oldPageID: the page ID of the revision when archived (may be null)
720 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
721 revisions of an article.
722 $title: Title object of the article
723 $ids: Ids to set the visibility for
724 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
725 examined to determine exactly what visibility bits have changed for each
726 revision. This array is of the form
727 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
729 'ArticleRollbackComplete': After an article rollback is completed.
730 $wikiPage: the WikiPage that was edited
731 $user: the user who did the rollback
732 $revision: the revision the page was reverted back to
733 $current: the reverted revision
735 'ArticleSave': DEPRECATED! Use PageContentSave instead.
736 Before an article is saved.
737 $wikiPage: the WikiPage (object) being saved
738 $user: the user (object) saving the article
739 $text: the new article text
740 $summary: the article summary (comment)
745 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
746 After an article has been updated.
747 $wikiPage: WikiPage modified
748 $user: User performing the modification
750 $summary: Edit summary/comment
751 $isMinor: Whether or not the edit was marked as minor
752 $isWatch: (No longer used)
753 $section: (No longer used)
754 $flags: Flags passed to WikiPage::doEditContent()
755 $revision: New Revision of the article
756 $status: Status object about to be returned by doEditContent()
757 $baseRevId: the rev ID (or false) this edit was based on
759 'ArticleUndelete': When one or more revisions of an article are restored.
760 &$title: Title corresponding to the article restored
761 $create: Whether or not the restoration caused the page to be created (i.e. it
762 didn't exist before).
763 $comment: The comment associated with the undeletion.
764 $oldPageId: ID of page previously deleted (from archive table)
766 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
767 $pageArchive: the PageArchive object
768 &$logEntry: ManualLogEntry object
769 $user: User who is performing the log action
771 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
772 the user is redirected back to the page.
773 $article: the article
774 &$sectionanchor: The section anchor link (e.g. "#overview" )
775 &$extraq: Extra query parameters which can be added via hooked functions
777 'ArticleViewCustom': DEPRECATED! Use ArticleContentViewCustom instead.
778 Allows to output the text of the article in a different format than wikitext.
779 Note that it is preferable to implement proper handing for a custom data type
780 using the ContentHandler facility.
781 $text: text of the page
782 $title: title of the page
783 $output: reference to $wgOut
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 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1198 which is shown both on the diff header as well as on the bottom of a page, usually
1199 wrapped in a span element which has class="patrollink".
1200 $differenceEngine: DifferenceEngine object
1201 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1202 $rcid: Recent change ID (rc_id) for this change (int)
1203 $token: Patrol token; $rcid is used in generating this variable
1205 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1206 For example the rcid might be set to zero due to the user being the same as the
1207 performer of the change but an extension might still want to show it under certain
1209 &$rcid: rc_id (int) of the change or 0
1210 $differenceEngine: DifferenceEngine object
1211 $change: RecentChange object
1212 $user: User object representing the current user
1214 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1215 contains information about the new revision, such as the revision's author, whether
1216 the revision was marked as a minor edit or not, etc.
1217 $differenceEngine: DifferenceEngine object
1218 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1219 include things like revision author info, revision comment, RevisionDelete link and more
1220 $formattedRevisionTools: Array containing revision tools, some of which may have
1221 been injected with the DiffRevisionTools hook
1222 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1223 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1224 $newminor: String indicating if the new revision was marked as a minor edit
1225 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1226 whether we should show just the diff; passed in as a query string parameter to the
1227 various URLs constructed here (i.e. $nextlink)
1228 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1229 to use the RevisionDelete feature
1230 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1232 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1233 contains information about the old revision, such as the revision's author, whether
1234 the revision was marked as a minor edit or not, etc.
1235 $differenceEngine: DifferenceEngine object
1236 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1237 include things like revision author info, revision comment, RevisionDelete link and more
1238 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1239 $oldminor: String indicating if the old revision was marked as a minor edit
1240 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1241 whether we should show just the diff; passed in as a query string parameter to the
1242 various URLs constructed here (i.e. $prevlink)
1243 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1244 to use the RevisionDelete feature
1245 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1247 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1248 there is no old revision
1249 &$oldHeader: empty string by default
1251 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1252 Return false to not add parser output via OutputPage's addParserOutput method.
1253 $differenceEngine: DifferenceEngine object
1254 $out: OutputPage object
1255 $parserOutput: ParserOutput object
1256 $wikiPage: WikiPage object
1258 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1259 point and return false to not show the final "mark as patrolled" link on the bottom
1261 This hook has no arguments.
1263 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1264 eventually gets sent to the OutputPage object.
1265 $differenceEngine: DifferenceEngine object
1267 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1268 body (without header) in cases when there is no old revision or the old and new
1269 revisions are identical.
1270 $differenceEngine: DifferenceEngine object
1272 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1273 object into the diff view
1274 $out: OutputPage object
1276 'DiffRevisionTools': Override or extend the revision tools available from the
1277 diff view, i.e. undo, etc.
1278 $newRev: Revision object of the "new" revision
1279 &$links: Array of HTML links
1280 $oldRev: Revision object of the "old" revision (may be null)
1281 $user: Current user object
1283 'DiffViewHeader': Called before diff display
1284 $diff: DifferenceEngine object that's calling
1285 $oldRev: Revision object of the "old" revision (may be null/invalid)
1286 $newRev: Revision object of the "new" revision
1288 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1290 &$article: article (object) being viewed
1291 &$oldid: oldid (int) being viewed
1293 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1294 Override the HTML generated for section edit links
1295 $skin: Skin object rendering the UI
1296 $title: Title object for the title being linked to (may not be the same as
1297 the page title, if the section is included from a template)
1298 $section: The designation of the section being pointed to, to be included in
1299 the link, like "§ion=$section"
1300 $tooltip: The default tooltip. Escape before using.
1301 By default, this is wrapped in the 'editsectionhint' message.
1302 &$result: The HTML to return, prefilled with the default plus whatever other
1303 changes earlier hooks have made
1304 $lang: The language code to use for the link in the wfMessage function
1306 'EditFilter': Perform checks on an edit
1307 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1308 $text: Contents of the edit box
1309 $section: Section being edited
1310 &$error: Error message to return
1311 $summary: Edit summary for page
1313 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1314 Post-section-merge edit filter.
1315 $editor: EditPage instance (object)
1316 $text: content of the edit box
1317 &$error: error message to return
1318 $summary: Edit summary for page
1320 'EditFilterMergedContent': Post-section-merge edit filter.
1321 This may be triggered by the EditPage or any other facility that modifies page
1322 content. Use the $status object to indicate whether the edit should be allowed,
1323 and to provide a reason for disallowing it. Return false to abort the edit, and
1324 true to continue. Returning true if $status->isOK() returns false means "don't
1325 save but continue user interaction", e.g. show the edit form.
1326 $status->apiHookResult can be set to an array to be returned by api.php
1327 action=edit. This is used to deliver captchas.
1328 $context: object implementing the IContextSource interface.
1329 $content: content of the edit box, as a Content object.
1330 $status: Status object to represent errors, etc.
1331 $summary: Edit summary for page
1332 $user: the User object representing the user whois performing the edit.
1333 $minoredit: whether the edit was marked as minor by the user.
1335 'EditFormInitialText': Allows modifying the edit form when editing existing
1337 $editPage: EditPage object
1339 'EditFormPreloadText': Allows population of the edit form when creating
1341 &$text: Text to preload with
1342 &$title: Title object representing the page being created
1344 'EditPage::attemptSave': Called before an article is
1345 saved, that is before WikiPage::doEditContent() is called
1346 $editpage_Obj: the current EditPage object
1348 'EditPage::attemptSave:after': Called after an article save attempt
1349 $editpage_Obj: the current EditPage object
1350 $status: the resulting Status object
1351 $resultDetails: Result details array
1353 'EditPage::importFormData': allow extensions to read additional data
1355 $editpage: EditPage instance
1356 $request: Webrequest
1357 return value is ignored (should always return true)
1359 'EditPage::showEditForm:fields': allows injection of form field into edit form
1360 Return value is ignored (should always return true)
1361 &$editor: the EditPage instance for reference
1362 &$out: an OutputPage instance to write to
1364 'EditPage::showEditForm:initial': before showing the edit form
1365 Return false to halt editing; you'll need to handle error messages, etc.
1366 yourself. Alternatively, modifying $error and returning true will cause the
1367 contents of $error to be echoed at the top of the edit form as wikitext.
1368 Return true without altering $error to allow the edit to proceed.
1369 &$editor: EditPage instance (object)
1370 &$out: an OutputPage instance to write to
1372 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1373 but for the read-only 'view source' variant of the edit form.
1374 Return value is ignored (should always return true)
1375 $editor: EditPage instance (object)
1376 &$out: an OutputPage instance to write to
1378 'EditPage::showStandardInputs:options': allows injection of form fields into
1379 the editOptions area
1380 Return value is ignored (should always be true)
1381 $editor: EditPage instance (object)
1382 $out: an OutputPage instance to write to
1383 &$tabindex: HTML tabindex of the last edit check/button
1385 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1386 when there's an edit conflict. Return false to halt normal diff output; in
1387 this case you're responsible for computing and outputting the entire "conflict"
1388 part, i.e., the "difference between revisions" and "your text" headers and
1390 &$editor: EditPage instance
1391 &$out: OutputPage instance
1393 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1394 textarea in the edit form.
1395 &$editpage: The current EditPage object
1396 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1397 &$tabindex: HTML tabindex of the last edit check/button
1399 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1401 &$editpage: The current EditPage object
1402 &$checks: Array of edit checks like "watch this page"/"minor edit"
1403 &$tabindex: HTML tabindex of the last edit check/button
1405 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1406 textarea in the edit form.
1407 &$toolbar: The toolbar HTMl
1409 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1410 contribution/copyright notice.
1411 $title: title of page being edited
1412 &$msg: localization message name, overridable. Default is either
1413 'copyrightwarning' or 'copyrightwarning2'.
1415 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1416 "Show changes". Note that it is preferable to implement diff handling for
1417 different data types using the ContentHandler facility.
1418 $editPage: EditPage object
1419 &$newtext: wikitext that will be used as "your version"
1421 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1422 Allow modifying the wikitext that will be used in "Show changes". Note that it
1423 is preferable to implement diff handling for different data types using the
1424 ContentHandler facility.
1425 $editPage: EditPage object
1426 &$newtext: wikitext that will be used as "your version"
1428 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1429 previewed. Note that it is preferable to implement previews for different data
1430 types using the ContentHandler facility.
1431 $editPage: EditPage object
1432 &$content: Content object to be previewed (may be replaced by hook function)
1434 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1435 Allow modifying the wikitext that will be previewed. Note that it is preferable
1436 to implement previews for different data types using the ContentHandler
1438 $editPage: EditPage object
1439 &$toparse: wikitext that will be parsed
1441 'EditPageNoSuchSection': When a section edit request is given for an
1442 non-existent section
1443 &$editpage: The current EditPage object
1444 &$res: the HTML of the error text
1446 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1447 of terms of service summary link that might exist separately from the copyright
1449 $title: title of page being edited
1450 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1452 'EmailConfirmed': When checking that the user's email address is "confirmed".
1453 This runs before the other checks, such as anonymity and the real check; return
1454 true to allow those checks to occur, and false if checking is done.
1455 &$user: User being checked
1456 &$confirmed: Whether or not the email address is confirmed
1458 'EmailUser': Before sending email from one user to another.
1459 &$to: MailAddress object of receiving user
1460 &$from: MailAddress object of sending user
1461 &$subject: subject of the mail
1462 &$text: text of the mail
1463 &$error: Out-param for an error
1465 'EmailUserCC': Before sending the copy of the email to the author.
1466 &$to: MailAddress object of receiving user
1467 &$from: MailAddress object of sending user
1468 &$subject: subject of the mail
1469 &$text: text of the mail
1471 'EmailUserComplete': After sending email from one user to another.
1472 $to: MailAddress object of receiving user
1473 $from: MailAddress object of sending user
1474 $subject: subject of the mail
1475 $text: text of the mail
1477 'EmailUserForm': After building the email user form object.
1478 &$form: HTMLForm object
1480 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1482 $user: The user who is trying to email another user.
1483 $editToken: The user's edit token.
1484 &$hookErr: Out-param for the error. Passed as the parameters to
1485 OutputPage::showErrorPage.
1487 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1488 group of changes in EnhancedChangesList.
1489 Hook subscribers can return false to omit this line from recentchanges.
1490 $changesList: EnhancedChangesList object
1491 &$links: The links that were generated by EnhancedChangesList
1492 $block: The RecentChanges objects in that block
1494 'EnhancedChangesListModifyLineData': to alter data used to build
1495 a grouped recent change inner line in EnhancedChangesList.
1496 Hook subscribers can return false to omit this line from recentchanges.
1497 $changesList: EnhancedChangesList object
1498 &$data: An array with all the components that will be joined in order to create the line
1499 $block: An array of RecentChange objects in that block
1500 $rc: The RecentChange object for this line
1501 &$classes: An array of classes to change
1503 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1504 a non-grouped recent change line in EnhancedChangesList.
1505 $changesList: EnhancedChangesList object
1506 &$data: An array with all the components that will be joined in order to create the line
1507 $rc: The RecentChange object for this line
1509 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1511 $ip: The ip address of the user
1513 'ExtensionTypes': Called when generating the extensions credits, use this to
1514 change the tables headers.
1515 &$extTypes: associative array of extensions types
1517 'ExtractThumbParameters': DEPRECATED! Media handler should override
1518 MediaHandler::parseParamString instead.
1519 Called when extracting thumbnail parameters from a thumbnail file name.
1520 $thumbname: the base name of the thumbnail file
1521 &$params: the currently extracted params (has source name, temp or archived
1524 'FetchChangesList': When fetching the ChangesList derivative for a particular
1526 $user: User the list is being fetched for
1527 &$skin: Skin object to be used with the list
1528 &$list: List object (defaults to NULL, change it to an object instance and
1529 return false override the list derivative used)
1531 'FileDeleteComplete': When a file is deleted.
1532 &$file: reference to the deleted file
1533 &$oldimage: in case of the deletion of an old image, the name of the old file
1534 &$article: in case all revisions of the file are deleted a reference to the
1535 WikiFilePage associated with the file.
1536 &$user: user who performed the deletion
1539 'FileTransformed': When a file is transformed and moved into storage.
1540 $file: reference to the File object
1541 $thumb: the MediaTransformOutput object
1542 $tmpThumbPath: The temporary file system path of the transformed file
1543 $thumbPath: The permanent storage path of the transformed file
1545 'FileUndeleteComplete': When a file is undeleted
1546 $title: title object to the file
1547 $fileVersions: array of undeleted versions. Empty if all versions were restored
1548 $user: user who performed the undeletion
1551 'FileUpload': When a file upload occurs.
1552 $file: Image object representing the file that was uploaded
1553 $reupload: Boolean indicating if there was a previously another image there or
1555 $hasDescription: Boolean indicating that there was already a description page
1556 and a new one from the comment wasn't created (since 1.17)
1558 'FormatAutocomments': When an autocomment is formatted by the Linker.
1559 &$comment: Reference to the accumulated comment. Initially null, when set the
1560 default code will be skipped.
1561 $pre: Boolean, true if there is text before this autocomment
1562 $auto: The extracted part of the parsed comment before the call to the hook.
1563 $post: Boolean, true if there is text after this autocomment
1564 $title: An optional title object used to links to sections. Can be null.
1565 $local: Boolean indicating whether section links should refer to local page.
1566 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1567 autocomment originated; null for the local wiki. Added in 1.26, should default
1568 to null in handler functions, for backwards compatibility.
1570 'GalleryGetModes': Get list of classes that can render different modes of a
1572 &$modeArray: An associative array mapping mode names to classes that implement
1573 that mode. It is expected all registered classes are a subclass of
1576 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1578 $user: user to promote.
1579 &$promote: groups that will be added.
1581 'GetBlockedStatus': after loading blocking status of an user from the database
1582 &$user: user (object) being checked
1584 'GetCacheVaryCookies': Get cookies that should vary cache options.
1585 $out: OutputPage object
1586 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1587 that have to vary cache options
1589 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1591 &$title: Title object of page
1592 &$url: string value as output (out parameter, can modify)
1593 $query: query options passed to Title::getCanonicalURL()
1595 'GetDefaultSortkey': Override the default sortkey for a page.
1596 $title: Title object that we need to get a sortkey for
1597 &$sortkey: Sortkey to use.
1599 'GetDifferenceEngine': Called when getting a new difference engine interface
1600 object Return false for valid object in $differenceEngine or true for the
1601 default difference engine.
1602 $context: IContextSource context to be used for diff
1603 $old: Revision ID to show and diff with
1604 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1605 $refreshCache: If set, refreshes the diff cache
1606 $unhide: If set, allow viewing deleted revs
1607 &$differenceEngine: output parameter, difference engine object to be used for
1610 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1611 underscore) magic words. Called by MagicWord.
1612 &$doubleUnderscoreIDs: array of strings
1614 'GetExtendedMetadata': Get extended file metadata for the API
1615 &$combinedMeta: Array of the form:
1616 'MetadataPropName' => array(
1617 value' => prop value,
1618 'source' => 'name of hook'
1620 $file: File object of file in question
1621 $context: RequestContext (including language to use)
1622 $single: Only extract the current language; if false, the prop value should
1623 be in the metadata multi-language array format:
1624 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1625 &$maxCacheTime: how long the results can be cached
1627 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1628 &$title: Title object of page
1629 &$url: string value as output (out parameter, can modify)
1630 $query: query options passed to Title::getFullURL()
1632 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1633 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1635 &$output: string for the output timestamp
1636 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1637 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1638 $user: User whose preferences are being used to make timestamp
1639 $lang: Language that will be used to render the timestamp
1641 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1642 &$title: Title object of page
1643 &$url: string value as output (out parameter, can modify)
1644 $query: query options passed to Title::getInternalURL()
1646 'GetIP': modify the ip of the current user (called only once).
1647 &$ip: string holding the ip as determined so far
1649 'GetLinkColours': modify the CSS class of an array of page links.
1650 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1652 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1654 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1655 working with internal urls (non-interwiki) then it may be preferable to work
1656 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1657 be buggy for internal urls on render if you do not re-implement the horrible
1658 hack that Title::getLocalURL uses in your own extension.
1659 &$title: Title object of page
1660 &$url: string value as output (out parameter, can modify)
1661 $query: query options passed to Title::getLocalURL()
1663 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1664 without any fancy queries or variants.
1665 &$title: Title object of page
1666 &$url: string value as output (out parameter, can modify)
1668 'GetLocalURL::Internal': Modify local URLs to internal pages.
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 'GetLogTypesOnUser': Add log types where the target is a userpage
1674 &$types: Array of log types
1676 'GetMetadataVersion': Modify the image metadata version currently in use. This
1677 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1678 that need to have versioned metadata should add an element to the end of the
1679 version array of the form 'handler_name=version'. Most media handlers won't need
1680 to do this unless they broke backwards compatibility with a previous version of
1681 the media handler metadata output.
1682 &$version: Array of version strings
1684 'GetNewMessagesAlert': Disable or modify the new messages alert
1685 &$newMessagesAlert: An empty string by default. If the user has new talk page
1686 messages, this should be populated with an alert message to that effect
1687 $newtalks: An empty array if the user has no new messages or an array
1688 containing links and revisions if there are new messages (See
1689 User::getNewMessageLinks)
1690 $user: The user object of the user who is loading the page
1691 $out: OutputPage object (to check what type of page the user is on)
1693 'GetPreferences': Modify user preferences.
1694 $user: User whose preferences are being modified.
1695 &$preferences: Preferences description array, to be fed to an HTMLForm object
1697 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1698 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1700 &$output: string for the output timestamp
1701 &$diff: DateInterval representing the difference between the timestamps
1702 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1703 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1704 $user: User whose preferences are being used to make timestamp
1705 $lang: Language that will be used to render the timestamp
1707 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1708 checked for. Use instead of userCan for most cases. Return false if the user
1709 can't do it, and populate $result with the reason in the form of
1710 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1711 might want to use ApiMessage to provide machine-readable details for the API).
1712 For consistency, error messages
1713 should be plain text with no special coloring, bolding, etc. to show that
1714 they're errors; presenting them properly to the user as errors is done by the
1716 &$title: Title object being checked against
1717 &$user: Current user object
1718 $action: Action being checked
1719 &$result: User permissions error to add. If none, return true.
1721 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1722 called only if expensive checks are enabled. Add a permissions error when
1723 permissions errors are checked for. Return false if the user can't do it, and
1724 populate $result with the reason in the form of array( messagename, param1,
1725 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1726 to provide machine-readable details for the API). For consistency, error
1727 messages should be plain text with no
1728 special coloring, bolding, etc. to show that they're errors; presenting them
1729 properly to the user as errors is done by the caller.
1730 &$title: Title object being checked against
1731 &$user: Current user object
1732 $action: Action being checked
1733 &$result: User permissions error to add. If none, return true.
1735 'GitViewers': Called when generating the list of git viewers for
1736 Special:Version, use this to change the list.
1737 &$extTypes: associative array of repo URLS to viewer URLs.
1739 'HistoryRevisionTools': Override or extend the revision tools available from the
1740 page history view, i.e. undo, rollback, etc.
1741 $rev: Revision object
1742 &$links: Array of HTML links
1743 $prevRev: Revision object, next in line in page history, or null
1744 $user: Current user object
1746 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1748 $context: An IContextSource object with information about the request being
1751 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1752 image insertion. You can skip the default logic entirely by returning false, or
1753 just modify a few things using call-by-reference.
1755 &$title: Title object of the image
1756 &$file: File object, or false if it doesn't exist
1757 &$frameParams: Various parameters with special meanings; see documentation in
1758 includes/Linker.php for Linker::makeImageLink
1759 &$handlerParams: Various parameters with special meanings; see documentation in
1760 includes/Linker.php for Linker::makeImageLink
1761 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1762 &$res: Final HTML output, used if you return false
1764 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1765 the image on an image page.
1766 &$imagePage: ImagePage object ($this)
1769 'ImagePageAfterImageLinks': Called after the image links section on an image
1771 $imagePage: ImagePage object ($this)
1772 &$html: HTML for the hook to add
1774 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1775 $imagePage: ImagePage object ($this)
1777 &$line: the HTML of the history line
1778 &$css: the line CSS class
1780 'ImagePageFindFile': Called when fetching the file associated with an image
1782 $page: ImagePage object
1784 &$displayFile: displayed File object
1786 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1787 $page: ImagePage object
1788 &$toc: Array of <li> strings
1790 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1792 &$title: the Title object of the file as it would appear for the upload page
1793 &$path: the original file and path name when img_auth was invoked by the web
1795 &$name: the name only component of the file
1796 &$result: The location to pass back results of the hook routine (only used if
1798 $result[0]=The index of the header message
1799 $result[1]=The index of the body text message
1800 $result[2 through n]=Parameters passed to body text message. Please note the
1801 header message cannot receive/use parameters.
1803 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1804 Return false to stop further processing of the tag
1805 $reader: XMLReader object
1806 $logInfo: Array of information
1808 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1809 Return false to stop further processing of the tag
1810 $reader: XMLReader object
1811 &$pageInfo: Array of information
1813 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1814 Return false to stop further processing of the tag
1815 $reader: XMLReader object
1816 $pageInfo: Array of page information
1817 $revisionInfo: Array of revision information
1819 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1820 Return false to stop further processing of the tag
1821 $reader: XMLReader object
1823 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1824 Return false to stop further processing of the tag
1825 $reader: XMLReader object
1826 $revisionInfo: Array of information
1828 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1829 and edit summaries for transwiki imports.
1830 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1831 &$pageTitle: String that contains page title.
1833 'ImportSources': Called when reading from the $wgImportSources configuration
1834 variable. Can be used to lazy-load the import sources list.
1835 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1836 comment in DefaultSettings.php for the detail of how to structure this array.
1838 'InfoAction': When building information to display on the action=info page.
1839 $context: IContextSource object
1840 &$pageInfo: Array of information
1842 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1843 &$title: Title object for the current page
1844 &$request: WebRequest
1845 &$ignoreRedirect: boolean to skip redirect check
1846 &$target: Title/string of redirect target
1847 &$article: Article object
1849 'InternalParseBeforeLinks': during Parser's internalParse method before links
1850 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1851 &$parser: Parser object
1852 &$text: string containing partially parsed text
1853 &$stripState: Parser's internal StripState object
1855 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1856 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1857 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1858 template/parser function execution which respect nowiki and HTML-comments.
1859 &$parser: Parser object
1860 &$text: string containing partially parsed text
1861 &$stripState: Parser's internal StripState object
1863 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1864 Return true without providing an interwiki to continue interwiki search.
1865 $prefix: interwiki prefix we are looking for.
1866 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1867 iw_trans and optionally iw_api and iw_wikiid.
1869 'InvalidateEmailComplete': Called after a user's email has been invalidated
1871 $user: user (object) whose email is being invalidated
1873 'IRCLineURL': When constructing the URL to use in an IRC notification.
1874 Callee may modify $url and $query, URL will be constructed as $url . $query
1875 &$url: URL to index.php
1876 &$query: Query string
1877 $rc: RecentChange object that triggered url generation
1879 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1880 &$article: article (object) being checked
1882 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1883 &$ip: IP being check
1884 &$result: Change this value to override the result of IP::isTrustedProxy()
1886 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1887 $url: URL used to upload from
1888 &$allowed: Boolean indicating if uploading is allowed for given URL
1890 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1891 instance to return false if the domain name doesn't match your organization.
1892 $addr: The e-mail address entered by the user
1893 &$result: Set this and return false to override the internal checks
1895 'isValidPassword': Override the result of User::isValidPassword()
1896 $password: The password entered by the user
1897 &$result: Set this and return false to override the internal checks
1898 $user: User the password is being validated for
1900 'Language::getMessagesFileName':
1901 $code: The language code or the language we're looking for a messages file for
1902 &$file: The messages file path, you can override this to change the location.
1904 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1905 $wgExtensionMessagesFiles instead.
1906 Use this to define synonyms of magic words depending of the language
1907 &$magicExtensions: associative array of magic words synonyms
1908 $lang: language code (string)
1910 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1911 remove namespaces. Do not use this hook to add namespaces. Use
1912 CanonicalNamespaces for that.
1913 &$namespaces: Array of namespaces indexed by their numbers
1915 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1916 listed in $wgExtensionMessagesFiles instead.
1917 Use to define aliases of special pages names depending of the language
1918 &$specialPageAliases: associative array of magic words synonyms
1919 $lang: language code (string)
1921 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1922 &$names: array of language code => language name
1923 $code: language of the preferred translations
1925 'LanguageLinks': Manipulate a page's language links. This is called
1926 in various places to allow extensions to define the effective language
1928 $title: The page's Title.
1929 &$links: Associative array mapping language codes to prefixed links of the
1930 form "language:title".
1931 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1932 Currently unused, but planned to provide support for marking individual
1933 language links in the UI, e.g. for featured articles.
1935 'LanguageSelector': Hook to change the language selector available on a page.
1936 $out: The output page.
1937 $cssClassName: CSS class name of the language selector.
1939 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1940 Used when generating internal and interwiki links in
1941 Linker::link(), before processing starts. Return false to skip default
1942 processing and return $ret. See documentation for Linker::link() for details on
1943 the expected meanings of parameters.
1944 $skin: the Skin object
1945 $target: the Title that the link is pointing to
1946 &$html: the contents that the <a> tag should have (raw HTML); null means
1948 &$customAttribs: the HTML attributes that the <a> tag should have, in
1949 associative array form, with keys and values unescaped. Should be merged
1950 with default values, with a value of false meaning to suppress the
1952 &$query: the query string to add to the generated URL (the bit after the "?"),
1953 in associative array form, with keys and values unescaped.
1954 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1955 &$ret: the value to return if your hook returns false.
1957 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1958 Used when generating internal and interwiki links in Linker::link(),
1959 just before the function returns a value. If you return true, an <a> element
1960 with HTML attributes $attribs and contents $html will be returned. If you
1961 return false, $ret will be returned.
1962 $skin: the Skin object
1963 $target: the Title object that the link is pointing to
1964 $options: the options. Will always include either 'known' or 'broken', and may
1965 include 'noclasses'.
1966 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1967 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1968 associative array form.
1969 &$ret: the value to return if your hook returns false.
1971 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1973 &$url: the image url
1974 &$alt: the image's alt text
1975 &$img: the new image HTML (if returning false)
1977 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1980 &$text: the link text
1981 &$link: the new link HTML (if returning false)
1982 &$attribs: the attributes to be applied.
1983 $linkType: The external link type
1985 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1987 $title: the Title object that the link is pointing to
1988 $file: the File object or false if broken link
1989 &$html: the link text
1990 &$attribs: the attributes to be applied
1991 &$ret: the value to return if your hook returns false
1993 'HtmlPageLinkRendererBegin':
1994 Used when generating internal and interwiki links in
1995 LinkRenderer, before processing starts. Return false to skip default
1996 processing and return $ret.
1997 $linkRenderer: the LinkRenderer object
1998 $target: the LinkTarget that the link is pointing to
1999 &$text: the contents that the <a> tag should have; either a plain, unescaped
2000 string or a HtmlArmor object; null means "default".
2001 &$customAttribs: the HTML attributes that the <a> tag should have, in
2002 associative array form, with keys and values unescaped. Should be merged
2003 with default values, with a value of false meaning to suppress the
2005 &$query: the query string to add to the generated URL (the bit after the "?"),
2006 in associative array form, with keys and values unescaped.
2007 &$ret: the value to return if your hook returns false.
2009 'HtmlPageLinkRendererEnd':
2010 Used when generating internal and interwiki links in LinkRenderer,
2011 just before the function returns a value. If you return true, an <a> element
2012 with HTML attributes $attribs and contents $html will be returned. If you
2013 return false, $ret will be returned.
2014 $linkRenderer: the LinkRenderer object
2015 $target: the LinkTarget object that the link is pointing to
2016 $isKnown: boolean indicating whether the page is known or not
2017 &$text: the contents that the <a> tag should have; either a plain, unescaped
2018 string or a HtmlArmor object.
2019 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2020 associative array form.
2021 &$ret: the value to return if your hook returns false.
2023 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2025 &$linksUpdate: the LinksUpdate object
2027 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2028 each link table insert. For example, pagelinks, imagelinks, externallinks.
2029 $linksUpdate: LinksUpdate object
2030 $table: the table to insert links to
2031 $insertions: an array of links to insert
2033 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2034 including delete and insert, has completed for all link tables
2035 &$linksUpdate: the LinksUpdate object
2036 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2038 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2039 &$linksUpdate: the LinksUpdate object
2041 'ListDefinedTags': When trying to find all defined tags.
2042 &$tags: The list of tags.
2044 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2045 $updater: A DatabaseUpdater subclass
2047 'LocalFile::getHistory': Called before file history query performed.
2048 &$file: the File object
2050 &$fields: select fields
2052 &$opts: query options
2053 &$join_conds: JOIN conditions
2055 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2056 $file: the File object
2057 $archiveName: name of an old file version or false if it's the current one
2059 'LocalisationCacheRecache': Called when loading the localisation data into
2061 $cache: The LocalisationCache object
2062 $code: language code
2063 &$alldata: The localisation data from core and extensions
2064 &$purgeBlobs: whether to purge/update the message blobs via
2065 MessageBlobStore::clear()
2067 'LocalisationCacheRecacheFallback': Called for each language when merging
2068 fallback data into the cache.
2069 $cache: The LocalisationCache object
2070 $code: language code
2071 &$alldata: The localisation data from core and extensions. Note some keys may
2072 be omitted if they won't be merged into the final result.
2074 'LocalisationChecksBlacklist': When fetching the blacklist of
2075 localisation checks.
2076 &$blacklist: array of checks to blacklist. See the bottom of
2077 maintenance/language/checkLanguage.inc for the format of this variable.
2079 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2080 optional localisation messages
2081 &$ignored: Array of ignored message keys
2082 &$optional: Array of optional message keys
2084 'LocalUserCreated': Called when a local user has been created
2085 $user: User object for the created user
2086 $autocreated: Boolean, whether this was an auto-creation
2088 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2089 Special:Log for a specific log type
2090 $type: String of log type being displayed
2091 $logEventsList: LogEventsList object for context and access to the WebRequest
2092 &$input: string HTML of an input element
2094 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2095 Returning false will prevent the string from being added to the OutputPage.
2096 &$s: html string to show for the log extract
2097 $types: String or Array Log types to show
2098 $page: String or Title The page title to show log entries for
2099 $user: String The user who made the log entries
2100 $param: Associative Array with the following additional options:
2101 - lim Integer Limit of items to show, default is 50
2102 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2103 - showIfEmpty boolean Set to false if you don't want any output in case the
2104 loglist is empty if set to true (default), "No matching items in log" is
2105 displayed if loglist is empty
2106 - msgKey Array If you want a nice box with a message, set this to the key of
2107 the message. First element is the message key, additional optional elements
2108 are parameters for the key that are processed with
2109 wfMessage()->params()->parseAsBlock()
2110 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2112 - wrap String Wrap the message in html (usually something like
2113 "<div ...>$1</div>").
2114 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2116 'LogException': Called before an exception (or PHP error) is logged. This is
2117 meant for integration with external error aggregation services; returning false
2118 will NOT prevent logging.
2119 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2120 $suppressed: true if the error was suppressed via
2121 error_reporting()/wfSuppressWarnings()
2123 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2124 error messages. Allows to add additional error messages (except messages already
2125 in LoginForm::$validErrorMessages).
2126 &$messages: Already added messages (inclusive messages from
2127 LoginForm::$validErrorMessages)
2129 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2130 Called during login to allow extensions the opportunity to inform a user that
2131 their username doesn't exist for a specific reason, instead of letting the
2132 login form give the generic error message that the account does not exist. For
2133 example, when the account has been renamed or deleted.
2134 $user: the User object being authenticated against.
2135 &$msg: the message identifier for abort reason, or an array to pass a message
2138 'LogLine': Processes a single log entry on Special:Log.
2139 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2140 logging.log_type database field.
2141 $log_action: string for the type of log action (e.g. 'delete', 'block',
2142 'create2'). Corresponds to logging.log_action database field.
2143 $title: Title object that corresponds to logging.log_namespace and
2144 logging.log_title database fields.
2145 $paramArray: Array of parameters that corresponds to logging.log_params field.
2146 Note that only $paramArray[0] appears to contain anything.
2147 &$comment: string that corresponds to logging.log_comment database field, and
2148 which is displayed in the UI.
2149 &$revert: string that is displayed in the UI, similar to $comment.
2150 $time: timestamp of the log entry (added in 1.12)
2152 'LonelyPagesQuery': Allow extensions to modify the query used by
2153 Special:LonelyPages.
2154 &$tables: tables to join in the query
2155 &$conds: conditions for the query
2156 &$joinConds: join conditions for the query
2158 'MagicWordwgVariableIDs': When defining new magic words IDs.
2159 &$variableIDs: array of strings
2161 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2163 $refreshLinks: RefreshLinks object
2165 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2166 Ideally, this hook should only be used to add variables that depend on
2167 the current page/request; static configuration should be added through
2168 ResourceLoaderGetConfigVars instead.
2169 &$vars: variable (or multiple variables) to be added into the output of
2170 Skin::makeVariablesScript
2171 $out: The OutputPage which called the hook, can be used to get the real title.
2173 'MarkPatrolled': Before an edit is marked patrolled.
2174 $rcid: ID of the revision to be marked patrolled
2175 &$user: the user (object) marking the revision as patrolled
2176 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2177 sysop in order to mark an edit patrolled.
2178 $auto: true if the edit is being marked as patrolled automatically
2180 'MarkPatrolledComplete': After an edit is marked patrolled.
2181 $rcid: ID of the revision marked as patrolled
2182 &$user: user (object) who marked the edit patrolled
2183 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2184 sysop to patrol the edit.
2185 $auto: true if the edit is being marked as patrolled automatically
2187 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2188 something completely different, after the basic globals have been set up, but
2189 before ordinary actions take place.
2191 $article: Article on which the action will be performed
2192 $title: Title on which the action will be performed
2194 $request: $wgRequest
2195 $mediaWiki: The $mediawiki object
2197 'MediaWikiServices': Called when a global MediaWikiServices instance is
2198 initialized. Extensions may use this to define, replace, or wrap services.
2199 However, the preferred way to define a new service is
2200 the $wgServiceWiringFiles array.
2201 $services: MediaWikiServices
2203 'MessageCache::get': When fetching a message. Can be used to override the key
2204 for customisations. Given and returned message key must be in special format:
2205 1) first letter must be in lower case according to the content language.
2206 2) spaces must be replaced with underscores
2207 &$key: message key (string)
2209 'MessageCacheReplace': When a message page is changed. Useful for updating
2211 $title: name of the page changed.
2212 $text: new contents of the page.
2214 'MessagesPreLoad': When loading a message from the database.
2215 $title: title of the message (string)
2216 &$message: value (string), change it to the message you want to define
2218 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2219 $mimeMagic: Instance of MimeMagic.
2220 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2221 &$tail: More or equal than last 65558 bytes of the file in a string
2222 (in - Do not alter!).
2224 &$mime: MIME type (out).
2226 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2227 MIME type detected by considering the file extension.
2228 $mimeMagic: Instance of MimeMagic.
2229 $ext: File extension.
2230 &$mime: MIME type (in/out).
2232 'MimeMagicInit': Before processing the list mapping MIME types to media types
2233 and the list mapping MIME types to file extensions.
2234 As an extension author, you are encouraged to submit patches to MediaWiki's
2235 core to add new MIME types to mime.types.
2236 $mimeMagic: Instance of MimeMagic.
2237 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2238 for adding new MIME info to the list.
2239 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2240 for adding new MIME types to the list.
2242 'ModifyExportQuery': Modify the query used by the exporter.
2243 $db: The database object to be queried.
2244 &$tables: Tables in the query.
2245 &$conds: Conditions in the query.
2246 &$opts: Options for the query.
2247 &$join_conds: Join conditions for the query.
2249 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2251 $oldTitle: Title object of the current (old) location
2252 $newTitle: Title object of the new location
2253 $user: User making the move
2254 $reason: string of the reason provided by the user
2255 $status: Status object to pass error messages to
2257 'MovePageIsValidMove': Specify whether a page can be moved for technical
2259 $oldTitle: Title object of the current (old) location
2260 $newTitle: Title object of the new location
2261 $status: Status object to pass error messages to
2263 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2265 $index: Integer; the index of the namespace being checked.
2266 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2267 namespace are movable. Hooks may change this value to override the return
2268 value of MWNamespace::isMovable().
2270 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2271 $title: the diff page title (nullable)
2272 &$oldId: the actual old Id to use in the diff
2273 &$newId: the actual new Id to use in the diff (0 means current)
2274 $old: the ?old= param value from the url
2275 $new: the ?new= param value from the url
2277 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2279 $wikiPage: the WikiPage edited
2280 $rev: the new revision
2281 $baseID: the revision ID this was based off, if any
2282 $user: the editing user
2284 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2285 return false to omit the line from RecentChanges and Watchlist special pages.
2286 &$changeslist: The OldChangesList instance.
2287 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2288 $rc: The RecentChange object.
2289 &$classes: array of css classes for the <li> element
2291 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2292 can alter or append to the array of URLs for search & suggestion formats.
2293 &$urls: array of associative arrays with Url element attributes
2295 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2296 when a page view triggers a re-rendering of the page. This may happen
2297 particularly if the parser cache is split by user language, and no cached
2298 rendering of the page exists in the user's language. The hook is called
2299 before checking whether page_links_updated indicates that the links are up
2300 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2301 without triggering any updates.
2302 $page: the Page that was rendered.
2303 $title: the Title of the rendered page.
2304 $parserOutput: ParserOutput resulting from rendering the page.
2306 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2307 users and/or IP addresses too.
2308 &$otherBlockLink: An array with links to other block logs
2309 $ip: The requested IP address or username
2311 'OutputPageBeforeHTML': A page has been processed by the parser and the
2312 resulting HTML is about to be displayed.
2313 &$parserOutput: the parserOutput (object) that corresponds to the page
2314 &$text: the text that will be displayed, in HTML (string)
2316 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2317 body tag to allow for extensions to add attributes to the body of the page they
2318 might need. Or to allow building extensions to add body classes that aren't of
2319 high enough demand to be included in core.
2320 $out: The OutputPage which called the hook, can be used to get the real title
2321 $sk: The Skin that called OutputPage::headElement
2322 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2324 'OutputPageCheckLastModified': when checking if the page has been modified
2325 since the last visit.
2326 &$modifiedTimes: array of timestamps.
2327 The following keys are set: page, user, epoch
2328 $out: OutputPage object (since 1.28)
2330 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2331 categories. Implementations should return false if they generate the category
2332 links, so the default link generation is skipped.
2333 &$out: OutputPage instance (object)
2334 $categories: associative array, keys are category names, values are category
2335 types ("normal" or "hidden")
2336 &$links: array, intended to hold the result. Must be an associative array with
2337 category types as keys and arrays of HTML links as values.
2339 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2340 &$out: OutputPage instance (object)
2341 $parserOutput: parserOutput instance being added in $out
2343 'PageContentInsertComplete': After a new article is created.
2344 $wikiPage: WikiPage created
2345 $user: User creating the article
2346 $content: New content as a Content object
2347 $summary: Edit summary/comment
2348 $isMinor: Whether or not the edit was marked as minor
2349 $isWatch: (No longer used)
2350 $section: (No longer used)
2351 $flags: Flags passed to WikiPage::doEditContent()
2352 $revision: New Revision of the article
2354 'PageContentLanguage': Allows changing the language in which the content of a
2355 page is written. Defaults to the wiki content language ($wgContLang).
2356 $title: Title object
2357 &$pageLang: the page content language (either an object or a language code)
2358 $wgLang: the user language
2360 'PageContentSave': Before an article is saved.
2361 $wikiPage: the WikiPage (object) being saved
2362 $user: the user (object) saving the article
2363 $content: the new article content, as a Content object
2364 $summary: the article summary (comment)
2365 $isminor: minor flag
2366 $iswatch: watch flag
2369 'PageContentSaveComplete': After an article has been updated.
2370 $wikiPage: WikiPage modified
2371 $user: User performing the modification
2372 $content: New content, as a Content object
2373 $summary: Edit summary/comment
2374 $isMinor: Whether or not the edit was marked as minor
2375 $isWatch: (No longer used)
2376 $section: (No longer used)
2377 $flags: Flags passed to WikiPage::doEditContent()
2378 $revision: New Revision of the article (can be null for edits that change
2380 $status: Status object about to be returned by doEditContent()
2381 $baseRevId: the rev ID (or false) this edit was based on
2383 'PageHistoryBeforeList': When a history page list is about to be constructed.
2384 &$article: the article that the history is loading for
2385 $context: RequestContext object
2387 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2388 $historyAction: the action object
2389 &$row: the revision row for this line
2390 &$s: the string representing this parsed line
2391 &$classes: array containing the <li> element classes
2393 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2394 any output is generated, to allow batch lookups for prefetching information
2395 needed for display. If the hook handler returns false, the regular behavior of
2396 doBatchLookups() is skipped.
2397 $pager: the PageHistoryPager
2398 $result: a ResultWrapper representing the query result
2400 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2403 &$queryInfo: the query parameters
2405 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2406 which depends on user options should install this hook and append its values to
2408 &$confstr: reference to a hash key string which can be modified
2409 $user: User (object) requesting the page
2410 &$forOptions: array of options the hash is for
2412 'PageViewUpdates': Allow database (or other) changes to be made after a
2413 page view is seen by MediaWiki. Note this does not capture views made
2414 via external caches such as Squid.
2415 $wikipage: WikiPage (object) for the page being viewed.
2416 $user: User (object) for the user who is viewing.
2418 'ParserAfterParse': Called from Parser::parse() just after the call to
2419 Parser::internalParse() returns.
2420 &$parser: parser object
2421 &$text: text being parsed
2422 &$stripState: stripState used (object)
2424 'ParserAfterStrip': Called at end of parsing time.
2425 TODO: No more strip, deprecated ?
2426 &$parser: parser object
2427 &$text: text being parsed
2428 &$stripState: stripState used (object)
2430 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2431 &$parser: Parser object being used
2432 &$text: text that will be returned
2434 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2435 Parser::internalParseHalfParsed()
2436 &$parser: Parser object being used
2437 &$text: text that will be returned
2439 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2440 &$parser: Parser object
2441 &$text: text to parse
2442 &$stripState: StripState instance being used
2444 'ParserBeforeStrip': Called at start of parsing time.
2445 TODO: No more strip, deprecated ?
2446 &$parser: parser object
2447 &$text: text being parsed
2448 &$stripState: stripState used (object)
2450 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2451 &$parser: Parser object being used
2454 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2456 $parserCache: ParserCache object $parserOutput was stored in
2457 $parserOutput: ParserOutput object that was stored
2458 $title: Title of the page that was parsed to generate $parserOutput
2459 $popts: ParserOptions used for generating $parserOutput
2460 $revId: ID of the revision that was parsed to create $parserOutput
2462 'ParserClearState': Called at the end of Parser::clearState().
2463 &$parser: Parser object being cleared
2465 'ParserCloned': Called when the parser is cloned.
2466 $parser: Newly-cloned Parser object
2468 'ParserFirstCallInit': Called when the parser initialises for the first time.
2469 &$parser: Parser object being cleared
2471 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2473 &$parser: Parser object
2474 &$varCache: array to store the value in case of multiples calls of the
2476 &$index: index (string) of the magic
2477 &$ret: value of the magic word (the hook should set it)
2478 &$frame: PPFrame object to use for expanding any template variables
2480 'ParserGetVariableValueTs': Use this to change the value of the time for the
2481 {{LOCAL...}} magic word.
2482 &$parser: Parser object
2483 &$time: actual time (timestamp)
2485 'ParserGetVariableValueVarCache': use this to change the value of the variable
2486 cache or return false to not use it.
2487 &$parser: Parser object
2488 &$varCache: variable cache (array)
2490 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare instead.
2491 Called at the end of Parser:parse() when the parser will
2492 include comments about size of the text parsed.
2493 $parser: Parser object
2494 &$limitReport: text that will be included (without comment tags)
2496 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2497 will include comments about size of the text parsed. Hooks should use
2498 $output->setLimitReportData() to populate data. Functions for this hook should
2499 not use $wgLang; do that in ParserLimitReportFormat instead.
2500 $parser: Parser object
2501 $output: ParserOutput object
2503 'ParserMakeImageParams': Called before the parser make an image link, use this
2504 to modify the parameters of the image.
2505 $title: title object representing the file
2506 $file: file object that will be used to create the image
2507 &$params: 2-D array of parameters
2508 $parser: Parser object that called the hook
2510 'ParserSectionCreate': Called each time the parser creates a document section
2511 from wikitext. Use this to apply per-section modifications to HTML (like
2512 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2513 can begin in one section and end in another. Make sure your code can handle
2514 that case gracefully. See the EditSectionClearerLink extension for an example.
2515 $parser: the calling Parser instance
2516 $section: the section number, zero-based, but section 0 is usually empty
2517 &$sectionContent: ref to the content of the section. modify this.
2518 $showEditLinks: boolean describing whether this section has an edit link
2520 'ParserTestGlobals': Allows to define globals for parser tests.
2521 &$globals: Array with all the globals which should be set for parser tests.
2522 The arrays keys serve as the globals names, its values are the globals values.
2524 'ParserTestParser': Called when creating a new instance of Parser in
2525 tests/parser/parserTest.inc.
2526 &$parser: Parser object created
2528 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2529 run. Use when page save hooks require the presence of custom tables to ensure
2530 that tests continue to run properly.
2531 &$tables: array of table names
2533 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2534 $page: the WikiPage of the candidate edit
2535 $content: the Content object of the candidate edit
2536 $output: the ParserOutput result of the candidate edit
2537 $summary: the change summary of the candidate edit
2538 $user: the User considering the edit
2540 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2541 $user: User object whose policy you are modifying
2542 &$effectivePolicy: Array of policy statements that apply to this user
2543 $purpose: string indicating purpose of the check, one of 'login', 'create',
2546 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2548 $block: Block object (which is set to be autoblocking)
2549 &$blockIds: Array of block IDs of the autoblock
2551 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2552 my talk page, my contributions" etc).
2553 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2554 &$title: Title object representing the current page
2555 $skin: SkinTemplate object providing context (e.g. to check if the user is
2558 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2559 &$user: User performing the action
2560 $action: Action being performed
2561 &$result: Whether or not the action should be prevented
2562 Change $result and return false to give a definitive answer, otherwise
2563 the built-in rate limiting checks are used, if enabled.
2564 $incrBy: Amount to increment counter by
2566 'PlaceNewSection': Override placement of new sections. Return false and put the
2567 merged text into $text to override the default behavior.
2568 $wikipage: WikiPage object
2569 $oldtext: the text of the article before editing
2570 $subject: subject of the new section
2571 &$text: text of the new section
2573 'PostLoginRedirect': Modify the post login redirect behavior.
2574 Occurs after signing up or logging in, allows for interception of redirect.
2575 &$returnTo: The page name to return to, as a string
2576 &$returnToQuery: array of url parameters, mapping parameter names to values
2577 &$type: type of login redirect as string;
2578 error: display a return to link ignoring $wgRedirectOnLogin
2579 signup: display a return to link using $wgRedirectOnLogin if needed
2580 success: display a return to link using $wgRedirectOnLogin if needed
2581 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2583 'PreferencesFormPreSave': Override preferences being saved
2584 $formData: array of user submitted data
2585 $form: PreferencesForm object, also a ContextSource
2586 $user: User object with preferences to be saved set
2587 &$result: boolean indicating success
2589 'PreferencesGetLegend': Override the text used for the <legend> of a
2590 preferences section.
2591 $form: the PreferencesForm object. This is a ContextSource as well
2592 $key: the section name
2593 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2596 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2597 Override the title prefix search used for OpenSearch and
2598 AJAX search suggestions. Put results into &$results outparam and return false.
2599 $ns: array of int namespace keys to search in
2600 $search: search term (not guaranteed to be conveniently normalized)
2601 $limit: maximum number of results to return
2602 &$results: out param: array of page names (strings)
2603 $offset: number of results to offset from the beginning
2605 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2606 namespace from the search string so that extensions can attempt it.
2607 &$namespaces: array of int namespace keys to search in (change this if you can
2609 &$search: search term (replace this with term without the namespace if you can
2612 'PrefsEmailAudit': Called when user changes their email address.
2613 $user: User (object) changing his email address
2614 $oldaddr: old email address (string)
2615 $newaddr: new email address (string)
2617 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2619 $article: the title being (un)protected
2620 &$output: a string of the form HTML so far
2622 'ProtectionForm::save': Called when a protection form is submitted.
2623 $article: the Page being (un)protected
2624 &$errorMsg: an html message string of an error or an array of message name and
2626 $reasonstr: a string describing the reason page protection level is altered
2628 'ProtectionForm::showLogExtract': Called after the protection log extract is
2630 $article: the page the form is shown for
2631 $out: OutputPage object
2633 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2635 &$tables: Database tables to be used in the query
2636 &$conds: Conditions to be applied in the query
2637 &$joinConds: Join conditions to be applied in the query
2639 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2640 &$obj: RawAction object
2641 &$text: The text that's going to be the output
2643 'RecentChange_save': Called at the end of RecentChange::save().
2644 &$recentChange: RecentChange object
2646 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2647 names such as "oldid" that are preserved when using redirecting special pages
2648 such as Special:MyPage and Special:MyTalk.
2649 &$redirectParams: An array of parameters preserved by redirecting special pages.
2651 'RejectParserCacheValue': Return false to reject an otherwise usable
2652 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2653 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2655 $parserOutput: ParserOutput value.
2656 $wikiPage: WikiPage object.
2657 $parserOptions: ParserOptions object.
2659 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2660 instance. Can be used by an extension override what skin is used in certain
2662 $context: (IContextSource) The RequestContext the skin is being created for.
2663 &$skin: A variable reference you may set a Skin instance or string key on to
2664 override the skin that will be used for the context.
2666 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2667 flagged to lack same-origin security. Return false to indicate the lack. Note
2668 if the "somehow" involves HTTP headers, you'll probably need to make sure
2669 the header is varied on.
2670 $request: The WebRequest object.
2672 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2673 $user: The user having their password expiration reset
2674 &$newExpire: The new expiration date
2676 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2677 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2678 to override its behavior. See the module docs for more information.
2679 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2681 $context: ResourceLoaderContext|null
2683 'ResourceLoaderGetConfigVars': Called at the end of
2684 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2685 configuration variables to JavaScript. Things that depend on the current page
2686 or request state must be added through MakeGlobalVariablesScript instead.
2687 &$vars: array( variable name => value )
2689 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2690 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2691 context-based variables.
2692 &$lessVars: array of variables already added
2694 'ResourceLoaderRegisterModules': Right before modules information is required,
2695 such as when responding to a resource
2696 loader request or generating HTML output.
2697 &$resourceLoader: ResourceLoader object
2699 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2700 called after the addition of 'qunit' and MediaWiki testing resources.
2701 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2702 included in core, is fed using tests/qunit/QUnitTestResources.php.
2703 To add a new qunit module named 'myext.tests':
2704 $testModules['qunit']['myext.tests'] = array(
2705 'script' => 'extension/myext/tests.js',
2706 'dependencies' => <any module dependency you might have>
2708 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2709 added to any module.
2710 &$ResourceLoader: object
2712 'RevisionInsertComplete': Called after a revision is inserted into the database.
2713 &$revision: the Revision
2714 $data: the data stored in old_text. The meaning depends on $flags: if external
2715 is set, it's the URL of the revision text in external storage; otherwise,
2716 it's the revision text itself. In either case, if gzip is set, the revision
2718 $flags: a comma-delimited list of strings representing the options used. May
2719 include: utf8 (this will always be set for new revisions); gzip; external.
2721 'SearchableNamespaces': An option to modify which namespaces are searchable.
2722 &$arr: Array of namespaces ($nsId => $name) which will be used.
2724 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2725 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2727 $term: Search term string
2728 &$title: Outparam; set to $title object and return false for a match
2730 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2731 if nothing was found.
2732 $term: Search term string
2733 &$title: Outparam; set to $title object and return false for a match
2735 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2736 the normal operations.
2737 $allSearchTerms: Array of the search terms in all content languages
2738 &$titleResult: Outparam; the value to return. A Title object or null.
2740 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2742 $term: Search term string
2743 &$title: Current Title object that is being returned (null if none found).
2745 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2747 $title: Current Title object being displayed in search results.
2748 &$id: Revision ID (default is false, for latest)
2750 'SearchIndexFields': Add fields to search index mapping.
2751 &$fields: Array of fields, all implement SearchIndexField
2752 $engine: SearchEngine instance for which mapping is being built.
2754 'SearchDataForIndex': Add data to search document. Allows to add any data to
2755 the field map used to index the document.
2756 &$fields: Array of name => value pairs for fields
2757 $handler: ContentHandler for the content being indexed
2758 $page: WikiPage that is being indexed
2759 $output: ParserOutput that is produced from the page
2760 $engine: SearchEngine for which the indexing is intended
2762 'SearchResultsAugment': Allows extension to add its code to the list of search
2764 &$setAugmentors: List of whole-set augmentor objects, must implement ResultSetAugmentor
2765 &$rowAugmentors: List of per-row augmentor objects, must implement ResultAugmentor.
2766 Note that lists should be in the format name => object and the names in both lists should
2769 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2770 perform when page content is modified. Currently called by
2771 AbstractContent::getSecondaryDataUpdates.
2772 $title: Title of the page that is being edited.
2773 $oldContent: Content object representing the page's content before the edit.
2774 $recursive: bool indicating whether DataUpdates should trigger recursive
2775 updates (relevant mostly for LinksUpdate).
2776 $parserOutput: ParserOutput representing the rendered version of the page
2778 &$updates: a list of DataUpdate objects, to be modified or replaced by
2781 'SecuritySensitiveOperationStatus': Affect the return value from
2782 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2783 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2784 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2785 authentication isn't possible for the current session type.
2786 $operation: (string) The operation being checked.
2787 $session: (MediaWiki\Session\Session) The current session. The
2788 currently-authenticated user may be retrieved as $session->getUser().
2789 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2790 the time of last auth is unknown, or -1 if authentication is not possible.
2792 'SelfLinkBegin': Called before a link to the current article is displayed to
2793 allow the display of the link to be customized.
2794 $nt: the Title object
2795 &$html: html to display for the link
2796 &$trail: optional text to display before $html
2797 &$prefix: optional text to display after $html
2798 &$ret: the value to return if your hook returns false
2800 'SendWatchlistEmailNotification': Return true to send watchlist email
2802 $targetUser: the user whom to send watchlist email notification
2803 $title: the page title
2804 $enotif: EmailNotification object
2806 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2807 loaded from storage. Return false to prevent it from being used.
2808 &$reason: String rejection reason to be logged
2809 $info: MediaWiki\Session\SessionInfo being validated
2810 $request: WebRequest being loaded from
2811 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2812 $data: Array|false Data array for the MediaWiki\Session\Session
2814 'SessionMetadata': Add metadata to a session being saved.
2815 $backend: MediaWiki\Session\SessionBackend being saved.
2816 &$metadata: Array Metadata to be stored. Add new keys here.
2817 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2818 request and 0+ FauxRequests.
2820 'SetupAfterCache': Called in Setup.php, after cache objects are set
2822 'ShortPagesQuery': Allow extensions to modify the query used by
2824 &$tables: tables to join in the query
2825 &$conds: conditions for the query
2826 &$joinConds: join conditions for the query
2827 &$options: options for the query
2829 'ShowMissingArticle': Called when generating the output for a non-existent page.
2830 $article: The article object corresponding to the page
2832 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2833 Customise the output of raw CSS and JavaScript in page views.
2834 $text: Text being shown
2835 $title: Title of the custom script/stylesheet page
2836 $output: Current OutputPage object
2838 'ShowSearchHit': Customize display of search hit.
2839 $searchPage: The SpecialSearch instance.
2840 $result: The SearchResult to show
2841 $terms: Search terms, for highlighting
2842 &$link: HTML of link to the matching page. May be modified.
2843 &$redirect: HTML of redirect info. May be modified.
2844 &$section: HTML of matching section. May be modified.
2845 &$extract: HTML of content extract. May be modified.
2846 &$score: HTML of score. May be modified.
2847 &$size: HTML of page size. May be modified.
2848 &$date: HTML of of page modification date. May be modified.
2849 &$related: HTML of additional info for the matching page. May be modified.
2850 &$html: May be set to the full HTML that should be used to represent the search
2851 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2852 function returned false.
2854 'ShowSearchHitTitle': Customise display of search hit title/link.
2855 &$title: Title to link to
2856 &$text: Text to use for the link
2857 $result: The search result
2858 $terms: The search terms entered
2859 $page: The SpecialSearch object
2860 &$query: Query string to be appended to the link
2862 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2863 Warning: This hook is run on each display. You should consider to use
2864 'SkinBuildSidebar' that is aggressively cached.
2866 &$bar: Sidebar content
2867 Modify $bar to add or modify sidebar portlets.
2869 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2870 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2871 the sitenotice/anonnotice.
2874 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2875 allow the normal method of notice selection/rendering to work, or change the
2876 value of $siteNotice and return false to alter it.
2877 &$siteNotice: HTML returned as the sitenotice
2880 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2882 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2883 the stock bottom scripts.
2885 'SkinAfterContent': Allows extensions to add text after the page content and
2886 article metadata. This hook should work in all skins. Set the &$data variable to
2887 the text you're going to add.
2888 &$data: (string) Text to be printed out directly (without parsing)
2891 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2893 &$bar: Sidebar contents
2894 Modify $bar to add or modify sidebar portlets.
2896 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2898 $title: displayed page title
2899 $type: 'normal' or 'history' for old/diff views
2900 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2901 message must be in HTML format, not wikitext!
2902 &$link: overridable HTML link to be passed into the message as $1
2903 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2906 'SkinEditSectionLinks': Modify the section edit links
2907 $skin: Skin object rendering the UI
2908 $title: Title object for the title being linked to (may not be the same as
2909 the page title, if the section is included from a template)
2910 $section: The designation of the section being pointed to, to be included in
2911 the link, like "§ion=$section"
2912 $tooltip: The default tooltip. Escape before using.
2913 By default, this is wrapped in the 'editsectionhint' message.
2914 &$result: Array containing all link detail arrays. Each link detail array should
2915 contain the following keys:
2916 - targetTitle - Target Title object
2917 - text - String for the text
2918 - attribs - Array of attributes
2919 - query - Array of query parameters to add to the URL
2920 - options - Array of options for Linker::link
2921 $lang: The language code to use for the link in the wfMessage function
2923 'SkinGetPoweredBy': TODO
2924 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2925 the MediaWiki icon but plain text instead.
2928 'SkinPreloadExistence': Supply titles that should be added to link existence
2929 cache before the page is rendered.
2930 &$titles: Array of Title objects
2933 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2934 If false is returned $subpages will be used instead of the HTML
2935 subPageSubtitle() generates.
2936 If true is returned, $subpages will be ignored and the rest of
2937 subPageSubtitle() will run.
2938 &$subpages: Subpage links HTML
2940 $out: OutputPage object
2942 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2944 &$sktemplate: SkinTemplate object
2945 &$nav_urls: array of tabs
2946 &$revid: The revision id of the permanent link
2947 &$revid2: The revision id of the permanent link, second time
2949 'SkinTemplateGetLanguageLink': After building the data for a language link from
2950 which the actual html is constructed.
2951 &$languageLink: array containing data about the link. The following keys can be
2952 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2953 $languageLinkTitle: Title object belonging to the external language link.
2954 $title: Title object of the page the link belongs to.
2955 $outputPage: The OutputPage object the links are built from.
2957 'SkinTemplateNavigation': Called on content pages after the tabs have been
2958 added, but before variants have been added.
2959 &$sktemplate: SkinTemplate object
2960 &$links: Structured navigation links. This is used to alter the navigation for
2961 skins which use buildNavigationUrls such as Vector.
2963 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2964 tab is added but before variants have been added.
2965 &$sktemplate: SkinTemplate object
2966 &$links: Structured navigation links. This is used to alter the navigation for
2967 skins which use buildNavigationUrls such as Vector.
2969 'SkinTemplateNavigation::Universal': Called on both content and special pages
2970 after variants have been added.
2971 &$sktemplate: SkinTemplate object
2972 &$links: Structured navigation links. This is used to alter the navigation for
2973 skins which use buildNavigationUrls such as Vector.
2975 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2977 &$sktemplate: SkinTemplate object
2978 &$tpl: QuickTemplate engine object
2980 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2981 &$sktemplate: SkinTemplate object
2982 &$res: set to true to prevent active tabs
2984 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2985 You can either create your own array, or alter the parameters for
2987 &$sktemplate: The SkinTemplate instance.
2988 $title: Title instance for the page.
2989 $message: Visible label of tab.
2990 $selected: Whether this is a selected tab.
2991 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2992 &$classes: Array of CSS classes to apply.
2993 &$query: Query string to add to link.
2995 &$result: Complete assoc. array if you want to return true.
2997 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2998 been rendered (useful for adding more).
2999 &$sk: The QuickTemplate based skin template running the hook.
3000 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3001 extensions that add support for BaseTemplateToolbox should watch for this
3002 dummy parameter with "$dummy=false" in their code and return without echoing
3003 any HTML to avoid creating duplicate toolbox items.
3005 'SoftwareInfo': Called by Special:Version for returning information about the
3007 &$software: The array of software in format 'name' => 'version'. See
3008 SpecialVersion::softwareInformation().
3010 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3011 $sp: SpecialPage object, for context
3012 &$fields: Current HTMLForm fields
3014 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3015 $id: User id number, only provided for backwards-compatibility
3016 $user: User object representing user contributions are being fetched for
3017 $sp: SpecialPage instance, providing context
3019 'SpecialContributions::formatRow::flags': Called before rendering a
3020 Special:Contributions row.
3021 $context: IContextSource object
3022 $row: Revision information from the database
3023 &$flags: List of flags on this row
3025 'SpecialContributions::getForm::filters': Called with a list of filters to render
3026 on Special:Contributions.
3027 $sp: SpecialContributions object, for context
3028 &$filters: List of filters rendered as HTML
3030 'SpecialListusersDefaultQuery': Called right before the end of
3031 UsersPager::getDefaultQuery().
3032 $pager: The UsersPager instance
3033 &$query: The query array to be returned
3035 'SpecialListusersFormatRow': Called right before the end of
3036 UsersPager::formatRow().
3037 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
3038 $row: Database row object
3040 'SpecialListusersHeader': Called before closing the <fieldset> in
3041 UsersPager::getPageHeader().
3042 $pager: The UsersPager instance
3043 &$out: The header HTML
3045 'SpecialListusersHeaderForm': Called before adding the submit button in
3046 UsersPager::getPageHeader().
3047 $pager: The UsersPager instance
3048 &$out: The header HTML
3050 'SpecialListusersQueryInfo': Called right before the end of.
3051 UsersPager::getQueryInfo()
3052 $pager: The UsersPager instance
3053 &$query: The query array to be returned
3055 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3056 $type: String of the log type
3057 $request: WebRequest object for getting the value provided by the current user
3058 &$qc: Array for query conditions to add
3060 'SpecialMovepageAfterMove': Called after moving a page.
3061 &$movePage: MovePageForm object
3062 &$oldTitle: old title (object)
3063 &$newTitle: new title (object)
3065 'SpecialNewpagesConditions': Called when building sql query for
3067 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3068 $opts: FormOptions object containing special page options
3069 &$conds: array of WHERE conditionals for query
3070 &$tables: array of tables to be queried
3071 &$fields: array of columns to select
3072 &$join_conds: join conditions for the tables
3074 'SpecialNewPagesFilters': Called after building form options at NewPages.
3075 $special: the special page object
3076 &$filters: associative array of filter definitions. The keys are the HTML
3077 name/URL parameters. Each key maps to an associative array with a 'msg'
3078 (message key) and a 'default' value.
3080 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3081 this hook to remove a core special page or conditionally register special pages.
3082 &$list: list (array) of core special pages
3084 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3085 $special: the SpecialPage object
3086 $subPage: the subpage string or null if no subpage was specified
3088 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3089 Return false to prevent execution.
3090 $special: the SpecialPage object
3091 $subPage: the subpage string or null if no subpage was specified
3093 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3094 $name: name of the special page
3095 &$form: HTMLForm object
3097 'SpecialPasswordResetOnSubmit': When executing a form submission on
3098 Special:PasswordReset.
3099 &$users: array of User objects.
3100 $data: array of data submitted by the user
3101 &$error: string, error code (message key) used to describe to error (out
3102 parameter). The hook needs to return false when setting this, otherwise it
3103 will have no effect.
3105 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3106 use this to change some selection criteria or substitute a different title.
3107 &$randstr: The random number from wfRandom()
3108 &$isRedir: Boolean, whether to select a redirect or non-redirect
3109 &$namespaces: An array of namespace indexes to get the title from
3110 &$extra: An array of extra SQL statements
3111 &$title: If the hook returns false, a Title object to use instead of the
3112 result from the normal query
3114 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3116 Called after building form options at RecentChanges.
3117 $special: the special page object
3118 &$filters: associative array of filter definitions. The keys are the HTML
3119 name/URL parameters. Each key maps to an associative array with a 'msg'
3120 (message key) and a 'default' value.
3122 'SpecialRecentChangesPanel': Called when building form options in
3123 SpecialRecentChanges.
3124 &$extraOpts: array of added items, to which can be added
3125 $opts: FormOptions for this request
3127 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
3129 Called when building SQL query for SpecialRecentChanges and
3130 SpecialRecentChangesLinked.
3131 &$conds: array of WHERE conditionals for query
3132 &$tables: array of tables to be queried
3133 &$join_conds: join conditions for the tables
3134 $opts: FormOptions for this request
3135 &$query_options: array of options for the database request
3136 &$select: Array of columns to select
3138 'SpecialResetTokensTokens': Called when building token list for
3140 &$tokens: array of token information arrays in the format of
3142 'preference' => '<preference-name>',
3143 'label-message' => '<message-key>',
3146 'SpecialSearchCreateLink': Called when making the message to create a page or
3147 go to the existing page.
3148 $t: title object searched for
3149 &$params: an array of the default message name and page title (as parameter)
3151 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3152 canceled and a normal search will be performed. Returning true without setting
3153 $url does a standard redirect to $title. Setting $url redirects to the
3155 $term: The string the user searched for
3156 $title: The title the 'go' feature has decided to forward the user to
3157 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3159 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3160 target doesn't exist.
3161 &$title: title object generated from the text entered by the user
3163 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3164 the advanced form, a.k.a. power search box.
3165 &$showSections: an array to add values with more options to
3166 $term: the search term (not a title object)
3167 $opts: an array of hidden options (containing 'redirs' and 'profile')
3169 'SpecialSearchProfileForm': Allows modification of search profile forms.
3170 $search: special page object
3171 &$form: String: form html
3172 $profile: String: current search profile
3173 $term: String: search term
3174 $opts: Array: key => value of hidden options for inclusion in custom forms
3176 'SpecialSearchProfiles': Allows modification of search profiles.
3177 &$profiles: profiles, which can be modified.
3179 'SpecialSearchResults': Called before search result display
3180 $term: string of search term
3181 &$titleMatches: empty or SearchResultSet object
3182 &$textMatches: empty or SearchResultSet object
3184 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3185 on the search results page. Useful for including an external search
3186 provider. To disable the output of MediaWiki search output, return
3188 $specialSearch: SpecialSearch object ($this)
3190 $term: Search term specified by the user
3192 'SpecialSearchResultsAppend': Called immediately before returning HTML
3193 on the search results page. Useful for including a feedback link.
3194 $specialSearch: SpecialSearch object ($this)
3196 $term: Search term specified by the user
3198 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3199 $search: SpecialSearch special page object
3200 $profile: String: current search profile
3201 $engine: the search engine
3203 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3204 &$extraStats: Array to save the new stats
3205 $extraStats['<name of statistic>'] => <value>;
3206 <value> can be an array with the keys "name" and "number":
3207 "name" is the HTML to be displayed in the name column
3208 "number" is the number to be displayed.
3209 or, <value> can be the number to be displayed and <name> is the
3210 message key to use in the name column,
3211 $context: IContextSource object
3213 'SpecialUploadComplete': Called after successfully uploading a file from
3215 &$form: The SpecialUpload object
3217 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3218 $wgVersion: Current $wgVersion for you to use
3219 &$versionUrl: Raw url to link to (eg: release notes)
3221 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3223 Called after building form options at Watchlist.
3224 $special: the special page object
3225 &$filters: associative array of filter definitions. The keys are the HTML
3226 name/URL parameters. Each key maps to an associative array with a 'msg'
3227 (message key) and a 'default' value.
3229 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3230 SpecialWatchlist. Allows extensions to register custom values they have
3231 inserted to rc_type so they can be returned as part of the watchlist.
3232 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3234 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3235 Called when building sql query for SpecialWatchlist.
3236 &$conds: array of WHERE conditionals for query
3237 &$tables: array of tables to be queried
3238 &$join_conds: join conditions for the tables
3239 &$fields: array of query fields
3240 $opts: A FormOptions object with watchlist options for the current request
3242 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3243 URL for a title when we have no other parameters on the URL. Gives a chance for
3244 extensions that alter page view behavior radically to abort that redirect or
3246 $request: WebRequest
3247 $title: Title of the currently found title obj
3248 $output: OutputPage object
3250 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3251 rendered (by ThumbnailImage:toHtml method).
3252 $thumbnail: the ThumbnailImage object
3253 &$attribs: image attribute array
3254 &$linkAttribs: image link attribute array
3256 'TitleArrayFromResult': Called when creating an TitleArray object from a
3258 &$titleArray: set this to an object to override the default object returned
3259 $res: database result used to create the object
3261 'TitleExists': Called when determining whether a page exists at a given title.
3262 $title: The title being tested.
3263 &$exists: Whether the title exists.
3265 'TitleGetEditNotices': Allows extensions to add edit notices
3266 $title: The Title object for the page the edit notices are for
3267 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3268 &$notices: Array of notices. Keys are i18n message keys, values are
3269 parseAsBlock()ed messages.
3271 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3272 that can be applied.
3273 $title: The title in question.
3274 &$types: The types of protection available.
3276 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3277 overriding default behavior for determining if a page exists. If $isKnown is
3278 kept as null, regular checks happen. If it's a boolean, this value is returned
3279 by the isKnown method.
3280 $title: Title object that is being checked
3281 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3283 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3284 Called when determining if a page is a CSS or JS page.
3285 $title: Title object that is being checked
3286 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3287 Hooks may change this value to override the return value of
3288 Title::isCssOrJsPage().
3290 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3291 that this hook is not called for interwiki pages or pages in immovable
3292 namespaces: for these, isMovable() always returns false.
3293 $title: Title object that is being checked
3294 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3295 Hooks may change this value to override the return value of
3298 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3299 Called when determining if a page is a wikitext or should
3300 be handled by separate handler (via ArticleViewCustom).
3301 $title: Title object that is being checked
3302 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3303 Hooks may change this value to override the return value of
3304 Title::isWikitextPage()
3306 'TitleMove': Before moving an article (title).
3309 $user: user who does the move
3311 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3314 $user: user who does the move
3316 'TitleMoveComplete': After moving an article (title), post-commit.
3319 &$user: user who did the move
3320 $pageid: database ID of the page that's been moved
3321 $redirid: database ID of the created redirect
3322 $reason: reason for the move
3323 $revision: the Revision created by the move
3325 'TitleMoveCompleting': After moving an article (title), pre-commit.
3328 $user: user who did the move
3329 $pageid: database ID of the page that's been moved
3330 $redirid: database ID of the created redirect
3331 $reason: reason for the move
3332 $revision: the Revision created by the move
3334 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3335 or override the quick permissions check.
3336 $title: The Title object being accessed
3337 $user: The User performing the action
3338 $action: Action being performed
3339 &$errors: Array of errors
3340 $doExpensiveQueries: Whether to do expensive DB queries
3341 $short: Whether to return immediately on first error
3343 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3344 adding the default error message if nothing allows the user to read the page. If
3345 a handler wants a title to *not* be whitelisted, it should also return false.
3346 $title: Title object being checked against
3347 $user: Current user object
3348 &$whitelisted: Boolean value of whether this title is whitelisted
3350 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3351 $title: Title object to purge
3352 &$urls: An array of URLs to purge from the caches, to be manipulated.
3354 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3355 PageArchive object has been created but before any further processing is done.
3356 &$archive: PageArchive object
3357 $title: Title object of the page that we're viewing
3359 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3360 PageArchive object has been created but before any further processing is done.
3361 &$archive: PageArchive object
3362 $title: Title object of the page that we're viewing
3364 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3365 the site is not in read-only mode, that the Title object is not null and after
3366 a PageArchive object has been constructed but before performing any further
3368 &$archive: PageArchive object
3369 $title: Title object of the page that we're about to undelete
3371 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3372 $title: title object related to the revision
3373 $rev: revision (object) that will be viewed
3375 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3376 Since 1.24: Paths pointing to a directory will be recursively scanned for
3377 test case files matching the suffix "Test.php".
3378 &$paths: list of test cases and directories to search.
3380 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3382 $action: action name
3383 $article: article "acted on"
3385 'UnwatchArticle': Before a watch is removed from an article.
3386 &$user: user watching
3387 &$page: WikiPage object to be removed
3388 &$status: Status object to be returned if the hook returns false
3390 'UnwatchArticleComplete': After a watch is removed from an article.
3391 $user: user that watched
3392 &$page: WikiPage object that was watched
3394 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3395 &$formattedPageStatus: list of valid page states
3397 'UploadComplete': Upon completion of a file upload.
3398 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3399 $uploadBase->getLocalFile().
3401 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3402 $type: (string) the requested upload type
3403 &$className: the class name of the Upload instance to be created
3405 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3406 poke at member variables like $mUploadDescription before the file is saved. Do
3407 not use this hook to break upload processing. This will return the user to a
3408 blank form with no error message; use UploadVerification and UploadVerifyFile
3410 &$form: UploadForm object
3412 'UploadForm:initial': Before the upload form is generated. You might set the
3413 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3414 text (HTML) either before or after the editform.
3415 &$form: UploadForm object
3417 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3419 &$descriptor: (array) the HTMLForm descriptor
3421 'UploadFormSourceDescriptors': after the standard source inputs have been
3422 added to the descriptor
3423 &$descriptor: (array) the HTMLForm descriptor
3424 &$radio: Boolean, if source type should be shown as radio button
3425 $selectedSourceType: The selected source type
3427 'UploadStashFile': Before a file is stashed (uploaded to stash).
3428 Note that code which has not been updated for MediaWiki 1.28 may not call this
3429 hook. If your extension absolutely, positively must prevent some files from
3430 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3431 $upload: (object) An instance of UploadBase, with all info about the upload
3432 $user: (object) An instance of User, the user uploading this file
3433 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3434 &$error: output: If the file stashing should be prevented, set this to the reason
3435 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3436 instance (you might want to use ApiMessage to provide machine-readable details
3439 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3440 Additional chances to reject an uploaded file.
3441 $saveName: (string) destination file name
3442 $tempName: (string) filesystem path to the temporary file for checks
3443 &$error: (string) output: message key for message to show if upload canceled by
3444 returning false. May also be an array, where the first element is the message
3445 key and the remaining elements are used as parameters to the message.
3447 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3448 in most cases over UploadVerification.
3449 $upload: (object) an instance of UploadBase, with all info about the upload
3450 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3451 Handlers will typically only apply for specific MIME types.
3452 &$error: (object) output: true if the file is valid. Otherwise, set this to the reason
3453 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3454 instance (you might want to use ApiMessage to provide machine-readable details
3457 'UploadVerifyUpload': Upload verification, based on both file properties like
3458 MIME type (same as UploadVerifyFile) and the information entered by the user
3459 (upload comment, file page contents etc.).
3460 $upload: (object) An instance of UploadBase, with all info about the upload
3461 $user: (object) An instance of User, the user uploading this file
3462 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3463 $comment: (string) Upload log comment (also used as edit summary)
3464 $pageText: (string) File description page text (only used for new uploads)
3465 &$error: output: If the file upload should be prevented, set this to the reason
3466 in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3467 instance (you might want to use ApiMessage to provide machine-readable details
3470 'UserIsBot': when determining whether a user is a bot account
3472 &$isBot: whether this is user a bot or not (boolean)
3474 'User::mailPasswordInternal': before creation and mailing of a user's new
3476 &$user: the user who sent the message out
3477 &$ip: IP of the user who sent the message out
3478 &$u: the account whose new password will be set
3480 'UserAddGroup': Called when adding a group; return false to override
3481 stock group addition.
3482 $user: the user object that is to have a group added
3483 &$group: the group to add, can be modified
3485 'UserArrayFromResult': Called when creating an UserArray object from a database
3487 &$userArray: set this to an object to override the default object returned
3488 $res: database result used to create the object
3490 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3491 want to display an error message, try getUserPermissionsErrors.
3492 &$title: Title object being checked against
3493 &$user: Current user object
3494 $action: Action being checked
3495 &$result: Pointer to result returned if hook returns false. If null is returned,
3496 userCan checks are continued by internal code.
3498 'UserCanSendEmail': To override User::canSendEmail() permission check.
3499 &$user: User (object) whose permission is being checked
3500 &$canSend: bool set on input, can override on output
3502 'UserClearNewTalkNotification': Called when clearing the "You have new
3503 messages!" message, return false to not delete it.
3504 &$user: User (object) that will clear the message
3505 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3507 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3508 Manipulate the login form.
3509 &$template: SimpleTemplate instance for the form
3511 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3512 &$user: User to get groups for
3513 &$groups: Current effective groups
3515 'UserGetAllRights': After calculating a list of all available rights.
3516 &$rights: Array of rights, which may be added to.
3518 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3519 before returning the options to the caller. Warning: This hook is called for
3520 every call to User::getDefaultOptions(), which means it's potentially called
3521 dozens or hundreds of times. You may want to cache the results of non-trivial
3522 operations in your hook function for this reason.
3523 &$defaultOptions: Array of preference keys and their default values.
3525 'UserGetEmail': Called when getting an user email address.
3527 &$email: email, change this to override local email
3529 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3530 email authentication.
3532 &$timestamp: timestamp, change this to override local email authentication
3535 'UserGetImplicitGroups': DEPRECATED!
3536 Called in User::getImplicitGroups().
3537 &$groups: List of implicit (automatically-assigned) groups
3539 'UserGetLanguageObject': Called when getting user's interface language object.
3541 &$code: Language code that will be used to create the object
3542 $context: IContextSource object
3544 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3545 &$reservedUsernames: $wgReservedUsernames
3547 'UserGetRights': Called in User::getRights().
3548 $user: User to get rights for
3549 &$rights: Current rights
3551 'UserGroupsChanged': Called after user groups are changed.
3552 $user: User whose groups changed
3553 $added: Groups added
3554 $removed: Groups removed
3555 $performer: User who performed the change, false if via autopromotion
3556 $reason: The reason, if any, given by the user performing the change,
3557 false if via autopromotion.
3559 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3560 specific block exemptions).
3561 $user: User in question
3562 $title: Title of the page in question
3563 &$blocked: Out-param, whether or not the user is blocked from that page.
3564 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3565 to edit their own user talk pages.
3567 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3569 $ip: User's IP address
3570 &$blocked: Whether the user is blocked, to be modified by the hook
3571 &$block: The Block object, to be modified by the hook
3573 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3574 false if a UserGetRights hook might remove the named right.
3575 $right: The user right being checked
3577 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3578 $user: User in question.
3579 &$hidden: Set true if the user's name should be hidden.
3581 'UserIsLocked': Check if the user is locked. See User::isLocked().
3582 $user: User in question.
3583 &$locked: Set true if the user should be locked.
3585 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3586 environmental means; occurs after session is loaded.
3587 $user: user object being loaded
3589 'UserLoadDefaults': Called when loading a default user.
3593 'UserLoadFromDatabase': Called when loading a user from the database.
3595 &$s: database query object
3597 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3598 Called to authenticate users on external/environmental means; occurs before
3600 $user: user object being loaded
3601 &$result: set this to a boolean value to abort the normal authentication
3604 'UserLoadOptions': When user options/preferences are being loaded from the
3607 &$options: Options, can be modified.
3609 'UserLoggedIn': Called after a user is logged in
3610 $user: User object for the logged-in user
3612 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3613 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3614 &$user: the user object that was created on login
3615 &$inject_html: Any HTML to inject after the "logged in" message.
3616 $direct: (bool) The hook is called directly after a successful login. This will only happen once
3617 per login. A UserLoginComplete call with direct=false can happen when the user visits the login
3618 page while already logged in.
3620 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3621 Manipulate the login form.
3622 &$template: QuickTemplate instance for the form
3624 'UserLogout': Before a user logs out.
3625 &$user: the user object that is about to be logged out
3627 'UserLogoutComplete': After a user has logged out.
3628 &$user: the user object _after_ logout (won't have name, ID, etc.)
3629 &$inject_html: Any HTML to inject after the "logged out" message.
3630 $oldName: name of the user before logout (string)
3632 'UserMailerChangeReturnPath': Called to generate a VERP return address
3633 when UserMailer sends an email, with a bounce handling extension.
3634 $to: Array of MailAddress objects for the recipients
3635 &$returnPath: The return address string
3637 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3638 to split up an email with multiple the To: field into separate emails.
3639 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3641 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3642 Extensions can block sending the email by returning false and setting $error.
3643 $to: array of MailAdresses of the targets
3644 $from: MailAddress of the sender
3645 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3646 &$error: should be set to an error message string
3648 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3649 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3650 $to: array of MailAdresses of the targets
3651 $from: MailAddress of the sender
3652 &$subject: email subject (not MIME encoded)
3653 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3654 &$body: email body (in MIME format) as a string
3655 &$error: should be set to an error message string
3657 'UserRemoveGroup': Called when removing a group; return false to override stock
3659 $user: the user object that is to have a group removed
3660 &$group: the group to be removed, can be modified
3662 'UserRequiresHTTPS': Called to determine whether a user needs
3663 to be switched to HTTPS.
3664 $user: User in question.
3665 &$https: Boolean whether $user should be switched to HTTPS.
3667 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3668 have been requested to be reset. This hook can be used to exclude certain
3669 options from being reset even when the user has requested all prefs to be reset,
3670 because certain options might be stored in the user_properties database table
3671 despite not being visible and editable via Special:Preferences.
3672 $user: the User (object) whose preferences are being reset
3673 &$newOptions: array of new (site default) preferences
3674 $options: array of the user's old preferences
3675 $resetKinds: array containing the kinds of preferences to reset
3677 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3679 &$user: user retrieving new talks messages
3680 &$talks: array of new talks page(s)
3682 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3683 After a user's group memberships are changed.
3684 &$user: User object that was changed
3685 $add: Array of strings corresponding to groups added
3686 $remove: Array of strings corresponding to groups removed
3688 'UserSaveOptions': Called just before saving user preferences/options.
3690 &$options: Options, modifiable
3692 'UserSaveSettings': Called when saving user settings.
3695 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3696 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3697 instead. Otherwise, you can no longer count on user data being saved to cookies
3698 versus some other mechanism.
3699 Called when setting user cookies.
3701 &$session: session array, will be added to the session
3702 &$cookies: cookies array mapping cookie name to its value
3704 'UserSetEmail': Called when changing user email address.
3706 &$email: new email, change this to override new email address
3708 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3709 email authentication.
3711 &$timestamp: new timestamp, change this to override local email
3712 authentication timestamp
3714 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3715 "Foobar (Talk | Contribs | Block)".
3716 $userId: User id of the current user
3717 $userText: User name of the current user
3718 &$items: Array of user tool links as HTML fragments
3720 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3721 extensions providing user group data from an alternate source a chance to add
3722 their data into the cache array so that things like global user groups are
3723 displayed correctly in Special:ListUsers.
3724 $dbr: Read-only database handle
3725 $userIds: Array of user IDs whose groups we should look up
3726 &$cache: Array of user ID -> internal user group name (e.g. 'sysop') mappings
3727 &$groups: Array of group name -> bool true mappings for members of a given user
3730 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3731 FormatMetadata::getExtendedMeta (return false means cache will be
3732 invalidated and GetExtendedMetadata hook called again).
3733 $timestamp: The timestamp metadata was generated
3734 $file: The file the metadata is for
3736 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3737 used to alter the SQL query which gets the list of wanted pages.
3738 &$wantedPages: WantedPagesPage object
3739 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3741 'WatchArticle': Before a watch is added to an article.
3742 &$user: user that will watch
3743 &$page: WikiPage object to be watched
3744 &$status: Status object to be returned if the hook returns false
3746 'WatchArticleComplete': After a watch is added to an article.
3747 &$user: user that watched
3748 &$page: WikiPage object watched
3750 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3751 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3752 $watchedItemQueryService: Service object
3754 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3755 form, used to manipulate the list of pages or preload data based on that list.
3756 &$watchlistInfo: array of watchlisted pages in
3757 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3759 'WatchlistEditorBuildRemoveLine': when building remove lines in
3760 Special:Watchlist/edit.
3761 &$tools: array of extra links
3762 $title: Title object
3763 $redirect: whether the page is a redirect
3765 &$link: HTML link to title
3767 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3769 $router: The PathRouter instance
3771 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3772 Return false to prevent setting of the cookie.
3773 &$name: Cookie name passed to WebResponse::setcookie()
3774 &$value: Cookie value passed to WebResponse::setcookie()
3775 &$expire: Cookie expiration, as for PHP's setcookie()
3776 &$options: Options passed to WebResponse::setcookie()
3778 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3779 run a MediaWiki cli script.
3780 &$script: MediaWiki cli script path
3781 &$parameters: Array of arguments and options to the script
3782 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3785 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3786 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3787 &$qp: The list of QueryPages
3789 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3790 $row: The DB row of the entry.
3791 $title: The Title of the page where the link comes FROM
3792 $target: The Title of the page where the link goes TO
3793 &$props: Array of HTML strings to display after the title.
3795 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3796 dumps. One, and only one hook should set this, and return false.
3797 &$tables: Database tables to use in the SELECT query
3798 &$opts: Options to use for the query
3799 &$join: Join conditions
3801 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3802 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3803 specific to a content model should be provided by the respective Content's
3804 getDeletionUpdates() method.
3806 $content: the Content to generate updates for (or null, if the Content could not be loaded
3808 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3810 'WikiPageFactory': Override WikiPage class used for a title
3811 $title: Title of the page
3812 &$page: Variable to set the created WikiPage to.
3814 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3815 extra metadata to be added.
3816 $obj: The XmlDumpWriter object.
3817 &$out: The output string.
3818 $row: The database row for the page.
3819 $title: The title of the page.
3821 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3823 &$obj: The XmlDumpWriter object.
3824 &$out: The text being output.
3825 $row: The database row for the revision.
3826 $text: The revision text.
3828 More hooks might be available but undocumented, you can execute
3829 "php maintenance/findHooks.php" to find hidden ones.