Update docs/hooks.txt for ShowSearchHitTitle
[mediawiki.git] / docs / hooks.txt
blob803c20da666459a0fda7d97d8410123d654fffbb
1 hooks.txt
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.
6 ==Glossary==
8 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'.
16 hook
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.
20 hook function
21      The function part of a hook.
23 ==Rationale==
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 );
42                 }
44                 if ( $wgCapitalizeTitle ) {
45                         wfCapitalizeTitle( $article );
46                 }
48                 # code to actually show the article goes here
49         }
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 );
60                 }
62                 if ( $wgCapitalizeTitle ) {
63                         wfCapitalizeTitle( $article );
64                 }
66                 # code to actually show the article goes here
68                 if ( $wgNotifyArticle ) {
69                         wfNotifyArticleShow( $article );
70                 }
71         }
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 ) );
83                 }
84         }
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
94 file:
96         function reverseArticleTitle( $article ) {
97                 # ...
98         }
100         function reverseForExport( $article ) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
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
126 just leave it out.
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.
131 ==Writing hooks==
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:
154         # function, no data
155         someFunction( $param1, $param2 )
156         # function with data
157         someFunction( $someData, $param1, $param2 )
159         # object only
160         $object->onEventName( $param1, $param2 )
161         # object with method
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
186            function should skip
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 ) {
195                 # log user into LDAP
196                 return false;
197         }
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.
206 ==Using hooks==
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
211         class Article {
212                 # ...
213                 function protect() {
214                         global $wgUser;
215                         if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216                                 # protect the article
217                                 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
218                         }
219                 }
220         }
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
234 MediaWiki 1.4rc1.
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
244 account.
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
268   before 1.18)
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
275   (added in 1.23)
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
280 notification
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
322   ImageGalleryBase)
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
332 preview HTML.
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
342 in the regular way.
343 $headers: Associative array of headers for the email
344 $to: MailAddress object or array
345 $from: From address
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
360 $user: Current user
361 &$message: API message to die with. Specific values accepted depend on the
362  MediaWiki version:
363  * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
364    pass to ApiBase::dieWithError().
365  * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
366  * Earlier: A key or key+parameters in ApiBase::$messageMap.
368 'APIEditBeforeSave': DEPRECATED! Use EditFilterMergedContent instead.
369 Before saving a page with api.php?action=edit, after
370 processing request parameters. Return false to let the request fail, returning
371 an error message or an <edit result="Failure"> tag if $resultArr was filled.
372 Unlike for example 'EditFilterMergedContent' this also being run on undo.
373 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
374 for the API and it's recommended to use it instead of this hook.
375 $editPage: the EditPage object
376 $text: the text passed to the API. Note that this includes only the single
377   section for section edit, and is not necessarily the final text in case of
378   automatically resolved edit conflicts.
379 &$resultArr: data in this array will be added to the API result
381 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
382 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
383 this hook may cancel the hook to signal that the item is not viewable in the
384 provided context.
385 $row: A row of data from ContribsPager.  The set of data returned by
386   ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
387   hook.
388 $context: An IContextSource implementation.
389 &$feedItem: Set this to a FeedItem instance if the callback can handle the
390   provided row. This is provided to the hook as a null, if it is non null then
391   another callback has already handled the hook.
393 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
394 highlighting, add output to $context->getOutput() and return false.
395 $context: An IContextSource.
396 $text: Text to be highlighted.
397 $mime: MIME type of $text.
398 $format: API format code for $text.
400 'APIGetAllowedParams': Use this hook to modify a module's parameters.
401 &$module: ApiBase Module object
402 &$params: Array of parameters
403 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
405 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
406 Use this hook to modify a module's description.
407 &$module: ApiBase Module object
408 &$desc: String description, or array of description strings
410 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
411 $module: ApiBase Module object
412 &$msg: Array of Message objects
414 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
415 instead.
416 Use this hook to modify a module's parameter descriptions.
417 &$module: ApiBase Module object
418 &$desc: Array of parameter descriptions
420 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
421 descriptions.
422 $module: ApiBase Module object
423 &$msg: Array of arrays of Message objects
425 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
426 $module: ApiBase Module object
427 &$help: Array of HTML strings to be joined for the output.
428 $options: Array Options passed to ApiHelp::getHelp
429 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
430   the page and values as for Linker::generateTOC().
432 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
433 module manager. Can be used to conditionally register API modules.
434 $moduleManager: ApiModuleManager Module manager instance
436 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
437 an exception is thrown during API action execution.
438 $apiMain: Calling ApiMain instance.
439 $e: Exception object.
441 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
442 extensions to adjust the ParserOptions before parsing.
443 $options: ParserOptions object
444 $title: Title to be parsed
445 $params: Parameter array for the API module
446 $module: API module (which is also a ContextSource)
447 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
448 &$suppressCache: Set true if cache should be suppressed.
450 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
451 can alter or append to the array.
452 &$results: array with integer keys to associative arrays. Keys in associative
453   array:
454     - title: Title object.
455     - redirect from: Title or null.
456     - extract: Description for this result.
457     - extract trimmed: If truthy, the extract will not be trimmed to
458       $wgOpenSearchDescriptionLength.
459     - image: Thumbnail for this result. Value is an array with subkeys 'source'
460       (url), 'width', 'height', 'alt', 'align'.
461     - url: Url for the given title.
463 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
464 module manager. Can be used to conditionally register API query modules.
465 $moduleManager: ApiModuleManager Module manager instance
467 'APIQueryAfterExecute': After calling the execute() method of an
468 action=query submodule. Use this to extend core API modules.
469 &$module: Module object
471 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
472 database query has returned. An API query module wanting to use this hook
473 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
474 documentation.
475 $module: ApiQueryBase module in question
476 $result: ResultWrapper|bool returned from the IDatabase::select()
477 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
478  will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
479  communication.
481 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
482 database query is made. WARNING: It would be very easy to misuse this hook and
483 break the module! Any joins added *must* join on a unique key of the target
484 table unless you really know what you're doing. An API query module wanting to
485 use this hook should see the ApiQueryBase::select() and
486 ApiQueryBase::processRow() documentation.
487 $module: ApiQueryBase module in question
488 &$tables: array of tables to be queried
489 &$fields: array of columns to select
490 &$conds: array of WHERE conditionals for query
491 &$query_options: array of options for the database request
492 &$join_conds: join conditions for the tables
493 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
494  'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
496 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
497 the database result is processed. Return false to stop processing the result
498 set. An API query module wanting to use this hook should see the
499 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
500 $module: ApiQueryBase module in question
501 $row: stdClass Database result row
502 &$data: array to be included in the ApiResult.
503 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
504  'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
506 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
507 an action=query submodule. Use this to extend core API modules.
508 &$module: Module object
509 &$resultPageSet: ApiPageSet object
511 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
512 Use this hook to add custom tokens to prop=info. Every token has an action,
513 which will be used in the intoken parameter and in the output
514 (actiontoken="..."), and a callback function which should return the token, or
515 false if the user isn't allowed to obtain it. The prototype of the callback
516 function is func($pageid, $title), where $pageid is the page ID of the page the
517 token is requested for and $title is the associated Title object. In the hook,
518 just add your callback to the $tokenFunctions array and return true (returning
519 false makes no sense).
520 &$tokenFunctions: array(action => callback)
522 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
523 instead.
524 Use this hook to add custom tokens to list=recentchanges. Every token has an
525 action, which will be used in the rctoken parameter and in the output
526 (actiontoken="..."), and a callback function which should return the token, or
527 false if the user isn't allowed to obtain it. The prototype of the callback
528 function is func($pageid, $title, $rc), where $pageid is the page ID of the
529 page associated to the revision the token is requested for, $title the
530 associated Title object and $rc the associated RecentChange object. In the
531 hook, just add your callback to the $tokenFunctions array and return true
532 (returning false makes no sense).
533 &$tokenFunctions: array(action => callback)
535 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
536 Use this hook to add custom tokens to prop=revisions. Every token has an
537 action, which will be used in the rvtoken parameter and in the output
538 (actiontoken="..."), and a callback function which should return the token, or
539 false if the user isn't allowed to obtain it. The prototype of the callback
540 function is func($pageid, $title, $rev), where $pageid is the page ID of the
541 page associated to the revision the token is requested for, $title the
542 associated Title object and $rev the associated Revision object. In the hook,
543 just add your callback to the $tokenFunctions array and return true (returning
544 false makes no sense).
545 &$tokenFunctions: array(action => callback)
547 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
548 sites general information.
549 $module: the current ApiQuerySiteInfo module
550 &$results: array of results, add things here
552 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
553 sites statistics information.
554 &$results: array of results, add things here
556 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
557 action=query&meta=tokens. Note that most modules will probably be able to use
558 the 'csrf' token instead of creating their own token types.
559 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
560   and key to pass to Session::getToken() )
562 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
563 Use this hook to add custom token to list=users. Every token has an action,
564 which will be used in the ustoken parameter and in the output
565 (actiontoken="..."), and a callback function which should return the token, or
566 false if the user isn't allowed to obtain it. The prototype of the callback
567 function is func($user) where $user is the User object. In the hook, just add
568 your callback to the $tokenFunctions array and return true (returning false
569 makes no sense).
570 &$tokenFunctions: array(action => callback)
572 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
573 $module: ApiQueryWatchlist instance
574 $watchedItem: WatchedItem instance
575 $recentChangeInfo: Array of recent change info data
576 &$vals: Associative array of data to be output for the row
578 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
579 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
580 $module: ApiQueryWatchlist instance
581 $params: Array of parameters, as would be returned by $module->extractRequestParams()
582 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
584 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
585 should have its own entry in the $apis array and have a unique name, passed as
586 key for the array that represents the service data. In this data array, the
587 key-value-pair identified by the apiLink key is required.
588 &$apis: array of services
590 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
591 Use this hook to extend action=tokens with new token types.
592 &$tokenTypes: supported token types in format 'type' => callback function
593   used to retrieve this type of tokens.
595 'ApiValidatePassword': Called from ApiValidatePassword.
596 $module: ApiValidatePassword instance.
597 &$r: Result array.
599 'Article::MissingArticleConditions': Before fetching deletion & move log entries
600 to display a message of a non-existing page being deleted/moved, give extensions
601 a chance to hide their (unrelated) log entries.
602 &$conds: Array of query conditions (all of which have to be met; conditions will
603   AND in the final query)
604 $logTypes: Array of log types being queried
606 'ArticleAfterFetchContentObject': After fetching content of an article from the
607 database.
608 &$article: the article (object) being loaded from the database
609 &$content: the content of the article, as a Content object
611 'ArticleConfirmDelete': Before writing the confirmation form for article
612 deletion.
613 $article: the article (object) being deleted
614 $output: the OutputPage object
615 &$reason: the reason (string) the article is being deleted
617 'ArticleContentOnDiff': Before showing the article content below a diff. Use
618 this to change the content in this area or how it is loaded.
619 $diffEngine: the DifferenceEngine
620 $output: the OutputPage object
622 'ArticleContentViewCustom': Allows to output the text of the article in a
623 different format than wikitext. Note that it is preferable to implement proper
624 handing for a custom data type using the ContentHandler facility.
625 $content: content of the page, as a Content object
626 $title: title of the page
627 $output: reference to $wgOut
629 'ArticleDelete': Before an article is deleted.
630 &$wikiPage: the WikiPage (object) being deleted
631 &$user: the user (object) deleting the article
632 &$reason: the reason (string) the article is being deleted
633 &$error: if the deletion was prohibited, the (raw HTML) error message to display
634   (added in 1.13)
635 &$status: Status object, modify this to throw an error. Overridden by $error
636   (added in 1.20)
637 $suppress: Whether this is a suppression deletion or not (added in 1.27)
639 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
640 $title: Title of the article that has been deleted.
641 $outputPage: OutputPage that can be used to append the output.
643 'ArticleDeleteComplete': After an article is deleted.
644 &$wikiPage: the WikiPage that was deleted
645 &$user: the user that deleted the article
646 $reason: the reason the article was deleted
647 $id: id of the article that was deleted
648 $content: the Content of the deleted page (or null, when deleting a broken page)
649 $logEntry: the ManualLogEntry used to record the deletion
650 $archivedRevisionCount: the number of revisions archived during the deletion
652 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
653 was changed.
654 &$wikiPage: WikiPage (object) of the user talk page
655 $recipient: User (object) who's talk page was edited
657 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
658 article has been changed.
659 &$wikiPage: the WikiPage (object)
660 &$editInfo: data holder that includes the parser output ($editInfo->output) for
661   that page after the change
662 $changed: bool for if the page was changed
664 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
665 recentchanges table, return false to not delete old entries.
666 &$wikiPage: WikiPage (object) being modified
668 'ArticleFromTitle': when creating an article object from a title object using
669 Wiki::articleFromTitle().
670 &$title: Title (object) used to create the article object
671 &$article: Article (object) that will be returned
672 $context: IContextSource (object)
674 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
675 $targetTitle: target title (object)
676 $destTitle: destination title (object)
678 'ArticlePageDataAfter': After loading data of an article from the database.
679 &$wikiPage: WikiPage (object) whose data were loaded
680 &$row: row (object) returned from the database server
682 'ArticlePageDataBefore': Before loading data of an article from the database.
683 &$wikiPage: WikiPage (object) that data will be loaded
684 &$fields: fields (array) to load from the database
686 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
687 $wikiPage: the WikiPage being saved
688 $popts: parser options to be used for pre-save transformation
690 'ArticleProtect': Before an article is protected.
691 &$wikiPage: the WikiPage being protected
692 &$user: the user doing the protection
693 $protect: Set of restriction keys
694 $reason: Reason for protect
696 'ArticleProtectComplete': After an article is protected.
697 &$wikiPage: the WikiPage that was protected
698 &$user: the user who did the protection
699 $protect: Set of restriction keys
700 $reason: Reason for protect
702 'ArticlePurge': Before executing "&action=purge".
703 &$wikiPage: WikiPage (object) to purge
705 'ArticleRevisionUndeleted': After an article revision is restored.
706 &$title: the article title
707 $revision: the revision
708 $oldPageID: the page ID of the revision when archived (may be null)
710 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
711 revisions of an article.
712 $title: Title object of the article
713 $ids: Ids to set the visibility for
714 $visibilityChangeMap: Map of revision id to oldBits and newBits.  This array can be
715   examined to determine exactly what visibility bits have changed for each
716   revision.  This array is of the form
717   [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
719 'ArticleRollbackComplete': After an article rollback is completed.
720 $wikiPage: the WikiPage that was edited
721 $user: the user who did the rollback
722 $revision: the revision the page was reverted back to
723 $current: the reverted revision
725 'ArticleUndelete': When one or more revisions of an article are restored.
726 &$title: Title corresponding to the article restored
727 $create: Whether or not the restoration caused the page to be created (i.e. it
728   didn't exist before).
729 $comment: The comment associated with the undeletion.
730 $oldPageId: ID of page previously deleted (from archive table)
732 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
733 $pageArchive: the PageArchive object
734 &$logEntry: ManualLogEntry object
735 $user: User who is performing the log action
737 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
738 the user is redirected back to the page.
739 $article: the article
740 &$sectionanchor: The section anchor link (e.g. "#overview" )
741 &$extraq: Extra query parameters which can be added via hooked functions
743 'ArticleViewFooter': After showing the footer section of an ordinary page view
744 $article: Article object
745 $patrolFooterShown: boolean whether patrol footer is shown
747 'ArticleViewHeader': Before the parser cache is about to be tried for article
748 viewing.
749 &$article: the article
750 &$pcache: whether to try the parser cache or not
751 &$outputDone: whether the output for this page finished or not. Set to
752   a ParserOutput object to both indicate that the output is done and what
753   parser output was used.
755 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
756 redirect was followed.
757 &$article: target article (object)
759 'AuthChangeFormFields': After converting a field information array obtained
760 from a set of AuthenticationRequest classes into a form descriptor; hooks
761 can tweak the array to change how login etc. forms should look.
762 $requests: array of AuthenticationRequests the fields are created from
763 $fieldInfo: field information array (union of all AuthenticationRequest::getFieldInfo() responses).
764 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
765   to change the order of the fields.
766 $action: one of the AuthManager::ACTION_* constants.
768 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
769 for a reason other than misconfiguration or session loss. No return data is
770 accepted; this hook is for auditing only.
771 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
772 $user: The User object being authenticated against, or null if authentication
773   failed before getting that far.
774 $username: A guess at the user name being authenticated, or null if we can't
775   even determine that.
777 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
778 Called when creating a local account for an user logged in from an external
779 authentication method.
780 $user: User object created locally
782 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
783 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
784 extension to set it programmatically to a variable class.
785 &$auth: the $wgAuth object, probably a stub
787 'AutopromoteCondition': Check autopromote condition for user.
788 $type: condition type
789 $args: arguments
790 $user: user
791 &$result: result of checking autopromote condition
793 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
794 certain title are fetched.
795 $table: table name
796 $title: title of the page to which backlinks are sought
797 &$conds: query conditions
799 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
800 $table: table name
801 &$prefix: prefix
803 'BadImage': When checking against the bad image list. Change $bad and return
804 false to override. If an image is "bad", it is not rendered inline in wiki
805 pages or galleries in category pages.
806 $name: Image name being checked
807 &$bad: Whether or not the image is "bad"
809 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
810 custom HTML after the section. Any uses of the hook need to handle escaping.
811 $template: BaseTemplate
812 $portlet: string portlet name
813 &$html: string
815 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
816 and returning it for the skin to output. You can add items to the toolbox while
817 still letting the skin make final decisions on skin-specific markup conventions
818 using this hook.
819 &$sk: The BaseTemplate base skin template
820 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
821   BaseTemplate::makeListItem for details on the format of individual items
822   inside of this array.
824 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
825 "noarticletext-nopermission" at Article::showMissingArticle().
826 $article: article object
828 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
829 override how the redirect is output by modifying, or by returning false, and
830 letting standard HTTP rendering take place.
831 ATTENTION: This hook is likely to be removed soon due to overall design of the
832 system.
833 $context: IContextSource object
834 &$redirect: string URL, modifiable
836 'BeforeInitialize': Before anything is initialized in
837 MediaWiki::performRequest().
838 &$title: Title being used for request
839 &$unused: null
840 &$output: OutputPage object
841 &$user: User
842 $request: WebRequest object
843 $mediaWiki: Mediawiki object
845 'BeforePageDisplay': Prior to outputting a page.
846 &$out: OutputPage object
847 &$skin: Skin object
849 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
850 override how the redirect is output by modifying, or by returning false and
851 taking over the output.
852 $out: OutputPage object
853 &$redirect: URL, modifiable
854 &$code: HTTP code (eg '301' or '302'), modifiable
856 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
857 $parser: Parser object
858 $nt: the image title
859 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
860   as a key then the file will appear as a broken thumbnail.
861 &$descQuery: query string to add to thumbnail URL
863 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
864 $parser: Parser object
865 $title: title of the template
866 &$skip: skip this template and link it?
867 &$id: the id of the revision being parsed
869 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
870 &$parser: Parser object
871 &$ig: ImageGallery object
873 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
874 newly created user.
875 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
876   to a newly created user account.
877 &$injected_html: Any HTML to inject after the "logged in" message of a newly
878   created user account
880 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
881 normalizations have been performed, except for the $wgMaxImageArea check.
882 $image: File
883 &$params: Array of parameters
884 &$checkImageAreaHookResult: null, set to true or false to override the
885   $wgMaxImageArea check result.
887 'BitmapHandlerTransform': before a file is transformed, gives extension the
888 possibility to transform it themselves
889 $handler: BitmapHandler
890 $image: File
891 &$scalerParams: Array with scaler parameters
892 &$mto: null, set to a MediaTransformOutput
894 'BlockIp': Before an IP address or user is blocked.
895 &$block: the Block object about to be saved
896 &$user: the user _doing_ the block (not the one being blocked)
897 &$reason: if the hook is aborted, the error message to be returned in an array
899 'BlockIpComplete': After an IP address or user is blocked.
900 $block: the Block object that was saved
901 $user: the user who did the block (not the one being blocked)
902 $priorBlock: the Block object for the prior block or null if there was none
904 'BookInformation': Before information output on Special:Booksources.
905 $isbn: ISBN to show information for
906 $output: OutputPage object in use
908 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
909 to be able to access the wiki via HTTPS.
910 $ip: The IP address in human-readable form
911 &$canDo: This reference should be set to false if the client may not be able
912   to use HTTPS
914 'CanonicalNamespaces': For extensions adding their own namespaces or altering
915 the defaults.
916 Note that if you need to specify namespace protection or content model for
917 a namespace that is added in a CanonicalNamespaces hook handler, you
918 should do so by altering $wgNamespaceProtection and
919 $wgNamespaceContentModels outside the handler, in top-level scope. The
920 point at which the CanonicalNamespaces hook fires is too late for altering
921 these variables. This applies even if the namespace addition is
922 conditional; it is permissible to declare a content model and protection
923 for a namespace and then decline to actually register it.
924 &$namespaces: Array of namespace numbers with corresponding canonical names
926 'CategoryAfterPageAdded': After a page is added to a category.
927 $category: Category that page was added to
928 $wikiPage: WikiPage that was added
930 'CategoryAfterPageRemoved': After a page is removed from a category.
931 $category: Category that page was removed from
932 $wikiPage: WikiPage that was removed
933 $id: the page ID (original ID in case of page deletions)
935 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
936 &$catpage: CategoryPage instance
938 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
939 in a Category page. Gives extensions the opportunity to batch load any
940 related data about the pages.
941 $type: The category type. Either 'page', 'file' or 'subcat'
942 $res: Query result from DatabaseBase::select()
944 'CategoryViewer::generateLink': Before generating an output link allow
945 extensions opportunity to generate a more specific or relevant link.
946 $type: The category type. Either 'page', 'img' or 'subcat'
947 $title: Title object for the categorized page
948 $html: Requested html content of anchor
949 &$link: Returned value. When set to a non-null value by a hook subscriber
950   this value will be used as the anchor instead of Linker::link
952 'ChangeAuthenticationDataAudit': Called when user changes his password.
953 No return data is accepted; this hook is for auditing only.
954 $req: AuthenticationRequest object describing the change (and target user)
955 $status: StatusValue with the result of the action
957 'ChangePasswordForm': DEPRECATED! Use AuthChangeFormFields or security levels.
958 For extensions that need to add a field to the ChangePassword form via the
959 Preferences form.
960 &$extraFields: An array of arrays that hold fields like would be passed to the
961   pretty function.
963 'ChangesListInitRows': Batch process change list rows prior to rendering.
964 $changesList: ChangesList instance
965 $rows: The data that will be rendered. May be a ResultWrapper instance or
966   an array.
968 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
969 &$changesList: ChangesList instance.
970 &$articlelink: HTML of link to article (already filled-in).
971 &$s: HTML of row that is being constructed.
972 &$rc: RecentChange instance.
973 $unpatrolled: Whether or not we are showing unpatrolled changes.
974 $watched: Whether or not the change is watched by the user.
976 'ChangesListSpecialPageFilters': Called after building form options on pages
977 inheriting from ChangesListSpecialPage (in core: RecentChanges,
978 RecentChangesLinked and Watchlist).
979 $special: ChangesListSpecialPage instance
980 &$filters: associative array of filter definitions. The keys are the HTML
981   name/URL parameters. Each key maps to an associative array with a 'msg'
982   (message key) and a 'default' value.
984 'ChangesListSpecialPageQuery': Called when building SQL query on pages
985 inheriting from ChangesListSpecialPage (in core: RecentChanges,
986 RecentChangesLinked and Watchlist).
987 $name: name of the special page, e.g. 'Watchlist'
988 &$tables: array of tables to be queried
989 &$fields: array of columns to select
990 &$conds: array of WHERE conditionals for query
991 &$query_options: array of options for the database request
992 &$join_conds: join conditions for the tables
993 $opts: FormOptions for this request
995 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
996 removed from all revisions and log entries to which it was applied). This gives
997 extensions a chance to take it off their books.
998 $tag: name of the tag
999 &$status: Status object. Add warnings to this as required. There is no point
1000   setting errors, as the deletion has already been partly carried out by this
1001   point.
1003 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1004 from the UI (Special:Tags) or via the API. You could use this hook if you want
1005 to reserve a specific "namespace" of tags, or something similar.
1006 $tag: name of the tag
1007 $user: user initiating the action
1008 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1009   using `$status->warning()`. Errors and warnings will be relayed to the user.
1010   If you set an error, the user will be unable to create the tag.
1012 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1013 deleted from the UI (Special:Tags) or via the API. The default is that tags
1014 defined using the ListDefinedTags hook are not allowed to be deleted unless
1015 specifically allowed. If you wish to allow deletion of the tag, set
1016 `$status = Status::newGood()` to allow deletion, and then `return false` from
1017 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1018 out custom deletion actions.
1019 $tag: name of the tag
1020 $user: user initiating the action
1021 &$status: Status object. See above.
1023 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1024 uses are in active use.
1025 &$tags: list of all active tags. Append to this array.
1027 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1028 ChangeTags::updateTags function. Params:
1029 $addedTags: tags effectively added in the update
1030 $removedTags: tags effectively removed in the update
1031 $prevTags: tags that were present prior to the update
1032 $rc_id: recentchanges table id
1033 $rev_id: revision table id
1034 $log_id: logging table id
1035 $params: tag params
1036 $rc: RecentChange being tagged when the tagging accompanies the action or null
1037 $user: User who performed the tagging when the tagging is subsequent to the action or null
1039 'ChangeUserGroups': Called before user groups are changed.
1040 $performer: The User who will perform the change
1041 $user: The User whose groups will be changed
1042 &$add: The groups that will be added
1043 &$remove: The groups that will be removed
1045 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1046 $collationName: Name of the collation in question
1047 &$collationObject: Null. Replace with a subclass of the Collation class that
1048   implements the collation given in $collationName.
1050 'ConfirmEmailComplete': Called after a user's email has been confirmed
1051 successfully.
1052 $user: user (object) whose email is being confirmed
1054 'ContentAlterParserOutput': Modify parser output for a given content object.
1055 Called by Content::getParserOutput after parsing has finished. Can be used
1056 for changes that depend on the result of the parsing but have to be done
1057 before LinksUpdate is called (such as adding tracking categories based on
1058 the rendered HTML).
1059 $content: The Content to render
1060 $title: Title of the page, as context
1061 $parserOutput: ParserOutput to manipulate
1063 'ContentGetParserOutput': Customize parser output for a given content object,
1064 called by AbstractContent::getParserOutput. May be used to override the normal
1065 model-specific rendering of page content.
1066 $content: The Content to render
1067 $title: Title of the page, as context
1068 $revId: The revision ID, as context
1069 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1070   the output can only depend on parameters provided to this hook function, not
1071   on global state.
1072 $generateHtml: boolean, indicating whether full HTML should be generated. If
1073   false, generation of HTML may be skipped, but other information should still
1074   be present in the ParserOutput object.
1075 &$output: ParserOutput, to manipulate or replace
1077 'ContentHandlerDefaultModelFor': Called when the default content model is
1078 determined for a given title. May be used to assign a different model for that
1079 title.
1080 $title: the Title in question
1081 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1083 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1084 a given content model name, but no entry for that model exists in
1085 $wgContentHandlers.
1086 $modeName: the requested content model name
1087 &$handler: set this to a ContentHandler object, if desired.
1089 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1090 be used on a given page. This is especially useful to prevent some content
1091 models to be used in some special location.
1092 $contentModel: ID of the content model in question
1093 $title: the Title in question.
1094 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1095   Handler functions that modify $ok should generally return false to prevent
1096   further hooks from further modifying $ok.
1098 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1099 &$pager: Pager object for contributions
1100 &$queryInfo: The query for the contribs Pager
1102 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1103 Contributions
1104 &$data: an array of results of all contribs queries
1105 $pager: The ContribsPager object hooked into
1106 $offset: Index offset, inclusive
1107 $limit: Exact query limit
1108 $descending: Query direction, false for ascending, true for descending
1110 'ContributionsLineEnding': Called before a contributions HTML line is finished
1111 $page: SpecialPage object for contributions
1112 &$ret: the HTML line
1113 $row: the DB row for this line
1114 &$classes: the classes to add to the surrounding <li>
1116 'ContributionsToolLinks': Change tool links above Special:Contributions
1117 $id: User identifier
1118 $title: User page title
1119 &$tools: Array of tool links
1120 $specialPage: SpecialPage instance for context and services. Can be either
1121   SpecialContributions or DeletedContributionsPage. Extensions should type
1122   hint against a generic SpecialPage though.
1124 'ConvertContent': Called by AbstractContent::convert when a conversion to
1125 another content model is requested.
1126 Handler functions that modify $result should generally return false to disable
1127 further attempts at conversion.
1128 $content: The Content object to be converted.
1129 $toModel: The ID of the content model to convert to.
1130 $lossy:   boolean indicating whether lossy conversion is allowed.
1131 &$result: Output parameter, in case the handler function wants to provide a
1132   converted Content object. Note that $result->getContentModel() must return
1133   $toModel.
1135 'CustomEditor': When invoking the page editor
1136 Return true to allow the normal editor to be used, or false if implementing
1137 a custom editor, e.g. for a special namespace, etc.
1138 $article: Article being edited
1139 $user: User performing the edit
1141 'DatabaseOraclePostInit': Called after initialising an Oracle database
1142 $db: the DatabaseOracle object
1144 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1145 for Special:DeletedContributions
1146 Similar to ContribsPager::reallyDoQuery
1147 &$data: an array of results of all contribs queries
1148 $pager: The DeletedContribsPager object hooked into
1149 $offset: Index offset, inclusive
1150 $limit: Exact query limit
1151 $descending: Query direction, false for ascending, true for descending
1153 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1154 is finished.
1155 Similar to ContributionsLineEnding
1156 $page: SpecialPage object for DeletedContributions
1157 &$ret: the HTML line
1158 $row: the DB row for this line
1159 &$classes: the classes to add to the surrounding <li>
1161 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1162 after the new revision's content has been loaded into the class member variable
1163 $differenceEngine->mNewContent but before returning true from this function.
1164 $differenceEngine: DifferenceEngine object
1166 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1167 DifferenceEngine::loadText() after the new revision's content has been loaded
1168 into the class member variable $differenceEngine->mNewContent but before
1169 checking if the variable's value is null.
1170 This hook can be used to inject content into said class member variable.
1171 $differenceEngine: DifferenceEngine object
1173 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1174 which is shown both on the diff header as well as on the bottom of a page, usually
1175 wrapped in a span element which has class="patrollink".
1176 $differenceEngine: DifferenceEngine object
1177 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1178 $rcid: Recent change ID (rc_id) for this change (int)
1180 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1181 For example the rcid might be set to zero due to the user being the same as the
1182 performer of the change but an extension might still want to show it under certain
1183 conditions.
1184 &$rcid: rc_id (int) of the change or 0
1185 $differenceEngine: DifferenceEngine object
1186 $change: RecentChange object
1187 $user: User object representing the current user
1189 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1190 contains information about the new revision, such as the revision's author, whether
1191 the revision was marked as a minor edit or not, etc.
1192 $differenceEngine: DifferenceEngine object
1193 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1194 include things like revision author info, revision comment, RevisionDelete link and more
1195 $formattedRevisionTools: Array containing revision tools, some of which may have
1196 been injected with the DiffRevisionTools hook
1197 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1198 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1199 $newminor: String indicating if the new revision was marked as a minor edit
1200 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1201 whether we should show just the diff; passed in as a query string parameter to the
1202 various URLs constructed here (i.e. $nextlink)
1203 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1204 to use the RevisionDelete feature
1205 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1207 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1208 contains information about the old revision, such as the revision's author, whether
1209 the revision was marked as a minor edit or not, etc.
1210 $differenceEngine: DifferenceEngine object
1211 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1212 include things like revision author info, revision comment, RevisionDelete link and more
1213 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1214 $oldminor: String indicating if the old revision was marked as a minor edit
1215 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1216 whether we should show just the diff; passed in as a query string parameter to the
1217 various URLs constructed here (i.e. $prevlink)
1218 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1219 to use the RevisionDelete feature
1220 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1222 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1223 there is no old revision
1224 &$oldHeader: empty string by default
1226 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1227 Return false to not add parser output via OutputPage's addParserOutput method.
1228 $differenceEngine: DifferenceEngine object
1229 $out: OutputPage object
1230 $parserOutput: ParserOutput object
1231 $wikiPage: WikiPage object
1233 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1234 point and return false to not show the final "mark as patrolled" link on the bottom
1235 of a page.
1236 This hook has no arguments.
1238 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1239 eventually gets sent to the OutputPage object.
1240 $differenceEngine: DifferenceEngine object
1242 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1243 body (without header) in cases when there is no old revision or the old and new
1244 revisions are identical.
1245 $differenceEngine: DifferenceEngine object
1247 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1248 object into the diff view
1249 $out: OutputPage object
1251 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1252 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1253 Return false in order to prevent displaying the missing revision message
1254 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1255 $differenceEngine: DifferenceEngine object
1257 'DiffRevisionTools': Override or extend the revision tools available from the
1258 diff view, i.e. undo, etc.
1259 $newRev: Revision object of the "new" revision
1260 &$links: Array of HTML links
1261 $oldRev: Revision object of the "old" revision (may be null)
1262 $user: Current user object
1264 'DiffViewHeader': Called before diff display
1265 $diff: DifferenceEngine object that's calling
1266 $oldRev: Revision object of the "old" revision (may be null/invalid)
1267 $newRev: Revision object of the "new" revision
1269 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1270 an article
1271 &$article: article (object) being viewed
1272 &$oldid: oldid (int) being viewed
1274 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1275 Override the HTML generated for section edit links
1276 $skin: Skin object rendering the UI
1277 $title: Title object for the title being linked to (may not be the same as
1278   the page title, if the section is included from a template)
1279 $section: The designation of the section being pointed to, to be included in
1280   the link, like "&section=$section"
1281 $tooltip: The default tooltip.  Escape before using.
1282   By default, this is wrapped in the 'editsectionhint' message.
1283 &$result: The HTML to return, prefilled with the default plus whatever other
1284   changes earlier hooks have made
1285 $lang: The language code to use for the link in the wfMessage function
1287 'EditFilter': Perform checks on an edit
1288 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1289 $text: Contents of the edit box
1290 $section: Section being edited
1291 &$error: Error message to return
1292 $summary: Edit summary for page
1295 'EditFilterMergedContent': Post-section-merge edit filter.
1296 This may be triggered by the EditPage or any other facility that modifies page
1297 content. Use the $status object to indicate whether the edit should be allowed,
1298 and to provide a reason for disallowing it. Return false to abort the edit, and
1299 true to continue. Returning true if $status->isOK() returns false means "don't
1300 save but continue user interaction", e.g. show the edit form.
1301 $status->apiHookResult can be set to an array to be returned by api.php
1302 action=edit. This is used to deliver captchas.
1303 $context: object implementing the IContextSource interface.
1304 $content: content of the edit box, as a Content object.
1305 $status: Status object to represent errors, etc.
1306 $summary: Edit summary for page
1307 $user: the User object representing the user whois performing the edit.
1308 $minoredit: whether the edit was marked as minor by the user.
1310 'EditFormInitialText': Allows modifying the edit form when editing existing
1311 pages
1312 $editPage: EditPage object
1314 'EditFormPreloadText': Allows population of the edit form when creating
1315 new pages
1316 &$text: Text to preload with
1317 &$title: Title object representing the page being created
1319 'EditPage::attemptSave': Called before an article is
1320 saved, that is before WikiPage::doEditContent() is called
1321 $editpage_Obj: the current EditPage object
1323 'EditPage::attemptSave:after': Called after an article save attempt
1324 $editpage_Obj: the current EditPage object
1325 $status: the resulting Status object
1326 $resultDetails: Result details array
1328 'EditPage::importFormData': allow extensions to read additional data
1329 posted in the form
1330 $editpage: EditPage instance
1331 $request: Webrequest
1332 return value is ignored (should always return true)
1334 'EditPage::showEditForm:fields': allows injection of form field into edit form
1335 Return value is ignored (should always return true)
1336 &$editor: the EditPage instance for reference
1337 &$out: an OutputPage instance to write to
1339 'EditPage::showEditForm:initial': before showing the edit form
1340 Return false to halt editing; you'll need to handle error messages, etc.
1341 yourself. Alternatively, modifying $error and returning true will cause the
1342 contents of $error to be echoed at the top of the edit form as wikitext.
1343 Return true without altering $error to allow the edit to proceed.
1344 &$editor: EditPage instance (object)
1345 &$out: an OutputPage instance to write to
1347 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1348 but for the read-only 'view source' variant of the edit form.
1349 Return value is ignored (should always return true)
1350 $editor: EditPage instance (object)
1351 &$out: an OutputPage instance to write to
1353 'EditPage::showStandardInputs:options': allows injection of form fields into
1354 the editOptions area
1355 Return value is ignored (should always be true)
1356 $editor: EditPage instance (object)
1357 $out: an OutputPage instance to write to
1358 &$tabindex: HTML tabindex of the last edit check/button
1360 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1361 when there's an edit conflict.  Return false to halt normal diff output; in
1362 this case you're responsible for computing and outputting the entire "conflict"
1363 part, i.e., the "difference between revisions" and "your text" headers and
1364 sections.
1365 &$editor: EditPage instance
1366 &$out: OutputPage instance
1368 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1369 textarea in the edit form.
1370 &$editpage: The current EditPage object
1371 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1372 &$tabindex: HTML tabindex of the last edit check/button
1374 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1375 in the edit form.
1376 &$editpage: The current EditPage object
1377 &$checks: Array of edit checks like "watch this page"/"minor edit"
1378 &$tabindex: HTML tabindex of the last edit check/button
1380 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1381 textarea in the edit form.
1382 &$toolbar: The toolbar HTMl
1384 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1385 contribution/copyright notice.
1386 $title: title of page being edited
1387 &$msg: localization message name, overridable. Default is either
1388   'copyrightwarning' or 'copyrightwarning2'.
1390 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1391 "Show changes". Note that it is preferable to implement diff handling for
1392 different data types using the ContentHandler facility.
1393 $editPage: EditPage object
1394 &$newtext: wikitext that will be used as "your version"
1396 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1397 previewed. Note that it is preferable to implement previews for different data
1398 types using the ContentHandler facility.
1399 $editPage: EditPage object
1400 &$content: Content object to be previewed (may be replaced by hook function)
1402 'EditPageNoSuchSection': When a section edit request is given for an
1403 non-existent section
1404 &$editpage: The current EditPage object
1405 &$res: the HTML of the error text
1407 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1408 of terms of service summary link that might exist separately from the copyright
1409 notice.
1410 $title: title of page being edited
1411 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1413 'EmailConfirmed': When checking that the user's email address is "confirmed".
1414 This runs before the other checks, such as anonymity and the real check; return
1415 true to allow those checks to occur, and false if checking is done.
1416 &$user: User being checked
1417 &$confirmed: Whether or not the email address is confirmed
1419 'EmailUser': Before sending email from one user to another.
1420 &$to: MailAddress object of receiving user
1421 &$from: MailAddress object of sending user
1422 &$subject: subject of the mail
1423 &$text: text of the mail
1424 &$error: Out-param for an error. Should be set to a Status object or boolean false.
1426 'EmailUserCC': Before sending the copy of the email to the author.
1427 &$to: MailAddress object of receiving user
1428 &$from: MailAddress object of sending user
1429 &$subject: subject of the mail
1430 &$text: text of the mail
1432 'EmailUserComplete': After sending email from one user to another.
1433 $to: MailAddress object of receiving user
1434 $from: MailAddress object of sending user
1435 $subject: subject of the mail
1436 $text: text of the mail
1438 'EmailUserForm': After building the email user form object.
1439 &$form: HTMLForm object
1441 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1442 user.
1443 $user: The user who is trying to email another user.
1444 $editToken: The user's edit token.
1445 &$hookErr: Out-param for the error. Passed as the parameters to
1446   OutputPage::showErrorPage.
1448 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1449 group of changes in EnhancedChangesList.
1450 Hook subscribers can return false to omit this line from recentchanges.
1451 $changesList: EnhancedChangesList object
1452 &$links: The links that were generated by EnhancedChangesList
1453 $block: The RecentChanges objects in that block
1455 'EnhancedChangesListModifyLineData': to alter data used to build
1456 a grouped recent change inner line in EnhancedChangesList.
1457 Hook subscribers can return false to omit this line from recentchanges.
1458 $changesList: EnhancedChangesList object
1459 &$data: An array with all the components that will be joined in order to create the line
1460 $block: An array of RecentChange objects in that block
1461 $rc: The RecentChange object for this line
1462 &$classes: An array of classes to change
1464 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1465 a non-grouped recent change line in EnhancedChangesList.
1466 $changesList: EnhancedChangesList object
1467 &$data: An array with all the components that will be joined in order to create the line
1468 $rc: The RecentChange object for this line
1470 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1471 throttle.
1472 $ip: The ip address of the user
1474 'ExtensionTypes': Called when generating the extensions credits, use this to
1475 change the tables headers.
1476 &$extTypes: associative array of extensions types
1478 'ExtractThumbParameters': DEPRECATED! Media handler should override
1479 MediaHandler::parseParamString instead.
1480 Called when extracting thumbnail parameters from a thumbnail file name.
1481 $thumbname: the base name of the thumbnail file
1482 &$params: the currently extracted params (has source name, temp or archived
1483 zone)
1485 'FetchChangesList': When fetching the ChangesList derivative for a particular
1486 user.
1487 $user: User the list is being fetched for
1488 &$skin: Skin object to be used with the list
1489 &$list: List object (defaults to NULL, change it to an object instance and
1490   return false override the list derivative used)
1492 'FileDeleteComplete': When a file is deleted.
1493 &$file: reference to the deleted file
1494 &$oldimage: in case of the deletion of an old image, the name of the old file
1495 &$article: in case all revisions of the file are deleted a reference to the
1496   WikiFilePage associated with the file.
1497 &$user: user who performed the deletion
1498 &$reason: reason
1500 'FileTransformed': When a file is transformed and moved into storage.
1501 $file: reference to the File object
1502 $thumb: the MediaTransformOutput object
1503 $tmpThumbPath: The temporary file system path of the transformed file
1504 $thumbPath: The permanent storage path of the transformed file
1506 'FileUndeleteComplete': When a file is undeleted
1507 $title: title object to the file
1508 $fileVersions: array of undeleted versions. Empty if all versions were restored
1509 $user: user who performed the undeletion
1510 $reason: reason
1512 'FileUpload': When a file upload occurs.
1513 $file: Image object representing the file that was uploaded
1514 $reupload: Boolean indicating if there was a previously another image there or
1515   not (since 1.17)
1516 $hasDescription: Boolean indicating that there was already a description page
1517   and a new one from the comment wasn't created (since 1.17)
1519 'FormatAutocomments': When an autocomment is formatted by the Linker.
1520 &$comment: Reference to the accumulated comment. Initially null, when set the
1521   default code will be skipped.
1522 $pre: Boolean, true if there is text before this autocomment
1523 $auto: The extracted part of the parsed comment before the call to the hook.
1524 $post: Boolean, true if there is text after this autocomment
1525 $title: An optional title object used to links to sections. Can be null.
1526 $local: Boolean indicating whether section links should refer to local page.
1527 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1528   autocomment originated; null for the local wiki. Added in 1.26, should default
1529   to null in handler functions, for backwards compatibility.
1531 'GalleryGetModes': Get list of classes that can render different modes of a
1532 gallery.
1533 &$modeArray: An associative array mapping mode names to classes that implement
1534   that mode. It is expected all registered classes are a subclass of
1535   ImageGalleryBase.
1537 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1538 entitled to be in.
1539 $user: user to promote.
1540 &$promote: groups that will be added.
1542 'GetBlockedStatus': after loading blocking status of an user from the database
1543 &$user: user (object) being checked
1545 'GetCacheVaryCookies': Get cookies that should vary cache options.
1546 $out: OutputPage object
1547 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1548   that have to vary cache options
1550 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1551 notifications.
1552 &$title: Title object of page
1553 &$url: string value as output (out parameter, can modify)
1554 $query: query options passed to Title::getCanonicalURL()
1556 'GetDefaultSortkey': Override the default sortkey for a page.
1557 $title: Title object that we need to get a sortkey for
1558 &$sortkey: Sortkey to use.
1560 'GetDifferenceEngine': Called when getting a new difference engine interface
1561 object Return false for valid object in $differenceEngine or true for the
1562 default difference engine.
1563 $context: IContextSource context to be used for diff
1564 $old: Revision ID to show and diff with
1565 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1566 $refreshCache: If set, refreshes the diff cache
1567 $unhide: If set, allow viewing deleted revs
1568 &$differenceEngine: output parameter, difference engine object to be used for
1569   diff
1571 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1572 underscore) magic words. Called by MagicWord.
1573 &$doubleUnderscoreIDs: array of strings
1575 'GetExtendedMetadata': Get extended file metadata for the API
1576 &$combinedMeta: Array of the form:
1577         'MetadataPropName' => array(
1578                 value' => prop value,
1579                 'source' => 'name of hook'
1580         ).
1581 $file: File object of file in question
1582 $context: RequestContext (including language to use)
1583 $single: Only extract the current language; if false, the prop value should
1584   be in the metadata multi-language array format:
1585   mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1586 &$maxCacheTime: how long the results can be cached
1588 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1589 &$title: Title object of page
1590 &$url: string value as output (out parameter, can modify)
1591 $query: query options passed to Title::getFullURL()
1593 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1594 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1595 the custom output.
1596 &$output: string for the output timestamp
1597 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1598 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1599 $user: User whose preferences are being used to make timestamp
1600 $lang: Language that will be used to render the timestamp
1602 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1603 &$title: Title object of page
1604 &$url: string value as output (out parameter, can modify)
1605 $query: query options passed to Title::getInternalURL()
1607 'GetIP': modify the ip of the current user (called only once).
1608 &$ip: string holding the ip as determined so far
1610 'GetLinkColours': modify the CSS class of an array of page links.
1611 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1612   indexed by page_id.
1613 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1615 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1616 working with internal urls (non-interwiki) then it may be preferable to work
1617 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1618 be buggy for internal urls on render if you do not re-implement the horrible
1619 hack that Title::getLocalURL uses in your own extension.
1620 &$title: Title object of page
1621 &$url: string value as output (out parameter, can modify)
1622 $query: query options passed to Title::getLocalURL()
1624 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1625 without any fancy queries or variants.
1626 &$title: Title object of page
1627 &$url: string value as output (out parameter, can modify)
1629 'GetLocalURL::Internal': Modify local URLs to internal pages.
1630 &$title: Title object of page
1631 &$url: string value as output (out parameter, can modify)
1632 $query: query options passed to Title::getLocalURL()
1634 'GetLogTypesOnUser': Add log types where the target is a userpage
1635 &$types: Array of log types
1637 'GetMetadataVersion': Modify the image metadata version currently in use. This
1638 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1639 that need to have versioned metadata should add an element to the end of the
1640 version array of the form 'handler_name=version'. Most media handlers won't need
1641 to do this unless they broke backwards compatibility with a previous version of
1642 the media handler metadata output.
1643 &$version: Array of version strings
1645 'GetNewMessagesAlert': Disable or modify the new messages alert
1646 &$newMessagesAlert: An empty string by default. If the user has new talk page
1647   messages, this should be populated with an alert message to that effect
1648 $newtalks: An empty array if the user has no new messages or an array
1649   containing links and revisions if there are new messages (See
1650   User::getNewMessageLinks)
1651 $user: The user object of the user who is loading the page
1652 $out: OutputPage object (to check what type of page the user is on)
1654 'GetPreferences': Modify user preferences.
1655 $user: User whose preferences are being modified.
1656 &$preferences: Preferences description array, to be fed to an HTMLForm object
1658 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1659 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1660 custom output.
1661 &$output: string for the output timestamp
1662 &$diff: DateInterval representing the difference between the timestamps
1663 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1664 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1665 $user: User whose preferences are being used to make timestamp
1666 $lang: Language that will be used to render the timestamp
1668 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1669 checked for. Use instead of userCan for most cases. Return false if the user
1670 can't do it, and populate $result with the reason in the form of
1671 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1672 might want to use ApiMessage to provide machine-readable details for the API).
1673 For consistency, error messages
1674 should be plain text with no special coloring, bolding, etc. to show that
1675 they're errors; presenting them properly to the user as errors is done by the
1676 caller.
1677 &$title: Title object being checked against
1678 &$user: Current user object
1679 $action: Action being checked
1680 &$result: User permissions error to add. If none, return true.
1682 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1683 called only if expensive checks are enabled. Add a permissions error when
1684 permissions errors are checked for. Return false if the user can't do it, and
1685 populate $result with the reason in the form of array( messagename, param1,
1686 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1687 to provide machine-readable details for the API). For consistency, error
1688 messages should be plain text with no
1689 special coloring, bolding, etc. to show that they're errors; presenting them
1690 properly to the user as errors is done by the caller.
1691 &$title: Title object being checked against
1692 &$user: Current user object
1693 $action: Action being checked
1694 &$result: User permissions error to add. If none, return true.
1696 'GitViewers': Called when generating the list of git viewers for
1697 Special:Version, use this to change the list.
1698 &$extTypes: associative array of repo URLS to viewer URLs.
1700 'HistoryRevisionTools': Override or extend the revision tools available from the
1701 page history view, i.e. undo, rollback, etc.
1702 $rev: Revision object
1703 &$links: Array of HTML links
1704 $prevRev: Revision object, next in line in page history, or null
1705 $user: Current user object
1707 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1708 cache.
1709 $context: An IContextSource object with information about the request being
1710   served.
1712 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1713 image insertion. You can skip the default logic entirely by returning false, or
1714 just modify a few things using call-by-reference.
1715 &$skin: Skin object
1716 &$title: Title object of the image
1717 &$file: File object, or false if it doesn't exist
1718 &$frameParams: Various parameters with special meanings; see documentation in
1719   includes/Linker.php for Linker::makeImageLink
1720 &$handlerParams: Various parameters with special meanings; see documentation in
1721   includes/Linker.php for Linker::makeImageLink
1722 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1723 &$res: Final HTML output, used if you return false
1725 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1726 the image on an image page.
1727 &$imagePage: ImagePage object ($this)
1728 &$output: $wgOut
1730 'ImagePageAfterImageLinks': Called after the image links section on an image
1731 page is built.
1732 $imagePage: ImagePage object ($this)
1733 &$html: HTML for the hook to add
1735 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1736 $imagePage: ImagePage object ($this)
1737 $file: the file
1738 &$line: the HTML of the history line
1739 &$css: the line CSS class
1741 'ImagePageFindFile': Called when fetching the file associated with an image
1742 page.
1743 $page: ImagePage object
1744 &$file: File object
1745 &$displayFile: displayed File object
1747 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1748 $page: ImagePage object
1749 &$toc: Array of <li> strings
1751 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1752 using img_auth.php.
1753 &$title: the Title object of the file as it would appear for the upload page
1754 &$path: the original file and path name when img_auth was invoked by the web
1755   server
1756 &$name: the name only component of the file
1757 &$result: The location to pass back results of the hook routine (only used if
1758   failed)
1759   $result[0]=The index of the header message
1760   $result[1]=The index of the body text message
1761   $result[2 through n]=Parameters passed to body text message. Please note the
1762   header message cannot receive/use parameters.
1764 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1765 Return false to stop further processing of the tag
1766 $reader: XMLReader object
1767 $logInfo: Array of information
1769 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1770 Return false to stop further processing of the tag
1771 $reader: XMLReader object
1772 &$pageInfo: Array of information
1774 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1775 Return false to stop further processing of the tag
1776 $reader: XMLReader object
1777 $pageInfo: Array of page information
1778 $revisionInfo: Array of revision information
1780 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1781 Return false to stop further processing of the tag
1782 $reader: XMLReader object
1784 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1785 Return false to stop further processing of the tag
1786 $reader: XMLReader object
1787 $revisionInfo: Array of information
1789 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1790 and edit summaries for transwiki imports.
1791 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1792 &$pageTitle: String that contains page title.
1794 'ImportSources': Called when reading from the $wgImportSources configuration
1795 variable. Can be used to lazy-load the import sources list.
1796 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1797 comment in DefaultSettings.php for the detail of how to structure this array.
1799 'InfoAction': When building information to display on the action=info page.
1800 $context: IContextSource object
1801 &$pageInfo: Array of information
1803 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1804 &$title: Title object for the current page
1805 &$request: WebRequest
1806 &$ignoreRedirect: boolean to skip redirect check
1807 &$target: Title/string of redirect target
1808 &$article: Article object
1810 'InternalParseBeforeLinks': during Parser's internalParse method before links
1811 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1812 &$parser: Parser object
1813 &$text: string containing partially parsed text
1814 &$stripState: Parser's internal StripState object
1816 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1817 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1818 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1819 template/parser function execution which respect nowiki and HTML-comments.
1820 &$parser: Parser object
1821 &$text: string containing partially parsed text
1822 &$stripState: Parser's internal StripState object
1824 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1825 Return true without providing an interwiki to continue interwiki search.
1826 $prefix: interwiki prefix we are looking for.
1827 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1828   iw_trans and optionally iw_api and iw_wikiid.
1830 'InvalidateEmailComplete': Called after a user's email has been invalidated
1831 successfully.
1832 $user: user (object) whose email is being invalidated
1834 'IRCLineURL': When constructing the URL to use in an IRC notification.
1835 Callee may modify $url and $query, URL will be constructed as $url . $query
1836 &$url: URL to index.php
1837 &$query: Query string
1838 $rc: RecentChange object that triggered url generation
1840 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1841 &$article: article (object) being checked
1843 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1844 &$ip: IP being check
1845 &$result: Change this value to override the result of IP::isTrustedProxy()
1847 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1848 $url: URL used to upload from
1849 &$allowed: Boolean indicating if uploading is allowed for given URL
1851 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1852 instance to return false if the domain name doesn't match your organization.
1853 $addr: The e-mail address entered by the user
1854 &$result: Set this and return false to override the internal checks
1856 'isValidPassword': Override the result of User::isValidPassword()
1857 $password: The password entered by the user
1858 &$result: Set this and return false to override the internal checks
1859 $user: User the password is being validated for
1861 'Language::getMessagesFileName':
1862 $code: The language code or the language we're looking for a messages file for
1863 &$file: The messages file path, you can override this to change the location.
1865 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1866 $wgExtensionMessagesFiles instead.
1867 Use this to define synonyms of magic words depending of the language
1868 &$magicExtensions: associative array of magic words synonyms
1869 $lang: language code (string)
1871 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1872 remove namespaces. Do not use this hook to add namespaces. Use
1873 CanonicalNamespaces for that.
1874 &$namespaces: Array of namespaces indexed by their numbers
1876 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1877 listed in $wgExtensionMessagesFiles instead.
1878 Use to define aliases of special pages names depending of the language
1879 &$specialPageAliases: associative array of magic words synonyms
1880 $lang: language code (string)
1882 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1883 &$names: array of language code => language name
1884 $code: language of the preferred translations
1886 'LanguageLinks': Manipulate a page's language links. This is called
1887 in various places to allow extensions to define the effective language
1888 links for a page.
1889 $title: The page's Title.
1890 &$links: Array with elements of the form "language:title" in the order
1891   that they will be output.
1892 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1893   Currently unused, but planned to provide support for marking individual
1894   language links in the UI, e.g. for featured articles.
1896 'LanguageSelector': Hook to change the language selector available on a page.
1897 $out: The output page.
1898 $cssClassName: CSS class name of the language selector.
1900 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1901 Used when generating internal and interwiki links in
1902 Linker::link(), before processing starts.  Return false to skip default
1903 processing and return $ret. See documentation for Linker::link() for details on
1904 the expected meanings of parameters.
1905 $skin: the Skin object
1906 $target: the Title that the link is pointing to
1907 &$html: the contents that the <a> tag should have (raw HTML); null means
1908   "default".
1909 &$customAttribs: the HTML attributes that the <a> tag should have, in
1910   associative array form, with keys and values unescaped.  Should be merged
1911   with default values, with a value of false meaning to suppress the
1912   attribute.
1913 &$query: the query string to add to the generated URL (the bit after the "?"),
1914   in associative array form, with keys and values unescaped.
1915 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1916 &$ret: the value to return if your hook returns false.
1918 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1919 Used when generating internal and interwiki links in Linker::link(),
1920 just before the function returns a value.  If you return true, an <a> element
1921 with HTML attributes $attribs and contents $html will be returned.  If you
1922 return false, $ret will be returned.
1923 $skin: the Skin object
1924 $target: the Title object that the link is pointing to
1925 $options: the options.  Will always include either 'known' or 'broken', and may
1926   include 'noclasses'.
1927 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1928 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1929   associative array form.
1930 &$ret: the value to return if your hook returns false.
1932 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1933 before the return.
1934 &$url: the image url
1935 &$alt: the image's alt text
1936 &$img: the new image HTML (if returning false)
1938 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1939 before the return.
1940 &$url: the link url
1941 &$text: the link text
1942 &$link: the new link HTML (if returning false)
1943 &$attribs: the attributes to be applied.
1944 $linkType: The external link type
1946 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1947 before the return.
1948 $title: the Title object that the link is pointing to
1949 $file: the File object or false if broken link
1950 &$html: the link text
1951 &$attribs: the attributes to be applied
1952 &$ret: the value to return if your hook returns false
1954 'HtmlPageLinkRendererBegin':
1955 Used when generating internal and interwiki links in
1956 LinkRenderer, before processing starts.  Return false to skip default
1957 processing and return $ret.
1958 $linkRenderer: the LinkRenderer object
1959 $target: the LinkTarget that the link is pointing to
1960 &$text: the contents that the <a> tag should have; either a plain, unescaped
1961   string or a HtmlArmor object; null means "default".
1962 &$customAttribs: the HTML attributes that the <a> tag should have, in
1963   associative array form, with keys and values unescaped.  Should be merged
1964   with default values, with a value of false meaning to suppress the
1965   attribute.
1966 &$query: the query string to add to the generated URL (the bit after the "?"),
1967   in associative array form, with keys and values unescaped.
1968 &$ret: the value to return if your hook returns false.
1970 'HtmlPageLinkRendererEnd':
1971 Used when generating internal and interwiki links in LinkRenderer,
1972 just before the function returns a value.  If you return true, an <a> element
1973 with HTML attributes $attribs and contents $html will be returned.  If you
1974 return false, $ret will be returned.
1975 $linkRenderer: the LinkRenderer object
1976 $target: the LinkTarget object that the link is pointing to
1977 $isKnown: boolean indicating whether the page is known or not
1978 &$text: the contents that the <a> tag should have; either a plain, unescaped
1979   string or a HtmlArmor object.
1980 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1981   associative array form.
1982 &$ret: the value to return if your hook returns false.
1984 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1985 actual update.
1986 &$linksUpdate: the LinksUpdate object
1988 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1989 each link table insert.  For example, pagelinks, imagelinks, externallinks.
1990 $linksUpdate: LinksUpdate object
1991 $table: the table to insert links to
1992 $insertions: an array of links to insert
1994 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1995 including delete and insert, has completed for all link tables
1996 &$linksUpdate: the LinksUpdate object
1997 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
1999 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2000 &$linksUpdate: the LinksUpdate object
2002 'ListDefinedTags': When trying to find all defined tags.
2003 &$tags: The list of tags.
2005 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2006 $updater: A DatabaseUpdater subclass
2008 'LocalFile::getHistory': Called before file history query performed.
2009 &$file: the File object
2010 &$tables: tables
2011 &$fields: select fields
2012 &$conds: conditions
2013 &$opts: query options
2014 &$join_conds: JOIN conditions
2016 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2017 $file: the File object
2018 $archiveName: name of an old file version or false if it's the current one
2020 'LocalisationCacheRecache': Called when loading the localisation data into
2021 cache.
2022 $cache: The LocalisationCache object
2023 $code: language code
2024 &$alldata: The localisation data from core and extensions
2025 &$purgeBlobs: whether to purge/update the message blobs via
2026   MessageBlobStore::clear()
2028 'LocalisationCacheRecacheFallback': Called for each language when merging
2029 fallback data into the cache.
2030 $cache: The LocalisationCache object
2031 $code: language code
2032 &$alldata: The localisation data from core and extensions. Note some keys may
2033   be omitted if they won't be merged into the final result.
2035 'LocalisationChecksBlacklist': When fetching the blacklist of
2036 localisation checks.
2037 &$blacklist: array of checks to blacklist. See the bottom of
2038   maintenance/language/checkLanguage.inc for the format of this variable.
2040 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2041 optional localisation messages
2042 &$ignored: Array of ignored message keys
2043 &$optional: Array of optional message keys
2045 'LocalUserCreated': Called when a local user has been created
2046 $user: User object for the created user
2047 $autocreated: Boolean, whether this was an auto-creation
2049 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2050 Special:Log for a specific log type
2051 $type: String of log type being displayed
2052 $logEventsList: LogEventsList object for context and access to the WebRequest
2053 &$input: string HTML of an input element
2055 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2056 Returning false will prevent the string from being added to the OutputPage.
2057 &$s: html string to show for the log extract
2058 $types: String or Array Log types to show
2059 $page: String or Title The page title to show log entries for
2060 $user: String The user who made the log entries
2061 $param: Associative Array with the following additional options:
2062   - lim Integer Limit of items to show, default is 50
2063   - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2064   - showIfEmpty boolean Set to false if you don't want any output in case the
2065     loglist is empty if set to true (default), "No matching items in log" is
2066     displayed if loglist is empty
2067   - msgKey Array If you want a nice box with a message, set this to the key of
2068     the message. First element is the message key, additional optional elements
2069     are parameters for the key that are processed with
2070     wfMessage()->params()->parseAsBlock()
2071   - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2072     offset
2073   - wrap String Wrap the message in html (usually something like
2074     "&lt;div ...>$1&lt;/div>").
2075   - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2077 'LogException': Called before an exception (or PHP error) is logged. This is
2078 meant for integration with external error aggregation services; returning false
2079 will NOT prevent logging.
2080 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2081 $suppressed: true if the error was suppressed via
2082   error_reporting()/wfSuppressWarnings()
2084 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2085 error messages. Allows to add additional error messages (except messages already
2086 in LoginForm::$validErrorMessages).
2087 &$messages: Already added messages (inclusive messages from
2088   LoginForm::$validErrorMessages)
2090 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2091 Called during login to allow extensions the opportunity to inform a user that
2092 their username doesn't exist for a specific reason, instead of letting the
2093 login form give the generic error message that the account does not exist. For
2094 example, when the account has been renamed or deleted.
2095 $user: the User object being authenticated against.
2096 &$msg: the message identifier for abort reason, or an array to pass a message
2097   key and parameters.
2099 'LogLine': Processes a single log entry on Special:Log.
2100 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2101   logging.log_type database field.
2102 $log_action: string for the type of log action (e.g. 'delete', 'block',
2103   'create2'). Corresponds to logging.log_action database field.
2104 $title: Title object that corresponds to logging.log_namespace and
2105   logging.log_title database fields.
2106 $paramArray: Array of parameters that corresponds to logging.log_params field.
2107   Note that only $paramArray[0] appears to contain anything.
2108 &$comment: string that corresponds to logging.log_comment database field, and
2109   which is displayed in the UI.
2110 &$revert: string that is displayed in the UI, similar to $comment.
2111 $time: timestamp of the log entry (added in 1.12)
2113 'LonelyPagesQuery': Allow extensions to modify the query used by
2114 Special:LonelyPages.
2115 &$tables: tables to join in the query
2116 &$conds: conditions for the query
2117 &$joinConds: join conditions for the query
2119 'MagicWordwgVariableIDs': When defining new magic words IDs.
2120 &$variableIDs: array of strings
2122 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2123 script.
2124 $refreshLinks: RefreshLinks object
2126 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2127 Ideally, this hook should only be used to add variables that depend on
2128 the current page/request; static configuration should be added through
2129 ResourceLoaderGetConfigVars instead.
2130 &$vars: variable (or multiple variables) to be added into the output of
2131   Skin::makeVariablesScript
2132 $out: The OutputPage which called the hook, can be used to get the real title.
2134 'MarkPatrolled': Before an edit is marked patrolled.
2135 $rcid: ID of the revision to be marked patrolled
2136 &$user: the user (object) marking the revision as patrolled
2137 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2138   sysop in order to mark an edit patrolled.
2139 $auto: true if the edit is being marked as patrolled automatically
2141 'MarkPatrolledComplete': After an edit is marked patrolled.
2142 $rcid: ID of the revision marked as patrolled
2143 &$user: user (object) who marked the edit patrolled
2144 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2145   sysop to patrol the edit.
2146 $auto: true if the edit is being marked as patrolled automatically
2148 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2149 something completely different, after the basic globals have been set up, but
2150 before ordinary actions take place.
2151 $output: $wgOut
2152 $article: Article on which the action will be performed
2153 $title: Title on which the action will be performed
2154 $user: $wgUser
2155 $request: $wgRequest
2156 $mediaWiki: The $mediawiki object
2158 'MediaWikiServices': Called when a global MediaWikiServices instance is
2159 initialized. Extensions may use this to define, replace, or wrap services.
2160 However, the preferred way to define a new service is
2161 the $wgServiceWiringFiles array.
2162 $services: MediaWikiServices
2164 'MessageCache::get': When fetching a message. Can be used to override the key
2165 for customisations. Given and returned message key must be in special format:
2166 1) first letter must be in lower case according to the content language.
2167 2) spaces must be replaced with underscores
2168 &$key: message key (string)
2170 'MessageCacheReplace': When a message page is changed. Useful for updating
2171 caches.
2172 $title: name of the page changed.
2173 $text: new contents of the page.
2175 'MessagesPreLoad': When loading a message from the database.
2176 $title: title of the message (string)
2177 &$message: value (string), change it to the message you want to define
2178 $code: code (string) denoting the language to try.
2180 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2181 $mimeMagic: Instance of MimeMagic.
2182 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2183 &$tail: More or equal than last 65558 bytes of the file in a string
2184   (in - Do not alter!).
2185 $file: File path.
2186 &$mime: MIME type (out).
2188 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2189 MIME type detected by considering the file extension.
2190 $mimeMagic: Instance of MimeMagic.
2191 $ext: File extension.
2192 &$mime: MIME type (in/out).
2194 'MimeMagicInit': Before processing the list mapping MIME types to media types
2195 and the list mapping MIME types to file extensions.
2196 As an extension author, you are encouraged to submit patches to MediaWiki's
2197 core to add new MIME types to mime.types.
2198 $mimeMagic: Instance of MimeMagic.
2199   Use $mimeMagic->addExtraInfo( $stringOfInfo );
2200   for adding new MIME info to the list.
2201   Use $mimeMagic->addExtraTypes( $stringOfTypes );
2202   for adding new MIME types to the list.
2204 'ModifyExportQuery': Modify the query used by the exporter.
2205 $db: The database object to be queried.
2206 &$tables: Tables in the query.
2207 &$conds: Conditions in the query.
2208 &$opts: Options for the query.
2209 &$join_conds: Join conditions for the query.
2211 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2212 page.
2213 $oldTitle: Title object of the current (old) location
2214 $newTitle: Title object of the new location
2215 $user: User making the move
2216 $reason: string of the reason provided by the user
2217 $status: Status object to pass error messages to
2219 'MovePageIsValidMove': Specify whether a page can be moved for technical
2220 reasons.
2221 $oldTitle: Title object of the current (old) location
2222 $newTitle: Title object of the new location
2223 $status: Status object to pass error messages to
2225 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2226 namespace.
2227 $index: Integer; the index of the namespace being checked.
2228 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2229   namespace are movable. Hooks may change this value to override the return
2230   value of MWNamespace::isMovable().
2232 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2233 $title: the diff page title (nullable)
2234 &$oldId: the actual old Id to use in the diff
2235 &$newId: the actual new Id to use in the diff (0 means current)
2236 $old: the ?old= param value from the url
2237 $new: the ?new= param value from the url
2239 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2240 edit.
2241 $wikiPage: the WikiPage edited
2242 $rev: the new revision
2243 $baseID: the revision ID this was based off, if any
2244 $user: the editing user
2246 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2247 return false to omit the line from RecentChanges and Watchlist special pages.
2248 &$changeslist: The OldChangesList instance.
2249 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2250 $rc: The RecentChange object.
2251 &$classes: array of css classes for the <li> element
2253 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2254 can alter or append to the array of URLs for search & suggestion formats.
2255 &$urls: array of associative arrays with Url element attributes
2257 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2258 when a page view triggers a re-rendering of the page. This may happen
2259 particularly if the parser cache is split by user language, and no cached
2260 rendering of the page exists in the user's language. The hook is called
2261 before checking whether page_links_updated indicates that the links are up
2262 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2263 without triggering any updates.
2264 $page: the Page that was rendered.
2265 $title: the Title of the rendered page.
2266 $parserOutput: ParserOutput resulting from rendering the page.
2268 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2269 users and/or IP addresses too.
2270 &$otherBlockLink: An array with links to other block logs
2271 $ip: The requested IP address or username
2273 'OutputPageBeforeHTML': A page has been processed by the parser and the
2274 resulting HTML is about to be displayed.
2275 &$parserOutput: the parserOutput (object) that corresponds to the page
2276 &$text: the text that will be displayed, in HTML (string)
2278 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2279 body tag to allow for extensions to add attributes to the body of the page they
2280 might need. Or to allow building extensions to add body classes that aren't of
2281 high enough demand to be included in core.
2282 $out: The OutputPage which called the hook, can be used to get the real title
2283 $sk: The Skin that called OutputPage::headElement
2284 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2286 'OutputPageCheckLastModified': when checking if the page has been modified
2287 since the last visit.
2288 &$modifiedTimes: array of timestamps.
2289   The following keys are set: page, user, epoch
2290 $out: OutputPage object (since 1.28)
2292 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2293 categories. Implementations should return false if they generate the category
2294 links, so the default link generation is skipped.
2295 &$out: OutputPage instance (object)
2296 $categories: associative array, keys are category names, values are category
2297   types ("normal" or "hidden")
2298 &$links: array, intended to hold the result. Must be an associative array with
2299   category types as keys and arrays of HTML links as values.
2301 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2302 &$out: OutputPage instance (object)
2303 $parserOutput: parserOutput instance being added in $out
2305 'PageContentInsertComplete': After a new article is created.
2306 $wikiPage: WikiPage created
2307 $user: User creating the article
2308 $content: New content as a Content object
2309 $summary: Edit summary/comment
2310 $isMinor: Whether or not the edit was marked as minor
2311 $isWatch: (No longer used)
2312 $section: (No longer used)
2313 $flags: Flags passed to WikiPage::doEditContent()
2314 $revision: New Revision of the article
2316 'PageContentLanguage': Allows changing the language in which the content of a
2317 page is written. Defaults to the wiki content language ($wgContLang).
2318 $title: Title object
2319 &$pageLang: the page content language (either an object or a language code)
2320 $wgLang: the user language
2322 'PageContentSave': Before an article is saved.
2323 $wikiPage: the WikiPage (object) being saved
2324 $user: the user (object) saving the article
2325 $content: the new article content, as a Content object
2326 $summary: the article summary (comment)
2327 $isminor: minor flag
2328 $iswatch: watch flag
2329 $section: section #
2331 'PageContentSaveComplete': After an article has been updated.
2332 $wikiPage: WikiPage modified
2333 $user: User performing the modification
2334 $content: New content, as a Content object
2335 $summary: Edit summary/comment
2336 $isMinor: Whether or not the edit was marked as minor
2337 $isWatch: (No longer used)
2338 $section: (No longer used)
2339 $flags: Flags passed to WikiPage::doEditContent()
2340 $revision: New Revision of the article (can be null for edits that change
2341   nothing)
2342 $status: Status object about to be returned by doEditContent()
2343 $baseRevId: the rev ID (or false) this edit was based on
2344 $undidRevId: the rev ID (or 0) this edit undid
2346 'PageHistoryBeforeList': When a history page list is about to be constructed.
2347 &$article: the article that the history is loading for
2348 $context: RequestContext object
2350 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2351 $historyAction: the action object
2352 &$row: the revision row for this line
2353 &$s: the string representing this parsed line
2354 &$classes: array containing the <li> element classes
2356 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2357 any output is generated, to allow batch lookups for prefetching information
2358 needed for display. If the hook handler returns false, the regular behavior of
2359 doBatchLookups() is skipped.
2360 $pager: the PageHistoryPager
2361 $result: a ResultWrapper representing the query result
2363 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2364 constructed.
2365 &$pager: the pager
2366 &$queryInfo: the query parameters
2368 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2369 which depends on user options should install this hook and append its values to
2370 the key.
2371 &$confstr: reference to a hash key string which can be modified
2372 $user: User (object) requesting the page
2373 &$forOptions: array of options the hash is for
2375 'PageViewUpdates': Allow database (or other) changes to be made after a
2376 page view is seen by MediaWiki.  Note this does not capture views made
2377 via external caches such as Squid.
2378 $wikipage: WikiPage (object) for the page being viewed.
2379 $user: User (object) for the user who is viewing.
2381 'ParserAfterParse': Called from Parser::parse() just after the call to
2382 Parser::internalParse() returns.
2383 &$parser: parser object
2384 &$text: text being parsed
2385 &$stripState: stripState used (object)
2387 'ParserAfterStrip': Called at end of parsing time.
2388 TODO: No more strip, deprecated ?
2389 &$parser: parser object
2390 &$text: text being parsed
2391 &$stripState: stripState used (object)
2393 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2394 &$parser: Parser object being used
2395 &$text: text that will be returned
2397 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2398 Parser::internalParseHalfParsed()
2399 &$parser: Parser object being used
2400 &$text: text that will be returned
2402 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2403 &$parser: Parser object
2404 &$text: text to parse
2405 &$stripState: StripState instance being used
2407 'ParserBeforeStrip': Called at start of parsing time.
2408 TODO: No more strip, deprecated ?
2409 &$parser: parser object
2410 &$text: text being parsed
2411 &$stripState: stripState used (object)
2413 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2414 &$parser: Parser object being used
2415 &$text: actual text
2417 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2418 the parser cache.
2419 $parserCache: ParserCache object $parserOutput was stored in
2420 $parserOutput: ParserOutput object that was stored
2421 $title: Title of the page that was parsed to generate $parserOutput
2422 $popts: ParserOptions used for generating $parserOutput
2423 $revId: ID of the revision that was parsed to create $parserOutput
2425 'ParserClearState': Called at the end of Parser::clearState().
2426 &$parser: Parser object being cleared
2428 'ParserCloned': Called when the parser is cloned.
2429 $parser: Newly-cloned Parser object
2431 'ParserFetchTemplate': Called when the parser fetches a template
2432 $parser: Parser Parser object or false
2433 $title: Title object of the template to be fetched
2434 $rev: Revision object of the template
2435 &$text: Transclusion text of the template or false or null
2436 &$deps: Array of template dependencies with 'title', 'page_id', 'rev_id' keys
2438 'ParserFirstCallInit': Called when the parser initialises for the first time.
2439 &$parser: Parser object being cleared
2441 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2442 custom magic word
2443 &$parser: Parser object
2444 &$varCache: array to store the value in case of multiples calls of the
2445   same magic word
2446 &$index: index (string) of the magic
2447 &$ret: value of the magic word (the hook should set it)
2448 &$frame: PPFrame object to use for expanding any template variables
2450 'ParserGetVariableValueTs': Use this to change the value of the time for the
2451 {{LOCAL...}} magic word.
2452 &$parser: Parser object
2453 &$time: actual time (timestamp)
2455 'ParserGetVariableValueVarCache': use this to change the value of the variable
2456 cache or return false to not use it.
2457 &$parser: Parser object
2458 &$varCache: variable cache (array)
2460 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2461 ParserLimitReportFormat instead.
2462 Called at the end of Parser:parse() when the parser will
2463 include comments about size of the text parsed.
2464 $parser: Parser object
2465 &$limitReport: text that will be included (without comment tags)
2467 'ParserLimitReportFormat': Called for each row in the parser limit report that
2468 needs formatting. If nothing handles this hook, the default is to use "$key" to
2469 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2470 format the value.
2471 $key: Key for the limit report item (string)
2472 &$value: Value of the limit report item
2473 &$report: String onto which to append the data
2474 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2475   text intended for display in a monospaced font.
2476 $localize: If false, $report should be output in English.
2478 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2479 will include comments about size of the text parsed. Hooks should use
2480 $output->setLimitReportData() to populate data. Functions for this hook should
2481 not use $wgLang; do that in ParserLimitReportFormat instead.
2482 $parser: Parser object
2483 $output: ParserOutput object
2485 'ParserMakeImageParams': Called before the parser make an image link, use this
2486 to modify the parameters of the image.
2487 $title: title object representing the file
2488 $file: file object that will be used to create the image
2489 &$params: 2-D array of parameters
2490 $parser: Parser object that called the hook
2492 'ParserSectionCreate': Called each time the parser creates a document section
2493 from wikitext. Use this to apply per-section modifications to HTML (like
2494 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
2495 can begin in one section and end in another. Make sure your code can handle
2496 that case gracefully. See the EditSectionClearerLink extension for an example.
2497 $parser: the calling Parser instance
2498 $section: the section number, zero-based, but section 0 is usually empty
2499 &$sectionContent: ref to the content of the section. modify this.
2500 $showEditLinks: boolean describing whether this section has an edit link
2502 'ParserTestGlobals': Allows to define globals for parser tests.
2503 &$globals: Array with all the globals which should be set for parser tests.
2504   The arrays keys serve as the globals names, its values are the globals values.
2506 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2507 run. Use when page save hooks require the presence of custom tables to ensure
2508 that tests continue to run properly.
2509 &$tables: array of table names
2511 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2512 $page: the WikiPage of the candidate edit
2513 $content: the Content object of the candidate edit
2514 $output: the ParserOutput result of the candidate edit
2515 $summary: the change summary of the candidate edit
2516 $user: the User considering the edit
2518 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2519 $user: User object whose policy you are modifying
2520 &$effectivePolicy: Array of policy statements that apply to this user
2522 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2523 to a user.
2524 $block: Block object (which is set to be autoblocking)
2525 &$blockIds: Array of block IDs of the autoblock
2527 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2528 my talk page, my contributions" etc).
2529 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2530 &$title: Title object representing the current page
2531 $skin: SkinTemplate object providing context (e.g. to check if the user is
2532   logged in, etc.)
2534 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2535 &$user: User performing the action
2536 $action: Action being performed
2537 &$result: Whether or not the action should be prevented
2538   Change $result and return false to give a definitive answer, otherwise
2539   the built-in rate limiting checks are used, if enabled.
2540 $incrBy: Amount to increment counter by
2542 'PlaceNewSection': Override placement of new sections. Return false and put the
2543 merged text into $text to override the default behavior.
2544 $wikipage: WikiPage object
2545 $oldtext: the text of the article before editing
2546 $subject: subject of the new section
2547 &$text: text of the new section
2549 'PostLoginRedirect': Modify the post login redirect behavior.
2550 Occurs after signing up or logging in, allows for interception of redirect.
2551 &$returnTo: The page name to return to, as a string
2552 &$returnToQuery: array of url parameters, mapping parameter names to values
2553 &$type: type of login redirect as string;
2554   error: display a return to link ignoring $wgRedirectOnLogin
2555   signup: display a return to link using $wgRedirectOnLogin if needed
2556   success: display a return to link using $wgRedirectOnLogin if needed
2557   successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2559 'PreferencesFormPreSave': Override preferences being saved
2560 $formData: array of user submitted data
2561 $form: PreferencesForm object, also a ContextSource
2562 $user: User object with preferences to be saved set
2563 &$result: boolean indicating success
2565 'PreferencesGetLegend': Override the text used for the <legend> of a
2566 preferences section.
2567 $form: the PreferencesForm object. This is a ContextSource as well
2568 $key: the section name
2569 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2570   be overridden
2572 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2573 Override the title prefix search used for OpenSearch and
2574 AJAX search suggestions. Put results into &$results outparam and return false.
2575 $ns: array of int namespace keys to search in
2576 $search: search term (not guaranteed to be conveniently normalized)
2577 $limit: maximum number of results to return
2578 &$results: out param: array of page names (strings)
2579 $offset: number of results to offset from the beginning
2581 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2582 namespace from the search string so that extensions can attempt it.
2583 &$namespaces: array of int namespace keys to search in (change this if you can
2584   extract namespaces)
2585 &$search: search term (replace this with term without the namespace if you can
2586   extract one)
2588 'PrefsEmailAudit': Called when user changes their email address.
2589 $user: User (object) changing his email address
2590 $oldaddr: old email address (string)
2591 $newaddr: new email address (string)
2593 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2594 in the form.
2595 $article: the title being (un)protected
2596 &$output: a string of the form HTML so far
2598 'ProtectionForm::save': Called when a protection form is submitted.
2599 $article: the Page being (un)protected
2600 &$errorMsg: an html message string of an error or an array of message name and
2601   its parameters
2602 $reasonstr: a string describing the reason page protection level is altered
2604 'ProtectionForm::showLogExtract': Called after the protection log extract is
2605 shown.
2606 $article: the page the form is shown for
2607 $out: OutputPage object
2609 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2610 random pages.
2611 &$tables: Database tables to be used in the query
2612 &$conds: Conditions to be applied in the query
2613 &$joinConds: Join conditions to be applied in the query
2615 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2616 &$obj: RawAction object
2617 &$text: The text that's going to be the output
2619 'RecentChange_save': Called at the end of RecentChange::save().
2620 &$recentChange: RecentChange object
2622 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2623 names such as "oldid" that are preserved when using redirecting special pages
2624 such as Special:MyPage and Special:MyTalk.
2625 &$redirectParams: An array of parameters preserved by redirecting special pages.
2627 'RejectParserCacheValue': Return false to reject an otherwise usable
2628 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2629 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2630 EXTREME CARE.
2631 $parserOutput: ParserOutput value.
2632 $wikiPage: WikiPage object.
2633 $parserOptions: ParserOptions object.
2635 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2636 instance. Can be used by an extension override what skin is used in certain
2637 contexts.
2638 $context: (IContextSource) The RequestContext the skin is being created for.
2639 &$skin: A variable reference you may set a Skin instance or string key on to
2640   override the skin that will be used for the context.
2642 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2643 flagged to lack same-origin security. Return false to indicate the lack. Note
2644 if the "somehow" involves HTTP headers, you'll probably need to make sure
2645 the header is varied on.
2646 $request: The WebRequest object.
2648 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2649 $user: The user having their password expiration reset
2650 &$newExpire: The new expiration date
2652 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2653 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2654 to override its behavior. See the module docs for more information.
2655 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2656 depend on
2657 $context: ResourceLoaderContext|null
2659 'ResourceLoaderGetConfigVars': Called at the end of
2660 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2661 configuration variables to JavaScript. Things that depend on the current page
2662 or request state must be added through MakeGlobalVariablesScript instead.
2663 &$vars: array( variable name => value )
2665 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2666 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2667 context-based variables.
2668 &$lessVars: array of variables already added
2670 'ResourceLoaderRegisterModules': Right before modules information is required,
2671 such as when responding to a resource
2672 loader request or generating HTML output.
2673 &$resourceLoader: ResourceLoader object
2675 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2676 called after the addition of 'qunit' and MediaWiki testing resources.
2677 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2678   included in core, is fed using tests/qunit/QUnitTestResources.php.
2679   To add a new qunit module named 'myext.tests':
2680         $testModules['qunit']['myext.tests'] = array(
2681                 'script' => 'extension/myext/tests.js',
2682                 'dependencies' => <any module dependency you might have>
2683         );
2684   For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2685   added to any module.
2686 &$ResourceLoader: object
2688 'RevisionInsertComplete': Called after a revision is inserted into the database.
2689 &$revision: the Revision
2690 $data: the data stored in old_text.  The meaning depends on $flags: if external
2691   is set, it's the URL of the revision text in external storage; otherwise,
2692   it's the revision text itself.  In either case, if gzip is set, the revision
2693   text is gzipped.
2694 $flags: a comma-delimited list of strings representing the options used.  May
2695   include: utf8 (this will always be set for new revisions); gzip; external.
2697 'SearchableNamespaces': An option to modify which namespaces are searchable.
2698 &$arr: Array of namespaces ($nsId => $name) which will be used.
2700 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2701 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2702 runs after.
2703 $term: Search term string
2704 &$title: Outparam; set to $title object and return false for a match
2706 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2707 if nothing was found.
2708 $term: Search term string
2709 &$title: Outparam; set to $title object and return false for a match
2711 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2712 the normal operations.
2713 $allSearchTerms: Array of the search terms in all content languages
2714 &$titleResult: Outparam; the value to return. A Title object or null.
2716 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2717 searches.
2718 $term: Search term string
2719 &$title: Current Title object that is being returned (null if none found).
2721 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2722 search results.
2723 $title: Current Title object being displayed in search results.
2724 &$id: Revision ID (default is false, for latest)
2726 'SearchIndexFields': Add fields to search index mapping.
2727 &$fields: Array of fields, all implement SearchIndexField
2728 $engine: SearchEngine instance for which mapping is being built.
2730 'SearchDataForIndex': Add data to search document. Allows to add any data to
2731 the field map used to index the document.
2732 &$fields: Array of name => value pairs for fields
2733 $handler: ContentHandler for the content being indexed
2734 $page: WikiPage that is being indexed
2735 $output: ParserOutput that is produced from the page
2736 $engine: SearchEngine for which the indexing is intended
2738 'SearchResultsAugment': Allows extension to add its code to the list of search
2739 result augmentors.
2740 &$setAugmentors: List of whole-set augmentor objects, must implement ResultSetAugmentor
2741 &$rowAugmentors: List of per-row augmentor objects, must implement ResultAugmentor.
2742 Note that lists should be in the format name => object and the names in both lists should
2743 be distinct.
2745 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2746 perform when page content is modified. Currently called by
2747 AbstractContent::getSecondaryDataUpdates.
2748 $title: Title of the page that is being edited.
2749 $oldContent: Content object representing the page's content before the edit.
2750 $recursive: bool indicating whether DataUpdates should trigger recursive
2751   updates (relevant mostly for LinksUpdate).
2752 $parserOutput: ParserOutput representing the rendered version of the page
2753   after the edit.
2754 &$updates: a list of DataUpdate objects, to be modified or replaced by
2755   the hook handler.
2757 'SecuritySensitiveOperationStatus': Affect the return value from
2758 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2759 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2760   constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2761   authentication isn't possible for the current session type.
2762 $operation: (string) The operation being checked.
2763 $session: (MediaWiki\Session\Session) The current session. The
2764   currently-authenticated user may be retrieved as $session->getUser().
2765 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2766   the time of last auth is unknown, or -1 if authentication is not possible.
2768 'SelfLinkBegin': Called before a link to the current article is displayed to
2769 allow the display of the link to be customized.
2770 $nt: the Title object
2771 &$html: html to display for the link
2772 &$trail: optional text to display before $html
2773 &$prefix: optional text to display after $html
2774 &$ret: the value to return if your hook returns false
2776 'SendWatchlistEmailNotification': Return true to send watchlist email
2777 notification
2778 $targetUser: the user whom to send watchlist email notification
2779 $title: the page title
2780 $enotif: EmailNotification object
2782 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2783 loaded from storage. Return false to prevent it from being used.
2784 &$reason: String rejection reason to be logged
2785 $info: MediaWiki\Session\SessionInfo being validated
2786 $request: WebRequest being loaded from
2787 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2788 $data: Array|false Data array for the MediaWiki\Session\Session
2790 'SessionMetadata': Add metadata to a session being saved.
2791 $backend: MediaWiki\Session\SessionBackend being saved.
2792 &$metadata: Array Metadata to be stored. Add new keys here.
2793 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2794   request and 0+ FauxRequests.
2796 'SetupAfterCache': Called in Setup.php, after cache objects are set
2798 'ShortPagesQuery': Allow extensions to modify the query used by
2799 Special:ShortPages.
2800 &$tables: tables to join in the query
2801 &$conds: conditions for the query
2802 &$joinConds: join conditions for the query
2803 &$options: options for the query
2805 'ShowMissingArticle': Called when generating the output for a non-existent page.
2806 $article: The article object corresponding to the page
2808 'ShowSearchHit': Customize display of search hit.
2809 $searchPage: The SpecialSearch instance.
2810 $result: The SearchResult to show
2811 $terms: Search terms, for highlighting
2812 &$link: HTML of link to the matching page. May be modified.
2813 &$redirect: HTML of redirect info. May be modified.
2814 &$section: HTML of matching section. May be modified.
2815 &$extract: HTML of content extract. May be modified.
2816 &$score: HTML of score. May be modified.
2817 &$size: HTML of page size. May be modified.
2818 &$date: HTML of of page modification date. May be modified.
2819 &$related: HTML of additional info for the matching page. May be modified.
2820 &$html: May be set to the full HTML that should be used to represent the search
2821   hit. Must include the <li> ... </li> tags. Will only be used if the hook
2822   function returned false.
2824 'ShowSearchHitTitle': Customise display of search hit title/link.
2825 &$title: Title to link to
2826 &$titleSnippet: Label for the link representing the search result. Typically the article title.
2827 $result: The SearchResult object
2828 $terms: String of the search terms entered
2829 $specialSearch: The SpecialSearch object
2830 &$query: Array of query string parameters for the link representing the search result.
2832 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2833 Warning: This hook is run on each display. You should consider to use
2834 'SkinBuildSidebar' that is aggressively cached.
2835 $skin: Skin object
2836 &$bar: Sidebar content
2837   Modify $bar to add or modify sidebar portlets.
2839 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2840 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2841   the sitenotice/anonnotice.
2842 $skin: Skin object
2844 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2845 allow the normal method of notice selection/rendering to work, or change the
2846 value of $siteNotice and return false to alter it.
2847 &$siteNotice: HTML returned as the sitenotice
2848 $skin: Skin object
2850 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2851 $skin: Skin object
2852 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2853   the stock bottom scripts.
2855 'SkinAfterContent': Allows extensions to add text after the page content and
2856 article metadata. This hook should work in all skins. Set the &$data variable to
2857 the text you're going to add.
2858 &$data: (string) Text to be printed out directly (without parsing)
2859 $skin: Skin object
2861 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2862 $skin: Skin object
2863 &$bar: Sidebar contents
2864 Modify $bar to add or modify sidebar portlets.
2866 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2867 copyright notice.
2868 $title: displayed page title
2869 $type: 'normal' or 'history' for old/diff views
2870 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2871   message must be in HTML format, not wikitext!
2872 &$link: overridable HTML link to be passed into the message as $1
2873 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2874   content language.
2876 'SkinEditSectionLinks': Modify the section edit links
2877 $skin: Skin object rendering the UI
2878 $title: Title object for the title being linked to (may not be the same as
2879   the page title, if the section is included from a template)
2880 $section: The designation of the section being pointed to, to be included in
2881   the link, like "&section=$section"
2882 $tooltip: The default tooltip.  Escape before using.
2883   By default, this is wrapped in the 'editsectionhint' message.
2884 &$result: Array containing all link detail arrays. Each link detail array should
2885   contain the following keys:
2886     - targetTitle - Target Title object
2887     - text - String for the text
2888     - attribs - Array of attributes
2889     - query - Array of query parameters to add to the URL
2890     - options - Array of options for Linker::link
2891 $lang: The language code to use for the link in the wfMessage function
2893 'SkinGetPoweredBy': TODO
2894 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2895   the MediaWiki icon but plain text instead.
2896 $skin: Skin object
2898 'SkinPreloadExistence': Supply titles that should be added to link existence
2899 cache before the page is rendered.
2900 &$titles: Array of Title objects
2901 $skin: Skin object
2903 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2904 If false is returned $subpages will be used instead of the HTML
2905 subPageSubtitle() generates.
2906 If true is returned, $subpages will be ignored and the rest of
2907 subPageSubtitle() will run.
2908 &$subpages: Subpage links HTML
2909 $skin: Skin object
2910 $out: OutputPage object
2912 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2913 link" tab.
2914 &$sktemplate: SkinTemplate object
2915 &$nav_urls: array of tabs
2916 &$revid: The revision id of the permanent link
2917 &$revid2: The revision id of the permanent link, second time
2919 'SkinTemplateGetLanguageLink': After building the data for a language link from
2920 which the actual html is constructed.
2921 &$languageLink: array containing data about the link. The following keys can be
2922   modified: href, text, title, class, lang, hreflang. Each of them is a string.
2923 $languageLinkTitle: Title object belonging to the external language link.
2924 $title: Title object of the page the link belongs to.
2925 $outputPage: The OutputPage object the links are built from.
2927 'SkinTemplateNavigation': Called on content pages after the tabs have been
2928 added, but before variants have been added.
2929 &$sktemplate: SkinTemplate object
2930 &$links: Structured navigation links. This is used to alter the navigation for
2931   skins which use buildNavigationUrls such as Vector.
2933 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2934 tab is added but before variants have been added.
2935 &$sktemplate: SkinTemplate object
2936 &$links: Structured navigation links. This is used to alter the navigation for
2937   skins which use buildNavigationUrls such as Vector.
2939 'SkinTemplateNavigation::Universal': Called on both content and special pages
2940 after variants have been added.
2941 &$sktemplate: SkinTemplate object
2942 &$links: Structured navigation links. This is used to alter the navigation for
2943   skins which use buildNavigationUrls such as Vector.
2945 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2946 page output.
2947 &$sktemplate: SkinTemplate object
2948 &$tpl: QuickTemplate engine object
2950 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2951 &$sktemplate: SkinTemplate object
2952 &$res: set to true to prevent active tabs
2954 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2955 You can either create your own array, or alter the parameters for
2956 the normal one.
2957 &$sktemplate: The SkinTemplate instance.
2958 $title: Title instance for the page.
2959 $message: Visible label of tab.
2960 $selected: Whether this is a selected tab.
2961 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2962 &$classes: Array of CSS classes to apply.
2963 &$query: Query string to add to link.
2964 &$text: Link text.
2965 &$result: Complete assoc. array if you want to return true.
2967 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2968 been rendered (useful for adding more).
2969 &$sk: The QuickTemplate based skin template running the hook.
2970 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2971   extensions that add support for BaseTemplateToolbox should watch for this
2972   dummy parameter with "$dummy=false" in their code and return without echoing
2973   any HTML to avoid creating duplicate toolbox items.
2975 'SoftwareInfo': Called by Special:Version for returning information about the
2976 software.
2977 &$software: The array of software in format 'name' => 'version'. See
2978   SpecialVersion::softwareInformation().
2980 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2981 $sp: SpecialPage object, for context
2982 &$fields: Current HTMLForm fields
2984 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2985 $id: User id number, only provided for backwards-compatibility
2986 $user: User object representing user contributions are being fetched for
2987 $sp: SpecialPage instance, providing context
2989 'SpecialContributions::formatRow::flags': Called before rendering a
2990 Special:Contributions row.
2991 $context: IContextSource object
2992 $row: Revision information from the database
2993 &$flags: List of flags on this row
2995 'SpecialContributions::getForm::filters': Called with a list of filters to render
2996 on Special:Contributions.
2997 $sp: SpecialContributions object, for context
2998 &$filters: List of filters rendered as HTML
3000 'SpecialListusersDefaultQuery': Called right before the end of
3001 UsersPager::getDefaultQuery().
3002 $pager: The UsersPager instance
3003 &$query: The query array to be returned
3005 'SpecialListusersFormatRow': Called right before the end of
3006 UsersPager::formatRow().
3007 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
3008 $row: Database row object
3010 'SpecialListusersHeader': Called before closing the <fieldset> in
3011 UsersPager::getPageHeader().
3012 $pager: The UsersPager instance
3013 &$out: The header HTML
3015 'SpecialListusersHeaderForm': Called before adding the submit button in
3016 UsersPager::getPageHeader().
3017 $pager: The UsersPager instance
3018 &$out: The header HTML
3020 'SpecialListusersQueryInfo': Called right before the end of.
3021 UsersPager::getQueryInfo()
3022 $pager: The UsersPager instance
3023 &$query: The query array to be returned
3025 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3026 $type: String of the log type
3027 $request: WebRequest object for getting the value provided by the current user
3028 &$qc: Array for query conditions to add
3030 'SpecialMovepageAfterMove': Called after moving a page.
3031 &$movePage: MovePageForm object
3032 &$oldTitle: old title (object)
3033 &$newTitle: new title (object)
3035 'SpecialNewpagesConditions': Called when building sql query for
3036 Special:NewPages.
3037 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3038 $opts: FormOptions object containing special page options
3039 &$conds: array of WHERE conditionals for query
3040 &$tables: array of tables to be queried
3041 &$fields: array of columns to select
3042 &$join_conds: join conditions for the tables
3044 'SpecialNewPagesFilters': Called after building form options at NewPages.
3045 $special: the special page object
3046 &$filters: associative array of filter definitions. The keys are the HTML
3047   name/URL parameters. Each key maps to an associative array with a 'msg'
3048   (message key) and a 'default' value.
3050 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3051 this hook to remove a core special page or conditionally register special pages.
3052 &$list: list (array) of core special pages
3054 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3055 $special: the SpecialPage object
3056 $subPage: the subpage string or null if no subpage was specified
3058 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3059 Return false to prevent execution.
3060 $special: the SpecialPage object
3061 $subPage: the subpage string or null if no subpage was specified
3063 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3064 $name: name of the special page
3065 &$form: HTMLForm object
3067 'SpecialPasswordResetOnSubmit': When executing a form submission on
3068 Special:PasswordReset.
3069 &$users: array of User objects.
3070 $data: array of data submitted by the user
3071 &$error: string, error code (message key) used to describe to error (out
3072   parameter). The hook needs to return false when setting this, otherwise it
3073   will have no effect.
3075 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3076 use this to change some selection criteria or substitute a different title.
3077 &$randstr: The random number from wfRandom()
3078 &$isRedir: Boolean, whether to select a redirect or non-redirect
3079 &$namespaces: An array of namespace indexes to get the title from
3080 &$extra: An array of extra SQL statements
3081 &$title: If the hook returns false, a Title object to use instead of the
3082   result from the normal query
3084 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3085 instead.
3086 Called after building form options at RecentChanges.
3087 $special: the special page object
3088 &$filters: associative array of filter definitions. The keys are the HTML
3089   name/URL parameters. Each key maps to an associative array with a 'msg'
3090   (message key) and a 'default' value.
3092 'SpecialRecentChangesPanel': Called when building form options in
3093 SpecialRecentChanges.
3094 &$extraOpts: array of added items, to which can be added
3095 $opts: FormOptions for this request
3097 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
3098 instead.
3099 Called when building SQL query for SpecialRecentChanges and
3100 SpecialRecentChangesLinked.
3101 &$conds: array of WHERE conditionals for query
3102 &$tables: array of tables to be queried
3103 &$join_conds: join conditions for the tables
3104 $opts: FormOptions for this request
3105 &$query_options: array of options for the database request
3106 &$select: Array of columns to select
3108 'SpecialResetTokensTokens': Called when building token list for
3109 SpecialResetTokens.
3110 &$tokens: array of token information arrays in the format of
3111         array(
3112                 'preference' => '<preference-name>',
3113                 'label-message' => '<message-key>',
3114         )
3116 'SpecialSearchCreateLink': Called when making the message to create a page or
3117 go to the existing page.
3118 $t: title object searched for
3119 &$params: an array of the default message name and page title (as parameter)
3121 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3122 canceled and a normal search will be performed. Returning true without setting
3123 $url does a standard redirect to $title. Setting $url redirects to the
3124 specified URL.
3125 $term: The string the user searched for
3126 $title: The title the 'go' feature has decided to forward the user to
3127 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3129 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3130 target doesn't exist.
3131 &$title: title object generated from the text entered by the user
3133 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3134 the advanced form, a.k.a. power search box.
3135 &$showSections: an array to add values with more options to
3136 $term: the search term (not a title object)
3137 $opts: an array of hidden options (containing 'redirs' and 'profile')
3139 'SpecialSearchProfileForm': Allows modification of search profile forms.
3140 $search: special page object
3141 &$form: String: form html
3142 $profile: String: current search profile
3143 $term: String: search term
3144 $opts: Array: key => value of hidden options for inclusion in custom forms
3146 'SpecialSearchProfiles': Allows modification of search profiles.
3147 &$profiles: profiles, which can be modified.
3149 'SpecialSearchResults': Called before search result display
3150 $term: string of search term
3151 &$titleMatches: empty or SearchResultSet object
3152 &$textMatches: empty or SearchResultSet object
3154 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3155 on the search results page.  Useful for including an external search
3156 provider.  To disable the output of MediaWiki search output, return
3157 false.
3158 $specialSearch: SpecialSearch object ($this)
3159 $output: $wgOut
3160 $term: Search term specified by the user
3162 'SpecialSearchResultsAppend': Called immediately before returning HTML
3163 on the search results page.  Useful for including a feedback link.
3164 $specialSearch: SpecialSearch object ($this)
3165 $output: $wgOut
3166 $term: Search term specified by the user
3168 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3169 $search: SpecialSearch special page object
3170 $profile: String: current search profile
3171 $engine: the search engine
3173 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3174 &$extraStats: Array to save the new stats
3175         $extraStats['<name of statistic>'] => <value>;
3176   <value> can be an array with the keys "name" and "number":
3177   "name" is the HTML to be displayed in the name column
3178   "number" is the number to be displayed.
3179   or, <value> can be the number to be displayed and <name> is the
3180   message key to use in the name column,
3181 $context: IContextSource object
3183 'SpecialTrackingCategories::preprocess': Called after LinkBatch on Special:TrackingCategories
3184 $specialPage: The SpecialTrackingCategories object
3185 $trackingCategories: Array of data from Special:TrackingCategories with msg and cats
3187 'SpecialTrackingCategories::generateCatLink': Called for each cat link on Special:TrackingCategories
3188 $specialPage: The SpecialTrackingCategories object
3189 $catTitle: The Title object of the linked category
3190 &$html: The Result html
3192 'SpecialUploadComplete': Called after successfully uploading a file from
3193 Special:Upload.
3194 &$form: The SpecialUpload object
3196 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3197 $wgVersion: Current $wgVersion for you to use
3198 &$versionUrl: Raw url to link to (eg: release notes)
3200 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3201 instead.
3202 Called after building form options at Watchlist.
3203 $special: the special page object
3204 &$filters: associative array of filter definitions. The keys are the HTML
3205   name/URL parameters. Each key maps to an associative array with a 'msg'
3206   (message key) and a 'default' value.
3208 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3209 SpecialWatchlist. Allows extensions to register custom values they have
3210 inserted to rc_type so they can be returned as part of the watchlist.
3211 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3213 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3214 Called when building sql query for SpecialWatchlist.
3215 &$conds: array of WHERE conditionals for query
3216 &$tables: array of tables to be queried
3217 &$join_conds: join conditions for the tables
3218 &$fields: array of query fields
3219 $opts: A FormOptions object with watchlist options for the current request
3221 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3222 URL for a title when we have no other parameters on the URL. Gives a chance for
3223 extensions that alter page view behavior radically to abort that redirect or
3224 handle it manually.
3225 $request: WebRequest
3226 $title: Title of the currently found title obj
3227 $output: OutputPage object
3229 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3230 rendered (by ThumbnailImage:toHtml method).
3231 $thumbnail: the ThumbnailImage object
3232 &$attribs: image attribute array
3233 &$linkAttribs: image link attribute array
3235 'TitleArrayFromResult': Called when creating an TitleArray object from a
3236 database result.
3237 &$titleArray: set this to an object to override the default object returned
3238 $res: database result used to create the object
3240 'TitleExists': Called when determining whether a page exists at a given title.
3241 $title: The title being tested.
3242 &$exists: Whether the title exists.
3244 'TitleGetEditNotices': Allows extensions to add edit notices
3245 $title: The Title object for the page the edit notices are for
3246 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3247 &$notices: Array of notices. Keys are i18n message keys, values are
3248 parseAsBlock()ed messages.
3250 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3251 that can be applied.
3252 $title: The title in question.
3253 &$types: The types of protection available.
3255 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3256 overriding default behavior for determining if a page exists. If $isKnown is
3257 kept as null, regular checks happen. If it's a boolean, this value is returned
3258 by the isKnown method.
3259 $title: Title object that is being checked
3260 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3262 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3263 that this hook is not called for interwiki pages or pages in immovable
3264 namespaces: for these, isMovable() always returns false.
3265 $title: Title object that is being checked
3266 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3267   Hooks may change this value to override the return value of
3268   Title::isMovable().
3271 'TitleMove': Before moving an article (title).
3272 $old: old title
3273 $nt: new title
3274 $user: user who does the move
3276 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3277 $old: old title
3278 $nt: new title
3279 $user: user who does the move
3281 'TitleMoveComplete': After moving an article (title), post-commit.
3282 &$old: old title
3283 &$nt: new title
3284 &$user: user who did the move
3285 $pageid: database ID of the page that's been moved
3286 $redirid: database ID of the created redirect
3287 $reason: reason for the move
3288 $revision: the Revision created by the move
3290 'TitleMoveCompleting': After moving an article (title), pre-commit.
3291 $old: old title
3292 $nt: new title
3293 $user: user who did the move
3294 $pageid: database ID of the page that's been moved
3295 $redirid: database ID of the created redirect
3296 $reason: reason for the move
3297 $revision: the Revision created by the move
3299 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3300 or override the quick permissions check.
3301 $title: The Title object being accessed
3302 $user: The User performing the action
3303 $action: Action being performed
3304 &$errors: Array of errors
3305 $doExpensiveQueries: Whether to do expensive DB queries
3306 $short: Whether to return immediately on first error
3308 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3309 adding the default error message if nothing allows the user to read the page. If
3310 a handler wants a title to *not* be whitelisted, it should also return false.
3311 $title: Title object being checked against
3312 $user: Current user object
3313 &$whitelisted: Boolean value of whether this title is whitelisted
3315 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3316 $title: Title object to purge
3317 &$urls: An array of URLs to purge from the caches, to be manipulated.
3319 'UnblockUser': Before an IP address or user is unblocked.
3320 &$block: The Block object about to be saved
3321 &$user: The user performing the unblock (not the one being unblocked)
3322 &$reason: If the hook is aborted, the error message to be returned in an array
3324 'UnblockUserComplete': After an IP address or user has been unblocked.
3325 $block: The Block object that was saved
3326 $user: The user who performed the unblock (not the one being unblocked)
3328 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3329 PageArchive object has been created but before any further processing is done.
3330 &$archive: PageArchive object
3331 $title: Title object of the page that we're viewing
3333 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3334 PageArchive object has been created but before any further processing is done.
3335 &$archive: PageArchive object
3336 $title: Title object of the page that we're viewing
3338 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3339 the site is not in read-only mode, that the Title object is not null and after
3340 a PageArchive object has been constructed but before performing any further
3341 processing.
3342 &$archive: PageArchive object
3343 $title: Title object of the page that we're about to undelete
3345 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3346 $title: title object related to the revision
3347 $rev: revision (object) that will be viewed
3349 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3350 Since 1.24: Paths pointing to a directory will be recursively scanned for
3351 test case files matching the suffix "Test.php".
3352 &$paths: list of test cases and directories to search.
3354 'UnknownAction': DEPRECATED! To add an action in an extension,
3355 create a subclass of Action, and add a new key to $wgActions.
3356 An unknown "action" has occurred (useful for defining your own actions).
3357 $action: action name
3358 $article: article "acted on"
3360 'UnwatchArticle': Before a watch is removed from an article.
3361 &$user: user watching
3362 &$page: WikiPage object to be removed
3363 &$status: Status object to be returned if the hook returns false
3365 'UnwatchArticleComplete': After a watch is removed from an article.
3366 $user: user that watched
3367 &$page: WikiPage object that was watched
3369 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3370 &$formattedPageStatus: list of valid page states
3372 'UploadComplete': Upon completion of a file upload.
3373 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3374   $uploadBase->getLocalFile().
3376 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3377 $type: (string) the requested upload type
3378 &$className: the class name of the Upload instance to be created
3380 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3381 poke at member variables like $mUploadDescription before the file is saved. Do
3382 not use this hook to break upload processing. This will return the user to a
3383 blank form with no error message; use UploadVerification and UploadVerifyFile
3384 instead.
3385 &$form: UploadForm object
3387 'UploadForm:initial': Before the upload form is generated. You might set the
3388 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3389 text (HTML) either before or after the editform.
3390 &$form: UploadForm object
3392 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3393 assembled.
3394 &$descriptor: (array) the HTMLForm descriptor
3396 'UploadFormSourceDescriptors': after the standard source inputs have been
3397 added to the descriptor
3398 &$descriptor: (array) the HTMLForm descriptor
3399 &$radio: Boolean, if source type should be shown as radio button
3400 $selectedSourceType: The selected source type
3402 'UploadStashFile': Before a file is stashed (uploaded to stash).
3403 Note that code which has not been updated for MediaWiki 1.28 may not call this
3404 hook. If your extension absolutely, positively must prevent some files from
3405 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3406 $upload: (object) An instance of UploadBase, with all info about the upload
3407 $user: (object) An instance of User, the user uploading this file
3408 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3409 &$error: output: If the file stashing should be prevented, set this to the reason
3410   in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3411   instance (you might want to use ApiMessage to provide machine-readable details
3412   for the API).
3414 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3415 Additional chances to reject an uploaded file.
3416 $saveName: (string) destination file name
3417 $tempName: (string) filesystem path to the temporary file for checks
3418 &$error: (string) output: message key for message to show if upload canceled by
3419   returning false. May also be an array, where the first element is the message
3420   key and the remaining elements are used as parameters to the message.
3422 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3423 in most cases over UploadVerification.
3424 $upload: (object) an instance of UploadBase, with all info about the upload
3425 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3426   Handlers will typically only apply for specific MIME types.
3427 &$error: (object) output: true if the file is valid. Otherwise, set this to the reason
3428   in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3429   instance (you might want to use ApiMessage to provide machine-readable details
3430   for the API).
3432 'UploadVerifyUpload': Upload verification, based on both file properties like
3433 MIME type (same as UploadVerifyFile) and the information entered by the user
3434 (upload comment, file page contents etc.).
3435 $upload: (object) An instance of UploadBase, with all info about the upload
3436 $user: (object) An instance of User, the user uploading this file
3437 $props: (array) File properties, as returned by FSFile::getPropsFromPath()
3438 $comment: (string) Upload log comment (also used as edit summary)
3439 $pageText: (string) File description page text (only used for new uploads)
3440 &$error: output: If the file upload should be prevented, set this to the reason
3441   in the form of array( messagename, param1, param2, ... ) or a MessageSpecifier
3442   instance (you might want to use ApiMessage to provide machine-readable details
3443   for the API).
3445 'UserIsBot': when determining whether a user is a bot account
3446 $user: the user
3447 &$isBot: whether this is user a bot or not (boolean)
3449 'User::mailPasswordInternal': before creation and mailing of a user's new
3450 temporary password
3451 &$user: the user who sent the message out
3452 &$ip: IP of the user who sent the message out
3453 &$u: the account whose new password will be set
3455 'UserAddGroup': Called when adding a group; return false to override
3456 stock group addition.
3457 $user: the user object that is to have a group added
3458 &$group: the group to add, can be modified
3460 'UserArrayFromResult': Called when creating an UserArray object from a database
3461 result.
3462 &$userArray: set this to an object to override the default object returned
3463 $res: database result used to create the object
3465 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3466 want to display an error message, try getUserPermissionsErrors.
3467 &$title: Title object being checked against
3468 &$user: Current user object
3469 $action: Action being checked
3470 &$result: Pointer to result returned if hook returns false. If null is returned,
3471   userCan checks are continued by internal code.
3473 'UserCanSendEmail': To override User::canSendEmail() permission check.
3474 &$user: User (object) whose permission is being checked
3475 &$canSend: bool set on input, can override on output
3477 'UserClearNewTalkNotification': Called when clearing the "You have new
3478 messages!" message, return false to not delete it.
3479 &$user: User (object) that will clear the message
3480 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3482 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3483 Manipulate the login form.
3484 &$template: SimpleTemplate instance for the form
3486 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3487 &$user: User to get groups for
3488 &$groups: Current effective groups
3490 'UserGetAllRights': After calculating a list of all available rights.
3491 &$rights: Array of rights, which may be added to.
3493 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3494 before returning the options to the caller. Warning: This hook is called for
3495 every call to User::getDefaultOptions(), which means it's potentially called
3496 dozens or hundreds of times. You may want to cache the results of non-trivial
3497 operations in your hook function for this reason.
3498 &$defaultOptions: Array of preference keys and their default values.
3500 'UserGetEmail': Called when getting an user email address.
3501 $user: User object
3502 &$email: email, change this to override local email
3504 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3505 email authentication.
3506 $user: User object
3507 &$timestamp: timestamp, change this to override local email authentication
3508   timestamp
3510 'UserGetImplicitGroups': DEPRECATED!
3511 Called in User::getImplicitGroups().
3512 &$groups: List of implicit (automatically-assigned) groups
3514 'UserGetLanguageObject': Called when getting user's interface language object.
3515 $user: User object
3516 &$code: Language code that will be used to create the object
3517 $context: IContextSource object
3519 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3520 &$reservedUsernames: $wgReservedUsernames
3522 'UserGetRights': Called in User::getRights().
3523 $user: User to get rights for
3524 &$rights: Current rights
3526 'UserGroupsChanged': Called after user groups are changed.
3527 $user: User whose groups changed
3528 $added: Groups added
3529 $removed: Groups removed
3530 $performer: User who performed the change, false if via autopromotion
3531 $reason: The reason, if any, given by the user performing the change,
3532 false if via autopromotion.
3534 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3535 specific block exemptions).
3536 $user: User in question
3537 $title: Title of the page in question
3538 &$blocked: Out-param, whether or not the user is blocked from that page.
3539 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3540   to edit their own user talk pages.
3542 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3543 &$user: User object
3544 $ip: User's IP address
3545 &$blocked: Whether the user is blocked, to be modified by the hook
3546 &$block: The Block object, to be modified by the hook
3548 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3549 false if a UserGetRights hook might remove the named right.
3550 $right: The user right being checked
3552 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3553 $user: User in question.
3554 &$hidden: Set true if the user's name should be hidden.
3556 'UserIsLocked': Check if the user is locked. See User::isLocked().
3557 $user: User in question.
3558 &$locked: Set true if the user should be locked.
3560 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3561 environmental means; occurs after session is loaded.
3562 $user: user object being loaded
3564 'UserLoadDefaults': Called when loading a default user.
3565 $user: user object
3566 $name: user name
3568 'UserLoadFromDatabase': Called when loading a user from the database.
3569 $user: user object
3570 &$s: database query object
3572 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3573 Called to authenticate users on external/environmental means; occurs before
3574 session is loaded.
3575 $user: user object being loaded
3576 &$result: set this to a boolean value to abort the normal authentication
3577   process
3579 'UserLoadOptions': When user options/preferences are being loaded from the
3580 database.
3581 $user: User object
3582 &$options: Options, can be modified.
3584 'UserLoggedIn': Called after a user is logged in
3585 $user: User object for the logged-in user
3587 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3588 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3589 &$user: the user object that was created on login
3590 &$inject_html: Any HTML to inject after the "logged in" message.
3591 $direct: (bool) The hook is called directly after a successful login. This will only happen once
3592   per login. A UserLoginComplete call with direct=false can happen when the user visits the login
3593   page while already logged in.
3595 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3596 Manipulate the login form.
3597 &$template: QuickTemplate instance for the form
3599 'UserLogout': Before a user logs out.
3600 &$user: the user object that is about to be logged out
3602 'UserLogoutComplete': After a user has logged out.
3603 &$user: the user object _after_ logout (won't have name, ID, etc.)
3604 &$inject_html: Any HTML to inject after the "logged out" message.
3605 $oldName: name of the user before logout (string)
3607 'UserMailerChangeReturnPath': Called to generate a VERP return address
3608 when UserMailer sends an email, with a bounce handling extension.
3609 $to: Array of MailAddress objects for the recipients
3610 &$returnPath: The return address string
3612 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3613 to split up an email with multiple the To: field into separate emails.
3614 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3616 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3617 Extensions can block sending the email by returning false and setting $error.
3618 $to: array of MailAdresses of the targets
3619 $from: MailAddress of the sender
3620 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3621 &$error: should be set to an error message string
3623 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3624 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3625 $to: array of MailAdresses of the targets
3626 $from: MailAddress of the sender
3627 &$subject: email subject (not MIME encoded)
3628 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3629 &$body: email body (in MIME format) as a string
3630 &$error: should be set to an error message string
3632 'UserRemoveGroup': Called when removing a group; return false to override stock
3633 group removal.
3634 $user: the user object that is to have a group removed
3635 &$group: the group to be removed, can be modified
3637 'UserRequiresHTTPS': Called to determine whether a user needs
3638 to be switched to HTTPS.
3639 $user: User in question.
3640 &$https: Boolean whether $user should be switched to HTTPS.
3642 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3643 have been requested to be reset. This hook can be used to exclude certain
3644 options from being reset even when the user has requested all prefs to be reset,
3645 because certain options might be stored in the user_properties database table
3646 despite not being visible and editable via Special:Preferences.
3647 $user: the User (object) whose preferences are being reset
3648 &$newOptions: array of new (site default) preferences
3649 $options: array of the user's old preferences
3650 $resetKinds: array containing the kinds of preferences to reset
3652 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3653 message(s).
3654 &$user: user retrieving new talks messages
3655 &$talks: array of new talks page(s)
3657 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3658 After a user's group memberships are changed.
3659 &$user: User object that was changed
3660 $add: Array of strings corresponding to groups added
3661 $remove: Array of strings corresponding to groups removed
3663 'UserSaveOptions': Called just before saving user preferences/options.
3664 $user: User object
3665 &$options: Options, modifiable
3667 'UserSaveSettings': Called when saving user settings.
3668 $user: User object
3670 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3671 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3672 instead. Otherwise, you can no longer count on user data being saved to cookies
3673 versus some other mechanism.
3674 Called when setting user cookies.
3675 $user: User object
3676 &$session: session array, will be added to the session
3677 &$cookies: cookies array mapping cookie name to its value
3679 'UserSetEmail': Called when changing user email address.
3680 $user: User object
3681 &$email: new email, change this to override new email address
3683 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3684 email authentication.
3685 $user: User object
3686 &$timestamp: new timestamp, change this to override local email
3687 authentication timestamp
3689 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3690 "Foobar (Talk | Contribs | Block)".
3691 $userId: User id of the current user
3692 $userText: User name of the current user
3693 &$items: Array of user tool links as HTML fragments
3695 'UsersPagerDoBatchLookups': Called in UsersPager::doBatchLookups() to give
3696 extensions providing user group data from an alternate source a chance to add
3697 their data into the cache array so that things like global user groups are
3698 displayed correctly in Special:ListUsers.
3699 $dbr: Read-only database handle
3700 $userIds: Array of user IDs whose groups we should look up
3701 &$cache: Array of user ID -> internal user group name (e.g. 'sysop') mappings
3702 &$groups: Array of group name -> bool true mappings for members of a given user
3703 group
3705 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3706 FormatMetadata::getExtendedMeta (return false means cache will be
3707 invalidated and GetExtendedMetadata hook called again).
3708 $timestamp: The timestamp metadata was generated
3709 $file: The file the metadata is for
3711 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3712 used to alter the SQL query which gets the list of wanted pages.
3713 &$wantedPages: WantedPagesPage object
3714 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3716 'WatchArticle': Before a watch is added to an article.
3717 &$user: user that will watch
3718 &$page: WikiPage object to be watched
3719 &$status: Status object to be returned if the hook returns false
3721 'WatchArticleComplete': After a watch is added to an article.
3722 &$user: user that watched
3723 &$page: WikiPage object watched
3725 'WatchedItemQueryServiceExtensions': Create a WatchedItemQueryServiceExtension.
3726 &$extensions: Add WatchedItemQueryServiceExtension objects to this array
3727 $watchedItemQueryService: Service object
3729 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3730 form, used to manipulate the list of pages or preload data based on that list.
3731 &$watchlistInfo: array of watchlisted pages in
3732   [namespaceId => ['title1' => 1, 'title2' => 1]] format
3734 'WatchlistEditorBuildRemoveLine': when building remove lines in
3735 Special:Watchlist/edit.
3736 &$tools: array of extra links
3737 $title: Title object
3738 $redirect: whether the page is a redirect
3739 $skin: Skin object
3740 &$link: HTML link to title
3742 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3743 REQUEST_URI.
3744 $router: The PathRouter instance
3746 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3747 Return false to prevent setting of the cookie.
3748 &$name: Cookie name passed to WebResponse::setcookie()
3749 &$value: Cookie value passed to WebResponse::setcookie()
3750 &$expire: Cookie expiration, as for PHP's setcookie()
3751 &$options: Options passed to WebResponse::setcookie()
3753 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3754 run a MediaWiki cli script.
3755 &$script: MediaWiki cli script path
3756 &$parameters: Array of arguments and options to the script
3757 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3758   keys
3760 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3761 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3762 &$qp: The list of QueryPages
3764 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3765 $row: The DB row of the entry.
3766 $title: The Title of the page where the link comes FROM
3767 $target: The Title of the page where the link goes TO
3768 &$props: Array of HTML strings to display after the title.
3770 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3771 dumps. One, and only one hook should set this, and return false.
3772 &$tables: Database tables to use in the SELECT query
3773 &$opts: Options to use for the query
3774 &$join: Join conditions
3776 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3777 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3778 specific to a content model should be provided by the respective Content's
3779 getDeletionUpdates() method.
3780 $page: the WikiPage
3781 $content: the Content to generate updates for (or null, if the Content could not be loaded
3782 due to an error)
3783 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3785 'WikiPageFactory': Override WikiPage class used for a title
3786 $title: Title of the page
3787 &$page: Variable to set the created WikiPage to.
3789 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3790 extra metadata to be added.
3791 $obj: The XmlDumpWriter object.
3792 &$out: The output string.
3793 $row: The database row for the page.
3794 $title: The title of the page.
3796 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3797 add extra metadata.
3798 &$obj: The XmlDumpWriter object.
3799 &$out: The text being output.
3800 $row: The database row for the revision.
3801 $text: The revision text.
3803 More hooks might be available but undocumented, you can execute
3804 "php maintenance/findHooks.php" to find hidden ones.