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