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