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