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