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