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