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