Fix docs for GetUserBlock hooks
[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 onArticleShow( &$article ) {
95 # ...
96 }
97
98 function onArticleDelete( &$article ) {
99 # ...
100 }
101
102 function onArticleExport( &$article ) {
103 # ...
104 }
105
106 General practice is to have a dedicated file for functions activated by hooks,
107 which functions named 'onHookName'. In the example above, the file
108 'ReverseHooks.php' includes the functions that should be activated by the
109 'ArticleShow', 'ArticleDelete', and 'ArticleExport' hooks. The 'extension.json'
110 file with the extension's registration just has to add its hook functions
111 to the appropriate events:
112
113 "Hooks": {
114 "ArticleShow": "ReverseHooks:onArticleShow",
115 "ArticleDelete": "ReverseHooks::onArticleDelete",
116 "ArticleExport": "ReverseHooks::onArticleExport"
117 }
118
119 Having all this code related to the title-reversion option in one place means
120 that it's easier to read and understand; you don't have to do a grep-find to see
121 where the $wgReverseTitle variable is used, say.
122
123 If the code is well enough isolated, it can even be excluded when not used --
124 making for some slight savings in memory and load-up performance at runtime.
125 Admins who want to have all the reversed titles can add:
126
127 require_once 'extensions/ReverseTitle.php';
128
129 ...to their LocalSettings.php file; those of us who don't want or need it can
130 just leave it out.
131
132 The extensions don't even have to be shipped with MediaWiki; they could be
133 provided by a third-party developer or written by the admin him/herself.
134
135 ==Writing hooks==
136
137 A hook is a chunk of code run at some particular event. It consists of:
138
139 * a function with some optional accompanying data, or
140 * an object with a method and some optional accompanying data.
141
142 Hooks are registered by adding them to the global $wgHooks array for a given
143 event. All the following are valid ways to define hooks:
144
145 $wgHooks['EventName'][] = 'someFunction'; # function, no data
146 $wgHooks['EventName'][] = [ 'someFunction', $someData ];
147 $wgHooks['EventName'][] = [ 'someFunction' ]; # weird, but OK
148
149 $wgHooks['EventName'][] = $object; # object only
150 $wgHooks['EventName'][] = [ $object, 'someMethod' ];
151 $wgHooks['EventName'][] = [ $object, 'someMethod', $someData ];
152 $wgHooks['EventName'][] = [ $object ]; # weird but OK
153
154 When an event occurs, the function (or object method) will be called with the
155 optional data provided as well as event-specific parameters. The above examples
156 would result in the following code being executed when 'EventName' happened:
157
158 # function, no data
159 someFunction( $param1, $param2 )
160 # function with data
161 someFunction( $someData, $param1, $param2 )
162
163 # object only
164 $object->onEventName( $param1, $param2 )
165 # object with method
166 $object->someMethod( $param1, $param2 )
167 # object with method and data
168 $object->someMethod( $someData, $param1, $param2 )
169
170 Note that when an object is the hook, and there's no specified method, the
171 default method called is 'onEventName'. For different events this would be
172 different: 'onArticleSave', 'onUserLogin', etc.
173
174 The extra data is useful if we want to use the same function or object for
175 different purposes. For example:
176
177 $wgHooks['PageContentSaveComplete'][] = [ 'ircNotify', 'TimStarling' ];
178 $wgHooks['PageContentSaveComplete'][] = [ 'ircNotify', 'brion' ];
179
180 This code would result in ircNotify being run twice when an article is saved:
181 once for 'TimStarling', and once for 'brion'.
182
183 Hooks can return three possible values:
184
185 * No return value (or null): the hook has operated successfully. Previously,
186 true was required. This is the default since MediaWiki 1.23.
187 * "some string": an error occurred; processing should stop and the error
188 should be shown to the user
189 * false: the hook has successfully done the work necessary and the calling
190 function should skip
191
192 The last result would be for cases where the hook function replaces the main
193 functionality. For example, if you wanted to authenticate users to a custom
194 system (LDAP, another PHP program, whatever), you could do:
195
196 $wgHooks['UserLogin'][] = [ 'ldapLogin', $ldapServer ];
197
198 function ldapLogin( $username, $password ) {
199 # log user into LDAP
200 return false;
201 }
202
203 Returning false makes less sense for events where the action is complete, and
204 will normally be ignored.
205
206 Note that none of the examples made use of create_function() as a way to
207 attach a function to a hook. This is known to cause problems (notably with
208 Special:Version), and should be avoided when at all possible.
209
210 ==Using hooks==
211
212 A calling function or method uses the Hooks::run() function to run the hooks
213 related to a particular event, like so:
214
215 class Article {
216 # ...
217 function protect() {
218 global $wgUser;
219
220 // Avoid PHP 7.1 warning from passing $this by reference
221 $article = $this;
222
223 if ( Hooks::run( 'ArticleProtect', [ &$article, &$wgUser ] ) ) {
224 # protect the article
225 Hooks::run( 'ArticleProtectComplete', [ &$article, &$wgUser ] );
226 }
227 }
228 }
229
230 Hooks::run() returns true if the calling function should continue processing
231 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
232 error occurred, or one of the hooks handled the action already). Checking the
233 return value matters more for "before" hooks than for "complete" hooks.
234
235 Note that hook parameters are passed in an array; this is a necessary
236 inconvenience to make it possible to pass reference values (which can be changed)
237 by the hook callback.
238
239 ==Events and parameters==
240
241 This is a list of known events and parameters; please add to it if you're going
242 to add events to the MediaWiki code.
243
244 'AbortAutoblock': Return false to cancel an autoblock.
245 $autoblockip: The IP going to be autoblocked.
246 &$block: The block from which the autoblock is coming.
247
248 'AbortDiffCache': Can be used to cancel the caching of a diff.
249 &$diffEngine: DifferenceEngine object
250
251 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
252 $editor: The User who made the change.
253 $title: The Title of the page that was edited.
254 $rc: The current RecentChange object.
255
256 'AbortTalkPageEmailNotification': Return false to cancel talk page email
257 notification
258 $targetUser: the user whom to send talk page email notification
259 $title: the page title
260
261 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
262 $name: name of the action
263 &$form: HTMLForm object
264 $article: Article object
265
266 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
267 Allows to change the fields on the form that will be generated.
268 $name: name of the action
269 &$fields: HTMLForm descriptor array
270 $article: Article object
271
272 'AddNewAccount': DEPRECATED since 1.27! Use LocalUserCreated.
273 After a user account is created.
274 $user: the User object that was created. (Parameter added in 1.7)
275 $byEmail: true when account was created "by email" (added in 1.12)
276
277 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom,
278 rss,...) are created. Can be used to omit specific feeds from being outputted.
279 You must not use this hook to add feeds, use OutputPage::addFeedLink() instead.
280 &$feedLinks: Array of created feed links
281
282 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
283 before OutputPage::sendCacheControl() and final ob_end_flush() which
284 will send the buffered output to the client. This allows for last-minute
285 modification of the output within the buffer by using ob_get_clean().
286 $output: The OutputPage object where output() was called
287
288 'AfterImportPage': When a page import is completed.
289 $title: Title under which the revisions were imported
290 $foreignTitle: ForeignTitle object based on data provided by the XML file
291 $revCount: Number of revisions in the XML file
292 $sRevCount: Number of successfully imported revisions
293 $pageInfo: associative array of page information
294
295 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
296 just before adding its HTML to parser output.
297 $parser: Parser object that called the hook
298 $ig: Gallery, an object of one of the gallery classes (inheriting from
299 ImageGalleryBase)
300 &$html: HTML generated by the gallery
301
302 'AlternateEdit': Before checking if a user can edit a page and before showing
303 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
304 $editPage: the EditPage object
305
306 'AlternateEditPreview': Before generating the preview of the page when editing
307 ( EditPage::getPreviewText() ).
308 Return false and set $previewHTML and $parserOutput to output custom page
309 preview HTML.
310 $editPage: the EditPage object
311 &$content: the Content object for the text field from the edit page
312 &$previewHTML: Text to be placed into the page for the preview
313 &$parserOutput: the ParserOutput object for the preview
314
315 'AlternateUserMailer': Called before mail is sent so that mail could be logged
316 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
317 the regular method of sending mail. Return a string to return a php-mail-error
318 message containing the error. Returning true will continue with sending email
319 in the regular way.
320 $headers: Associative array of headers for the email
321 $to: MailAddress object or array
322 $from: From address
323 $subject: Subject of the email
324 $body: Body of the message
325
326 'AncientPagesQuery': Allow extensions to modify the query used by
327 Special:AncientPages.
328 &$tables: tables to join in the query
329 &$conds: conditions for the query
330 &$joinConds: join conditions for the query
331
332 'APIAfterExecute': After calling the execute() method of an API module. Use
333 this to extend core API modules.
334 &$module: Module object
335
336 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
337 &$main: ApiMain object
338
339 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
340 authenticate and authorize API clients before executing the module. Return
341 false and set a message to cancel the request.
342 $module: Module object
343 $user: Current user
344 &$message: API message to die with. Specific values accepted depend on the
345 MediaWiki version:
346 * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
347 pass to ApiBase::dieWithError().
348 * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
349 * Earlier: A key or key+parameters in ApiBase::$messageMap.
350
351 'ApiDeprecationHelp': Add messages to the 'deprecation-help' warning generated
352 from ApiBase::addDeprecation().
353 &$msgs: Message[] Messages to include in the help. Multiple messages will be
354 joined with spaces.
355
356 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
357 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
358 this hook may cancel the hook to signal that the item is not viewable in the
359 provided context.
360 $row: A row of data from ContribsPager. The set of data returned by
361 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
362 hook.
363 $context: An IContextSource implementation.
364 &$feedItem: Set this to a FeedItem instance if the callback can handle the
365 provided row. This is provided to the hook as a null, if it is non null then
366 another callback has already handled the hook.
367
368 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
369 highlighting, add output to $context->getOutput() and return false.
370 $context: An IContextSource.
371 $text: Text to be highlighted.
372 $mime: MIME type of $text.
373 $format: API format code for $text.
374
375 'APIGetAllowedParams': Use this hook to modify a module's parameters.
376 &$module: ApiBase Module object
377 &$params: Array of parameters
378 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
379
380 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
381 $module: ApiBase Module object
382 &$msg: Array of Message objects
383
384 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
385 descriptions.
386 $module: ApiBase Module object
387 &$msg: Array of arrays of Message objects
388
389 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
390 $module: ApiBase Module object
391 &$help: Array of HTML strings to be joined for the output.
392 $options: Array Options passed to ApiHelp::getHelp
393 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
394 the page and values as for Linker::generateTOC().
395
396 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
397 module manager. Can be used to conditionally register API modules.
398 $moduleManager: ApiModuleManager Module manager instance
399
400 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
401 an exception is thrown during API action execution.
402 $apiMain: Calling ApiMain instance.
403 $e: Exception object.
404
405 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
406 extensions to adjust the ParserOptions before parsing.
407 $options: ParserOptions object
408 $title: Title to be parsed
409 $params: Parameter array for the API module
410 $module: API module (which is also a ContextSource)
411 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
412 &$suppressCache: Set true if cache should be suppressed.
413
414 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
415 can alter or append to the array.
416 &$results: array with integer keys to associative arrays. Keys in associative
417 array:
418 - title: Title object.
419 - redirect from: Title or null.
420 - extract: Description for this result.
421 - extract trimmed: If truthy, the extract will not be trimmed to
422 $wgOpenSearchDescriptionLength.
423 - image: Thumbnail for this result. Value is an array with subkeys 'source'
424 (url), 'width', 'height', 'alt', 'align'.
425 - url: Url for the given title.
426
427 'ApiOptions': Called by action=options before applying changes to user
428 preferences.
429 $apiModule: Calling ApiOptions object
430 $user: User object whose preferences are being changed
431 $changes: Associative array of preference name => value
432 $resetKinds: Array of strings specifying which options kinds to reset.
433 See User::resetOptions() and User::getOptionKinds() for possible
434 values.
435
436 'ApiParseMakeOutputPage': Called when preparing the OutputPage object for
437 ApiParse. This is mainly intended for calling OutputPage::addContentOverride()
438 or OutputPage::addContentOverrideCallback().
439 $module: ApiBase (which is also a ContextSource)
440 $output: OutputPage
441
442 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
443 module manager. Can be used to conditionally register API query modules.
444 $moduleManager: ApiModuleManager Module manager instance
445
446 'APIQueryAfterExecute': After calling the execute() method of an
447 action=query submodule. Use this to extend core API modules.
448 &$module: Module object
449
450 'ApiQueryBaseAfterQuery': Called for (some) API query modules after the
451 database query has returned. An API query module wanting to use this hook
452 should see the ApiQueryBase::select() and ApiQueryBase::processRow()
453 documentation.
454 $module: ApiQueryBase module in question
455 $result: ResultWrapper|bool returned from the IDatabase::select()
456 &$hookData: array that was passed to the 'ApiQueryBaseBeforeQuery' hook and
457 will be passed to the 'ApiQueryBaseProcessRow' hook, intended for inter-hook
458 communication.
459
460 'ApiQueryBaseBeforeQuery': Called for (some) API query modules before a
461 database query is made. WARNING: It would be very easy to misuse this hook and
462 break the module! Any joins added *must* join on a unique key of the target
463 table unless you really know what you're doing. An API query module wanting to
464 use this hook should see the ApiQueryBase::select() and
465 ApiQueryBase::processRow() documentation.
466 $module: ApiQueryBase module in question
467 &$tables: array of tables to be queried
468 &$fields: array of columns to select
469 &$conds: array of WHERE conditionals for query
470 &$query_options: array of options for the database request
471 &$join_conds: join conditions for the tables
472 &$hookData: array that will be passed to the 'ApiQueryBaseAfterQuery' and
473 'ApiQueryBaseProcessRow' hooks, intended for inter-hook communication.
474
475 'ApiQueryBaseProcessRow': Called for (some) API query modules as each row of
476 the database result is processed. Return false to stop processing the result
477 set. An API query module wanting to use this hook should see the
478 ApiQueryBase::select() and ApiQueryBase::processRow() documentation.
479 $module: ApiQueryBase module in question
480 $row: stdClass Database result row
481 &$data: array to be included in the ApiResult.
482 &$hookData: array that was be passed to the 'ApiQueryBaseBeforeQuery' and
483 'ApiQueryBaseAfterQuery' hooks, intended for inter-hook communication.
484
485 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
486 an action=query submodule. Use this to extend core API modules.
487 &$module: Module object
488 &$resultPageSet: ApiPageSet object
489
490 'APIQueryInfoTokens': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes
491 instead. Use this hook to add custom tokens to prop=info. Every token has an
492 action, which will be used in the intoken parameter and in the output
493 (actiontoken="..."), and a callback function which should return the token, or
494 false if the user isn't allowed to obtain it. The prototype of the callback
495 function is func($pageid, $title), where $pageid is the page ID of the page the
496 token is requested for and $title is the associated Title object. In the hook,
497 just add your callback to the $tokenFunctions array and return true (returning
498 false makes no sense).
499 &$tokenFunctions: [ action => callback ]
500
501 'APIQueryRecentChangesTokens': DEPRECATED since 1.24! Use
502 ApiQueryTokensRegisterTypes instead.
503 Use this hook to add custom tokens to list=recentchanges. Every token has an
504 action, which will be used in the rctoken parameter and in the output
505 (actiontoken="..."), and a callback function which should return the token, or
506 false if the user isn't allowed to obtain it. The prototype of the callback
507 function is func($pageid, $title, $rc), where $pageid is the page ID of the
508 page associated to the revision the token is requested for, $title the
509 associated Title object and $rc the associated RecentChange object. In the
510 hook, just add your callback to the $tokenFunctions array and return true
511 (returning false makes no sense).
512 &$tokenFunctions: [ action => callback ]
513
514 'APIQueryRevisionsTokens': DEPRECATED since 1.24! Use
515 ApiQueryTokensRegisterTypes instead.
516 Use this hook to add custom tokens to prop=revisions. Every token has an
517 action, which will be used in the rvtoken parameter and in the output
518 (actiontoken="..."), and a callback function which should return the token, or
519 false if the user isn't allowed to obtain it. The prototype of the callback
520 function is func($pageid, $title, $rev), where $pageid is the page ID of the
521 page associated to the revision the token is requested for, $title the
522 associated Title object and $rev the associated Revision object. In the hook,
523 just add your callback to the $tokenFunctions array and return true (returning
524 false makes no sense).
525 &$tokenFunctions: [ action => callback ]
526
527 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
528 sites general information.
529 $module: the current ApiQuerySiteInfo module
530 &$results: array of results, add things here
531
532 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
533 sites statistics information.
534 &$results: array of results, add things here
535
536 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
537 action=query&meta=tokens. Note that most modules will probably be able to use
538 the 'csrf' token instead of creating their own token types.
539 &$salts: [ type => salt to pass to User::getEditToken(), or array of salt
540 and key to pass to Session::getToken() ]
541
542 'APIQueryUsersTokens': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes
543 instead.
544 Use this hook to add custom token to list=users. Every token has an action,
545 which will be used in the ustoken parameter and in the output
546 (actiontoken="..."), and a callback function which should return the token, or
547 false if the user isn't allowed to obtain it. The prototype of the callback
548 function is func($user) where $user is the User object. In the hook, just add
549 your callback to the $tokenFunctions array and return true (returning false
550 makes no sense).
551 &$tokenFunctions: [ action => callback ]
552
553 'ApiQueryWatchlistExtractOutputData': Extract row data for ApiQueryWatchlist.
554 $module: ApiQueryWatchlist instance
555 $watchedItem: WatchedItem instance
556 $recentChangeInfo: Array of recent change info data
557 &$vals: Associative array of data to be output for the row
558
559 'ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions': Populate the options
560 to be passed from ApiQueryWatchlist to WatchedItemQueryService.
561 $module: ApiQueryWatchlist instance
562 $params: Array of parameters, as would be returned by $module->extractRequestParams()
563 &$options: Array of options for WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
564
565 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
566 should have its own entry in the $apis array and have a unique name, passed as
567 key for the array that represents the service data. In this data array, the
568 key-value-pair identified by the apiLink key is required.
569 &$apis: array of services
570
571 'ApiTokensGetTokenTypes': DEPRECATED since 1.24! Use ApiQueryTokensRegisterTypes instead.
572 Use this hook to extend action=tokens with new token types.
573 &$tokenTypes: supported token types in format 'type' => callback function
574 used to retrieve this type of tokens.
575
576 'ApiValidatePassword': Called from ApiValidatePassword.
577 $module: ApiValidatePassword instance.
578 &$r: Result array.
579
580 'Article::MissingArticleConditions': Before fetching deletion & move log entries
581 to display a message of a non-existing page being deleted/moved, give extensions
582 a chance to hide their (unrelated) log entries.
583 &$conds: Array of query conditions (all of which have to be met; conditions will
584 AND in the final query)
585 $logTypes: Array of log types being queried
586
587 'ArticleAfterFetchContentObject': DEPRECATED since 1.32, use ArticleRevisionViewCustom
588 to control output. After fetching content of an article from the database.
589 &$article: the article (object) being loaded from the database
590 &$content: the content of the article, as a Content object
591
592 'ArticleConfirmDelete': Before writing the confirmation form for article
593 deletion.
594 $article: the article (object) being deleted
595 $output: the OutputPage object
596 &$reason: the reason (string) the article is being deleted
597
598 'ArticleContentOnDiff': Before showing the article content below a diff. Use
599 this to change the content in this area or how it is loaded.
600 $diffEngine: the DifferenceEngine
601 $output: the OutputPage object
602
603 'ArticleRevisionViewCustom': Allows custom rendering of an article's content.
604 Note that it is preferable to implement proper handing for a custom data type using
605 the ContentHandler facility.
606 $revision: content of the page, as a RevisionRecord object, or null if the revision
607 could not be loaded. May also be a fake that wraps content supplied by an extension.
608 $title: title of the page
609 $oldid: the requested revision id, or 0 for the currrent revision.
610 $output: a ParserOutput object
611
612 'ArticleContentViewCustom': DEPRECATED since 1.32, use ArticleRevisionViewCustom instead,
613 or provide an appropriate ContentHandler. Allows to output the text of the article in a
614 different format than wikitext.
615 $content: content of the page, as a Content object
616 $title: title of the page
617 $output: a ParserOutput object
618
619 'ArticleDelete': Before an article is deleted.
620 &$wikiPage: the WikiPage (object) being deleted
621 &$user: the user (object) deleting the article
622 &$reason: the reason (string) the article is being deleted
623 &$error: if the deletion was prohibited, the (raw HTML) error message to display
624 (added in 1.13)
625 &$status: Status object, modify this to throw an error. Overridden by $error
626 (added in 1.20)
627 $suppress: Whether this is a suppression deletion or not (added in 1.27)
628
629 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
630 $title: Title of the article that has been deleted.
631 $outputPage: OutputPage that can be used to append the output.
632
633 'ArticleDeleteComplete': After an article is deleted.
634 &$wikiPage: the WikiPage that was deleted
635 &$user: the user that deleted the article
636 $reason: the reason the article was deleted
637 $id: id of the article that was deleted
638 $content: the Content of the deleted page (or null, when deleting a broken page)
639 $logEntry: the ManualLogEntry used to record the deletion
640 $archivedRevisionCount: the number of revisions archived during the deletion
641
642 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
643 was changed.
644 &$wikiPage: WikiPage (object) of the user talk page
645 $recipient: User (object) who's talk page was edited
646
647 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
648 article has been changed.
649 &$wikiPage: the WikiPage (object)
650 &$editInfo: data holder that includes the parser output ($editInfo->output) for
651 that page after the change
652 $changed: bool for if the page was changed
653
654 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
655 recentchanges table, return false to not delete old entries.
656 &$wikiPage: WikiPage (object) being modified
657
658 'ArticleFromTitle': when creating an article object from a title object using
659 Wiki::articleFromTitle().
660 &$title: Title (object) used to create the article object
661 &$article: Article (object) that will be returned
662 $context: IContextSource (object)
663
664 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
665 $targetTitle: target title (object)
666 $destTitle: destination title (object)
667
668 'ArticlePageDataAfter': After loading data of an article from the database.
669 &$wikiPage: WikiPage (object) whose data were loaded
670 &$row: row (object) returned from the database server
671
672 'ArticlePageDataBefore': Before loading data of an article from the database.
673 &$wikiPage: WikiPage (object) that data will be loaded
674 &$fields: fields (array) to load from the database
675 &$tables: tables (array) to load from the database
676 &$joinConds: join conditions (array) to load from the database
677
678 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
679 $wikiPage: the WikiPage being saved
680 $popts: parser options to be used for pre-save transformation
681
682 'ArticleProtect': Before an article is protected.
683 &$wikiPage: the WikiPage being protected
684 &$user: the user doing the protection
685 $protect: Set of restriction keys
686 $reason: Reason for protect
687
688 'ArticleProtectComplete': After an article is protected.
689 &$wikiPage: the WikiPage that was protected
690 &$user: the user who did the protection
691 $protect: Set of restriction keys
692 $reason: Reason for protect
693
694 'ArticlePurge': Before executing "&action=purge".
695 &$wikiPage: WikiPage (object) to purge
696
697 'ArticleRevisionUndeleted': After an article revision is restored.
698 &$title: the article title
699 $revision: the revision
700 $oldPageID: the page ID of the revision when archived (may be null)
701
702 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
703 revisions of an article.
704 $title: Title object of the article
705 $ids: Ids to set the visibility for
706 $visibilityChangeMap: Map of revision id to oldBits and newBits. This array can be
707 examined to determine exactly what visibility bits have changed for each
708 revision. This array is of the form
709 [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
710
711 'ArticleRollbackComplete': After an article rollback is completed.
712 $wikiPage: the WikiPage that was edited
713 $user: the user who did the rollback
714 $revision: the revision the page was reverted back to
715 $current: the reverted revision
716
717 'ArticleShowPatrolFooter': Called at the beginning of Article#showPatrolFooter.
718 Extensions can use this to not show the [mark as patrolled] link in certain
719 circumstances.
720 $article: the Article object
721
722 'ArticleUndelete': When one or more revisions of an article are restored.
723 &$title: Title corresponding to the article restored
724 $create: Whether or not the restoration caused the page to be created (i.e. it
725 didn't exist before).
726 $comment: The comment associated with the undeletion.
727 $oldPageId: ID of page previously deleted (from archive table). This ID will be used
728 for the restored page.
729 $restoredPages: Set of page IDs that have revisions restored for this undelete,
730 with keys being page IDs and values are 'true'.
731
732 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
733 $pageArchive: the PageArchive object
734 &$logEntry: ManualLogEntry object
735 $user: User who is performing the log action
736
737 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
738 the user is redirected back to the page.
739 $article: the article
740 &$sectionanchor: The section anchor link (e.g. "#overview" )
741 &$extraq: Extra query parameters which can be added via hooked functions
742
743 'ArticleViewFooter': After showing the footer section of an ordinary page view
744 $article: Article object
745 $patrolFooterShown: boolean whether patrol footer is shown
746
747 'ArticleViewHeader': Control article output. Called before the parser cache is about
748 to be tried for article viewing.
749 &$article: the article
750 &$pcache: whether to try the parser cache or not
751 &$outputDone: whether the output for this page finished or not. Set to
752 a ParserOutput object to both indicate that the output is done and what
753 parser output was used.
754
755 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
756 redirect was followed.
757 &$article: target article (object)
758
759 'AuthChangeFormFields': After converting a field information array obtained
760 from a set of AuthenticationRequest classes into a form descriptor; hooks
761 can tweak the array to change how login etc. forms should look.
762 $requests: array of AuthenticationRequests the fields are created from
763 $fieldInfo: field information array (union of all
764 AuthenticationRequest::getFieldInfo() responses).
765 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
766 to change the order of the fields.
767 $action: one of the AuthManager::ACTION_* constants.
768
769 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
770 for a reason other than misconfiguration or session loss. No return data is
771 accepted; this hook is for auditing only.
772 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL
773 state.
774 $user: The User object being authenticated against, or null if authentication
775 failed before getting that far.
776 $username: A guess at the user name being authenticated, or null if we can't
777 even determine that. When $user is not null, it can be in the form of
778 <username>@<more info> (e.g. for bot passwords).
779 $extraData: An array (string => string) with extra information, intended to be
780 added to log contexts. Fields it might include:
781 - appId: the application ID, only if the login was with a bot password
782
783 'AutopromoteCondition': Check autopromote condition for user.
784 $type: condition type
785 $args: arguments
786 $user: user
787 &$result: result of checking autopromote condition
788
789 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
790 certain title are fetched.
791 $table: table name
792 $title: title of the page to which backlinks are sought
793 &$conds: query conditions
794
795 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
796 $table: table name
797 &$prefix: prefix
798
799 'BadImage': When checking against the bad image list. Change $bad and return
800 false to override. If an image is "bad", it is not rendered inline in wiki
801 pages or galleries in category pages.
802 $name: Image name being checked
803 &$bad: Whether or not the image is "bad"
804
805 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
806 custom HTML after the section. Any uses of the hook need to handle escaping.
807 $template: BaseTemplate
808 $portlet: string portlet name
809 &$html: string
810
811 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
812 and returning it for the skin to output. You can add items to the toolbox while
813 still letting the skin make final decisions on skin-specific markup conventions
814 using this hook.
815 &$sk: The BaseTemplate base skin template
816 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
817 BaseTemplate::makeListItem for details on the format of individual items
818 inside of this array.
819
820 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
821 "noarticletext-nopermission" at Article::showMissingArticle().
822 $article: article object
823
824 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
825 override how the redirect is output by modifying, or by returning false, and
826 letting standard HTTP rendering take place.
827 ATTENTION: This hook is likely to be removed soon due to overall design of the
828 system.
829 $context: IContextSource object
830 &$redirect: string URL, modifiable
831
832 'BeforeInitialize': Before anything is initialized in
833 MediaWiki::performRequest().
834 &$title: Title being used for request
835 &$unused: null
836 &$output: OutputPage object
837 &$user: User
838 $request: WebRequest object
839 $mediaWiki: Mediawiki object
840
841 'BeforePageDisplay': Prior to outputting a page.
842 &$out: OutputPage object
843 &$skin: Skin object
844
845 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
846 override how the redirect is output by modifying, or by returning false and
847 taking over the output.
848 $out: OutputPage object
849 &$redirect: URL, modifiable
850 &$code: HTTP code (eg '301' or '302'), modifiable
851
852 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
853 $parser: Parser object
854 $nt: the image title
855 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
856 as a key then the file will appear as a broken thumbnail.
857 &$descQuery: query string to add to thumbnail URL
858
859 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
860 $parser: Parser object
861 $title: title of the template
862 &$skip: skip this template and link it?
863 &$id: the id of the revision being parsed
864
865 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
866 &$parser: Parser object
867 &$ig: ImageGallery object
868
869 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
870 newly created user.
871 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
872 to a newly created user account.
873 &$injected_html: Any HTML to inject after the "logged in" message of a newly
874 created user account
875
876 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
877 normalizations have been performed, except for the $wgMaxImageArea check.
878 $image: File
879 &$params: Array of parameters
880 &$checkImageAreaHookResult: null, set to true or false to override the
881 $wgMaxImageArea check result.
882
883 'BitmapHandlerTransform': before a file is transformed, gives extension the
884 possibility to transform it themselves
885 $handler: BitmapHandler
886 $image: File
887 &$scalerParams: Array with scaler parameters
888 &$mto: null, set to a MediaTransformOutput
889
890 'BlockIp': Before an IP address or user is blocked.
891 &$block: the Block object about to be saved
892 &$user: the user _doing_ the block (not the one being blocked)
893 &$reason: if the hook is aborted, the error message to be returned in an array
894
895 'BlockIpComplete': After an IP address or user is blocked.
896 $block: the Block object that was saved
897 $user: the user who did the block (not the one being blocked)
898 $priorBlock: the Block object for the prior block or null if there was none
899
900 'BookInformation': Before information output on Special:Booksources.
901 $isbn: ISBN to show information for
902 $output: OutputPage object in use
903
904 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
905 to be able to access the wiki via HTTPS.
906 $ip: The IP address in human-readable form
907 &$canDo: This reference should be set to false if the client may not be able
908 to use HTTPS
909
910 'CanonicalNamespaces': For extensions adding their own namespaces or altering
911 the defaults.
912 Note that if you need to specify namespace protection or content model for
913 a namespace that is added in a CanonicalNamespaces hook handler, you
914 should do so by altering $wgNamespaceProtection and
915 $wgNamespaceContentModels outside the handler, in top-level scope. The
916 point at which the CanonicalNamespaces hook fires is too late for altering
917 these variables. This applies even if the namespace addition is
918 conditional; it is permissible to declare a content model and protection
919 for a namespace and then decline to actually register it.
920 &$namespaces: Array of namespace numbers with corresponding canonical names
921
922 'CategoryAfterPageAdded': After a page is added to a category.
923 $category: Category that page was added to
924 $wikiPage: WikiPage that was added
925
926 'CategoryAfterPageRemoved': After a page is removed from a category.
927 $category: Category that page was removed from
928 $wikiPage: WikiPage that was removed
929 $id: the page ID (original ID in case of page deletions)
930
931 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
932 &$catpage: CategoryPage instance
933
934 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
935 in a Category page. Gives extensions the opportunity to batch load any
936 related data about the pages.
937 $type: The category type. Either 'page', 'file' or 'subcat'
938 $res: Query result from Wikimedia\Rdbms\IDatabase::select()
939
940 'CategoryViewer::generateLink': Before generating an output link allow
941 extensions opportunity to generate a more specific or relevant link.
942 $type: The category type. Either 'page', 'img' or 'subcat'
943 $title: Title object for the categorized page
944 $html: Requested html content of anchor
945 &$link: Returned value. When set to a non-null value by a hook subscriber
946 this value will be used as the anchor instead of Linker::link
947
948 'ChangeAuthenticationDataAudit': Called when user changes his password.
949 No return data is accepted; this hook is for auditing only.
950 $req: AuthenticationRequest object describing the change (and target user)
951 $status: StatusValue with the result of the action
952
953 'ChangesListInitRows': Batch process change list rows prior to rendering.
954 $changesList: ChangesList instance
955 $rows: The data that will be rendered. May be a \Wikimedia\Rdbms\IResultWrapper
956 instance or an array.
957
958 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
959 &$changesList: ChangesList instance.
960 &$articlelink: HTML of link to article (already filled-in).
961 &$s: HTML of row that is being constructed.
962 &$rc: RecentChange instance.
963 $unpatrolled: Whether or not we are showing unpatrolled changes.
964 $watched: Whether or not the change is watched by the user.
965
966 'ChangesListSpecialPageQuery': Called when building SQL query on pages
967 inheriting from ChangesListSpecialPage (in core: RecentChanges,
968 RecentChangesLinked and Watchlist).
969 Do not use this to implement individual filters if they are compatible with the
970 ChangesListFilter and ChangesListFilterGroup structure.
971 Instead, use sub-classes of those classes, in conjunction with the
972 ChangesListSpecialPageStructuredFilters hook.
973 This hook can be used to implement filters that do not implement that structure,
974 or custom behavior that is not an individual filter.
975 $name: name of the special page, e.g. 'Watchlist'
976 &$tables: array of tables to be queried
977 &$fields: array of columns to select
978 &$conds: array of WHERE conditionals for query
979 &$query_options: array of options for the database request
980 &$join_conds: join conditions for the tables
981 $opts: FormOptions for this request
982
983 'ChangesListSpecialPageStructuredFilters': Called to allow extensions to register
984 filters for pages inheriting from ChangesListSpecialPage (in core: RecentChanges,
985 RecentChangesLinked, and Watchlist). Generally, you will want to construct
986 new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects.
987 When constructing them, you specify which group they belong to. You can reuse
988 existing groups (accessed through $special->getFilterGroup), or create your own
989 (ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup).
990 If you create new groups, you must register them with $special->registerFilterGroup.
991 Note that this is called regardless of whether the user is currently using
992 the new (structured) or old (unstructured) filter UI. If you want your boolean
993 filter to show on both the new and old UI, specify all the supported fields.
994 These include showHide, label, and description.
995 See the constructor of each ChangesList* class for documentation of supported
996 fields.
997 $special: ChangesListSpecialPage instance
998
999 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
1000 removed from all revisions and log entries to which it was applied). This gives
1001 extensions a chance to take it off their books.
1002 $tag: name of the tag
1003 &$status: Status object. Add warnings to this as required. There is no point
1004 setting errors, as the deletion has already been partly carried out by this
1005 point.
1006
1007 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1008 from the UI (Special:Tags) or via the API. You could use this hook if you want
1009 to reserve a specific "namespace" of tags, or something similar.
1010 $tag: name of the tag
1011 $user: user initiating the action
1012 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1013 using `$status->warning()`. Errors and warnings will be relayed to the user.
1014 If you set an error, the user will be unable to create the tag.
1015
1016 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1017 deleted from the UI (Special:Tags) or via the API. The default is that tags
1018 defined using the ListDefinedTags hook are not allowed to be deleted unless
1019 specifically allowed. If you wish to allow deletion of the tag, set
1020 `$status = Status::newGood()` to allow deletion, and then `return false` from
1021 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1022 out custom deletion actions.
1023 $tag: name of the tag
1024 $user: user initiating the action
1025 &$status: Status object. See above.
1026
1027 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1028 uses are in active use.
1029 &$tags: list of all active tags. Append to this array.
1030
1031 'ChangeTagsAfterUpdateTags': Called after tags have been updated with the
1032 ChangeTags::updateTags function. Params:
1033 $addedTags: tags effectively added in the update
1034 $removedTags: tags effectively removed in the update
1035 $prevTags: tags that were present prior to the update
1036 $rc_id: recentchanges table id
1037 $rev_id: revision table id
1038 $log_id: logging table id
1039 $params: tag params
1040 $rc: RecentChange being tagged when the tagging accompanies the action, or null
1041 $user: User who performed the tagging when the tagging is subsequent to the
1042 action, or null
1043
1044 'ChangeTagsAllowedAdd': Called when checking if a user can add tags to a change.
1045 &$allowedTags: List of all the tags the user is allowed to add. Any tags the
1046 user wants to add ($addTags) that are not in this array will cause it to fail.
1047 You may add or remove tags to this array as required.
1048 $addTags: List of tags user intends to add.
1049 $user: User who is adding the tags.
1050
1051 'ChangeUserGroups': Called before user groups are changed.
1052 $performer: The User who will perform the change
1053 $user: The User whose groups will be changed
1054 &$add: The groups that will be added
1055 &$remove: The groups that will be removed
1056
1057 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1058 $collationName: Name of the collation in question
1059 &$collationObject: Null. Replace with a subclass of the Collation class that
1060 implements the collation given in $collationName.
1061
1062 'ConfirmEmailComplete': Called after a user's email has been confirmed
1063 successfully.
1064 $user: user (object) whose email is being confirmed
1065
1066 'ContentAlterParserOutput': Modify parser output for a given content object.
1067 Called by Content::getParserOutput after parsing has finished. Can be used
1068 for changes that depend on the result of the parsing but have to be done
1069 before LinksUpdate is called (such as adding tracking categories based on
1070 the rendered HTML).
1071 $content: The Content to render
1072 $title: Title of the page, as context
1073 $parserOutput: ParserOutput to manipulate
1074
1075 'ContentGetParserOutput': Customize parser output for a given content object,
1076 called by AbstractContent::getParserOutput. May be used to override the normal
1077 model-specific rendering of page content.
1078 $content: The Content to render
1079 $title: Title of the page, as context
1080 $revId: The revision ID, as context
1081 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1082 the output can only depend on parameters provided to this hook function, not
1083 on global state.
1084 $generateHtml: boolean, indicating whether full HTML should be generated. If
1085 false, generation of HTML may be skipped, but other information should still
1086 be present in the ParserOutput object.
1087 &$output: ParserOutput, to manipulate or replace
1088
1089 'ContentHandlerDefaultModelFor': Called when the default content model is
1090 determined for a given title. May be used to assign a different model for that
1091 title.
1092 $title: the Title in question
1093 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1094
1095 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1096 a given content model name, but no entry for that model exists in
1097 $wgContentHandlers.
1098 Note: if your extension implements additional models via this hook, please
1099 use GetContentModels hook to make them known to core.
1100 $modeName: the requested content model name
1101 &$handler: set this to a ContentHandler object, if desired.
1102
1103 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1104 be used on a given page. This is especially useful to prevent some content
1105 models to be used in some special location.
1106 $contentModel: ID of the content model in question
1107 $title: the Title in question.
1108 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1109 Handler functions that modify $ok should generally return false to prevent
1110 further hooks from further modifying $ok.
1111
1112 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1113 &$pager: Pager object for contributions
1114 &$queryInfo: The query for the contribs Pager
1115
1116 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1117 Contributions
1118 &$data: an array of results of all contribs queries
1119 $pager: The ContribsPager object hooked into
1120 $offset: Index offset, inclusive
1121 $limit: Exact query limit
1122 $descending: Query direction, false for ascending, true for descending
1123
1124 'ContributionsLineEnding': Called before a contributions HTML line is finished
1125 $page: SpecialPage object for contributions
1126 &$ret: the HTML line
1127 $row: the DB row for this line
1128 &$classes: the classes to add to the surrounding <li>
1129 &$attribs: associative array of other HTML attributes for the <li> element.
1130 Currently only data attributes reserved to MediaWiki are allowed
1131 (see Sanitizer::isReservedDataAttribute).
1132
1133 'ContributionsToolLinks': Change tool links above Special:Contributions
1134 $id: User identifier
1135 $title: User page title
1136 &$tools: Array of tool links
1137 $specialPage: SpecialPage instance for context and services. Can be either
1138 SpecialContributions or DeletedContributionsPage. Extensions should type
1139 hint against a generic SpecialPage though.
1140
1141 'ConvertContent': Called by AbstractContent::convert when a conversion to
1142 another content model is requested.
1143 Handler functions that modify $result should generally return false to disable
1144 further attempts at conversion.
1145 $content: The Content object to be converted.
1146 $toModel: The ID of the content model to convert to.
1147 $lossy: boolean indicating whether lossy conversion is allowed.
1148 &$result: Output parameter, in case the handler function wants to provide a
1149 converted Content object. Note that $result->getContentModel() must return
1150 $toModel.
1151
1152 'ContentSecurityPolicyDefaultSource': Modify the allowed CSP load sources. This
1153 affects all directives except for the script directive. If you want to add a
1154 script source, see ContentSecurityPolicyScriptSource hook.
1155 &$defaultSrc: Array of Content-Security-Policy allowed sources
1156 $policyConfig: Current configuration for the Content-Security-Policy header
1157 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1158 ContentSecurityPolicy::FULL_MODE depending on type of header
1159
1160 'ContentSecurityPolicyDirectives': Modify the content security policy
1161 directives. Use this only if ContentSecurityPolicyDefaultSource and
1162 ContentSecurityPolicyScriptSource do not meet your needs.
1163 &$directives: Array of CSP directives
1164 $policyConfig: Current configuration for the CSP header
1165 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1166 ContentSecurityPolicy::FULL_MODE depending on type of header
1167
1168 'ContentSecurityPolicyScriptSource': Modify the allowed CSP script sources.
1169 Note that you also have to use ContentSecurityPolicyDefaultSource if you
1170 want non-script sources to be loaded from
1171 whatever you add.
1172 &$scriptSrc: Array of CSP directives
1173 $policyConfig: Current configuration for the CSP header
1174 $mode: ContentSecurityPolicy::REPORT_ONLY_MODE or
1175 ContentSecurityPolicy::FULL_MODE depending on type of header
1176
1177 'CustomEditor': When invoking the page editor
1178 Return true to allow the normal editor to be used, or false if implementing
1179 a custom editor, e.g. for a special namespace, etc.
1180 $article: Article being edited
1181 $user: User performing the edit
1182
1183 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1184 for Special:DeletedContributions
1185 Similar to ContribsPager::reallyDoQuery
1186 &$data: an array of results of all contribs queries
1187 $pager: The DeletedContribsPager object hooked into
1188 $offset: Index offset, inclusive
1189 $limit: Exact query limit
1190 $descending: Query direction, false for ascending, true for descending
1191
1192 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1193 is finished.
1194 Similar to ContributionsLineEnding
1195 $page: SpecialPage object for DeletedContributions
1196 &$ret: the HTML line
1197 $row: the DB row for this line
1198 &$classes: the classes to add to the surrounding <li>
1199 &$attribs: associative array of other HTML attributes for the <li> element.
1200 Currently only data attributes reserved to MediaWiki are allowed
1201 (see Sanitizer::isReservedDataAttribute).
1202
1203 'DeleteUnknownPreferences': Called by the cleanupPreferences.php maintenance
1204 script to build a WHERE clause with which to delete preferences that are not
1205 known about. This hook is used by extensions that have dynamically-named
1206 preferences that should not be deleted in the usual cleanup process. For
1207 example, the Gadgets extension creates preferences prefixed with 'gadget-', and
1208 so anything with that prefix is excluded from the deletion.
1209 &where: An array that will be passed as the $cond parameter to
1210 IDatabase::select() to determine what will be deleted from the user_properties
1211 table.
1212 $db: The IDatabase object, useful for accessing $db->buildLike() etc.
1213
1214 'DifferenceEngineAfterLoadNewText': called in DifferenceEngine::loadNewText()
1215 after the new revision's content has been loaded into the class member variable
1216 $differenceEngine->mNewContent but before returning true from this function.
1217 $differenceEngine: DifferenceEngine object
1218
1219 'DifferenceEngineLoadTextAfterNewContentIsLoaded': called in
1220 DifferenceEngine::loadText() after the new revision's content has been loaded
1221 into the class member variable $differenceEngine->mNewContent but before
1222 checking if the variable's value is null.
1223 This hook can be used to inject content into said class member variable.
1224 $differenceEngine: DifferenceEngine object
1225
1226 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as
1227 patrolled" link which is shown both on the diff header as well as on the bottom
1228 of a page, usually wrapped in a span element which has class="patrollink".
1229 $differenceEngine: DifferenceEngine object
1230 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1231 $rcid: Recent change ID (rc_id) for this change (int)
1232
1233 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the
1234 rcid parameter. For example the rcid might be set to zero due to the user being
1235 the same as the performer of the change but an extension might still want to
1236 show it under certain conditions.
1237 &$rcid: rc_id (int) of the change or 0
1238 $differenceEngine: DifferenceEngine object
1239 $change: RecentChange object
1240 $user: User object representing the current user
1241
1242 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader
1243 variable, which contains information about the new revision, such as the
1244 revision's author, whether the revision was marked as a minor edit or not, etc.
1245 $differenceEngine: DifferenceEngine object
1246 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1247 include things like revision author info, revision comment, RevisionDelete
1248 link and more
1249 $formattedRevisionTools: Array containing revision tools, some of which may have
1250 been injected with the DiffRevisionTools hook
1251 $nextlink: String containing the link to the next revision (if any); also
1252 included in $newHeader
1253 $rollback: Rollback link (string) to roll this revision back to the previous
1254 one, if any
1255 $newminor: String indicating if the new revision was marked as a minor edit
1256 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1257 whether we should show just the diff; passed in as a query string parameter to
1258 the various URLs constructed here (i.e. $nextlink)
1259 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1260 to use the RevisionDelete feature
1261 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1262
1263 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader
1264 variable, which contains information about the old revision, such as the
1265 revision's author, whether the revision was marked as a minor edit or not, etc.
1266 $differenceEngine: DifferenceEngine object
1267 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1268 include things like revision author info, revision comment, RevisionDelete
1269 link and more
1270 $prevlink: String containing the link to the previous revision (if any); also
1271 included in $oldHeader
1272 $oldminor: String indicating if the old revision was marked as a minor edit
1273 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1274 whether we should show just the diff; passed in as a query string parameter to
1275 the various URLs constructed here (i.e. $prevlink)
1276 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1277 to use the RevisionDelete feature
1278 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1279
1280 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases
1281 when there is no old revision
1282 &$oldHeader: empty string by default
1283
1284 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the
1285 parser output. Return false to not add parser output via OutputPage's
1286 addParserOutput method.
1287 $differenceEngine: DifferenceEngine object
1288 $out: OutputPage object
1289 $parserOutput: ParserOutput object
1290 $wikiPage: WikiPage object
1291
1292 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into
1293 this hook point and return false to not show the final "mark as patrolled" link
1294 on the bottom of a page.
1295 This hook has no arguments.
1296
1297 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1298 eventually gets sent to the OutputPage object.
1299 $differenceEngine: DifferenceEngine object
1300
1301 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff
1302 table body (without header) in cases when there is no old revision or the old
1303 and new revisions are identical.
1304 $differenceEngine: DifferenceEngine object
1305
1306 'DifferenceEngineShowDiffPage': Add additional output via the available
1307 OutputPage object into the diff view
1308 $out: OutputPage object
1309
1310 'DifferenceEngineShowDiffPageMaybeShowMissingRevision': called in
1311 DifferenceEngine::showDiffPage() when revision data cannot be loaded.
1312 Return false in order to prevent displaying the missing revision message
1313 (i.e. to prevent DifferenceEngine::showMissingRevision() from being called).
1314 $differenceEngine: DifferenceEngine object
1315
1316 'DiffRevisionTools': Override or extend the revision tools available from the
1317 diff view, i.e. undo, etc.
1318 $newRev: Revision object of the "new" revision
1319 &$links: Array of HTML links
1320 $oldRev: Revision object of the "old" revision (may be null)
1321 $user: Current user object
1322
1323 'DiffViewHeader': Called before diff display
1324 $diff: DifferenceEngine object that's calling
1325 $oldRev: Revision object of the "old" revision (may be null/invalid)
1326 $newRev: Revision object of the "new" revision
1327
1328 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1329 an article
1330 &$article: article (object) being viewed
1331 &$oldid: oldid (int) being viewed
1332
1333 'EditFilter': Perform checks on an edit
1334 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1335 $text: Contents of the edit box
1336 $section: Section being edited
1337 &$error: Error message to return
1338 $summary: Edit summary for page
1339
1340 'EditFilterMergedContent': Post-section-merge edit filter.
1341 This may be triggered by the EditPage or any other facility that modifies page
1342 content. Use the $status object to indicate whether the edit should be allowed,
1343 and to provide a reason for disallowing it. Return false to abort the edit, and
1344 true to continue. Returning true if $status->isOK() returns false means "don't
1345 save but continue user interaction", e.g. show the edit form.
1346 $status->apiHookResult can be set to an array to be returned by api.php
1347 action=edit. This is used to deliver captchas.
1348 $context: object implementing the IContextSource interface.
1349 $content: content of the edit box, as a Content object.
1350 $status: Status object to represent errors, etc.
1351 $summary: Edit summary for page
1352 $user: the User object representing the user whois performing the edit.
1353 $minoredit: whether the edit was marked as minor by the user.
1354
1355 'EditFormInitialText': Allows modifying the edit form when editing existing
1356 pages
1357 $editPage: EditPage object
1358
1359 'EditFormPreloadText': Allows population of the edit form when creating
1360 new pages
1361 &$text: Text to preload with
1362 &$title: Title object representing the page being created
1363
1364 'EditPage::attemptSave': Called before an article is
1365 saved, that is before WikiPage::doEditContent() is called
1366 $editpage_Obj: the current EditPage object
1367
1368 'EditPage::attemptSave:after': Called after an article save attempt
1369 $editpage_Obj: the current EditPage object
1370 $status: the resulting Status object
1371 $resultDetails: Result details array
1372
1373 'EditPage::importFormData': allow extensions to read additional data
1374 posted in the form
1375 Return value is ignored (should always return true)
1376 $editpage: EditPage instance
1377 $request: Webrequest
1378
1379 'EditPage::showEditForm:fields': allows injection of form field into edit form
1380 Return value is ignored (should always return true)
1381 &$editor: the EditPage instance for reference
1382 &$out: an OutputPage instance to write to
1383
1384 'EditPage::showEditForm:initial': before showing the edit form
1385 Return false to halt editing; you'll need to handle error messages, etc.
1386 yourself. Alternatively, modifying $error and returning true will cause the
1387 contents of $error to be echoed at the top of the edit form as wikitext.
1388 Return true without altering $error to allow the edit to proceed.
1389 &$editor: EditPage instance (object)
1390 &$out: an OutputPage instance to write to
1391
1392 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1393 but for the read-only 'view source' variant of the edit form.
1394 Return value is ignored (should always return true)
1395 $editor: EditPage instance (object)
1396 &$out: an OutputPage instance to write to
1397
1398 'EditPage::showStandardInputs:options': allows injection of form fields into
1399 the editOptions area
1400 Return value is ignored (should always be true)
1401 $editor: EditPage instance (object)
1402 $out: an OutputPage instance to write to
1403 &$tabindex: HTML tabindex of the last edit check/button
1404
1405 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1406 when there's an edit conflict. Return false to halt normal diff output; in
1407 this case you're responsible for computing and outputting the entire "conflict"
1408 part, i.e., the "difference between revisions" and "your text" headers and
1409 sections.
1410 &$editor: EditPage instance
1411 &$out: OutputPage instance
1412
1413 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1414 textarea in the edit form.
1415 &$editpage: The current EditPage object
1416 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1417 &$tabindex: HTML tabindex of the last edit check/button
1418
1419 'EditPageBeforeEditToolbar': Allow adding an edit toolbar above the textarea in
1420 the edit form.
1421 &$toolbar: The toolbar HTML, initially an empty `<div id="toolbar"></div>`
1422 Hook subscribers can return false to have no toolbar HTML be loaded.
1423
1424 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1425 contribution/copyright notice.
1426 $title: title of page being edited
1427 &$msg: localization message name, overridable. Default is either
1428 'copyrightwarning' or 'copyrightwarning2'.
1429
1430 'EditPageGetCheckboxesDefinition': Allows modifying the edit checkboxes
1431 below the textarea in the edit form.
1432 $editpage: The current EditPage object
1433 &$checkboxes: Array of checkbox definitions. See
1434 EditPage::getCheckboxesDefinition() for the format.
1435
1436 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1437 "Show changes". Note that it is preferable to implement diff handling for
1438 different data types using the ContentHandler facility.
1439 $editPage: EditPage object
1440 &$newtext: wikitext that will be used as "your version"
1441
1442 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1443 previewed. Note that it is preferable to implement previews for different data
1444 types using the ContentHandler facility.
1445 $editPage: EditPage object
1446 &$content: Content object to be previewed (may be replaced by hook function)
1447
1448 'EditPageNoSuchSection': When a section edit request is given for an
1449 non-existent section
1450 &$editpage: The current EditPage object
1451 &$res: the HTML of the error text
1452
1453 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1454 of terms of service summary link that might exist separately from the copyright
1455 notice.
1456 $title: title of page being edited
1457 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1458
1459 'EmailConfirmed': When checking that the user's email address is "confirmed".
1460 This runs before the other checks, such as anonymity and the real check; return
1461 true to allow those checks to occur, and false if checking is done.
1462 &$user: User being checked
1463 &$confirmed: Whether or not the email address is confirmed
1464
1465 'EmailUser': Before sending email from one user to another.
1466 &$to: MailAddress object of receiving user
1467 &$from: MailAddress object of sending user
1468 &$subject: subject of the mail
1469 &$text: text of the mail
1470 &$error: Out-param for an error. Should be set to a Status object or boolean
1471 false.
1472
1473 'EmailUserCC': Before sending the copy of the email to the author.
1474 &$to: MailAddress object of receiving user
1475 &$from: MailAddress object of sending user
1476 &$subject: subject of the mail
1477 &$text: text of the mail
1478
1479 'EmailUserComplete': After sending email from one user to another.
1480 $to: MailAddress object of receiving user
1481 $from: MailAddress object of sending user
1482 $subject: subject of the mail
1483 $text: text of the mail
1484
1485 'EmailUserForm': After building the email user form object.
1486 &$form: HTMLForm object
1487
1488 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1489 user.
1490 $user: The user who is trying to email another user.
1491 $editToken: The user's edit token.
1492 &$hookErr: Out-param for the error. Passed as the parameters to
1493 OutputPage::showErrorPage.
1494
1495 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1496 group of changes in EnhancedChangesList.
1497 Hook subscribers can return false to omit this line from recentchanges.
1498 $changesList: EnhancedChangesList object
1499 &$links: The links that were generated by EnhancedChangesList
1500 $block: The RecentChanges objects in that block
1501
1502 'EnhancedChangesListModifyLineData': to alter data used to build
1503 a grouped recent change inner line in EnhancedChangesList.
1504 Hook subscribers can return false to omit this line from recentchanges.
1505 $changesList: EnhancedChangesList object
1506 &$data: An array with all the components that will be joined in order to create
1507 the line
1508 $block: An array of RecentChange objects in that block
1509 $rc: The RecentChange object for this line
1510 &$classes: An array of classes to change
1511 &$attribs: associative array of other HTML attributes for the <tr> element.
1512 Currently only data attributes reserved to MediaWiki are allowed
1513 (see Sanitizer::isReservedDataAttribute).
1514
1515 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1516 a non-grouped recent change line in EnhancedChangesList.
1517 $changesList: EnhancedChangesList object
1518 &$data: An array with all the components that will be joined in order to create
1519 the line
1520 $rc: The RecentChange object for this line
1521
1522 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1523 throttle.
1524 $ip: The ip address of the user
1525
1526 'ExtensionTypes': Called when generating the extensions credits, use this to
1527 change the tables headers.
1528 &$extTypes: associative array of extensions types
1529
1530 'FetchChangesList': When fetching the ChangesList derivative for a particular
1531 user.
1532 $user: User the list is being fetched for
1533 &$skin: Skin object to be used with the list
1534 &$list: List object (defaults to NULL, change it to an object instance and
1535 return false override the list derivative used)
1536 $groups Array of ChangesListFilterGroup objects (added in 1.34)
1537
1538 'FileDeleteComplete': When a file is deleted.
1539 &$file: reference to the deleted file
1540 &$oldimage: in case of the deletion of an old image, the name of the old file
1541 &$article: in case all revisions of the file are deleted a reference to the
1542 WikiFilePage associated with the file.
1543 &$user: user who performed the deletion
1544 &$reason: reason
1545
1546 'FileTransformed': When a file is transformed and moved into storage.
1547 $file: reference to the File object
1548 $thumb: the MediaTransformOutput object
1549 $tmpThumbPath: The temporary file system path of the transformed file
1550 $thumbPath: The permanent storage path of the transformed file
1551
1552 'FileUndeleteComplete': When a file is undeleted
1553 $title: title object to the file
1554 $fileVersions: array of undeleted versions. Empty if all versions were restored
1555 $user: user who performed the undeletion
1556 $reason: reason
1557
1558 'FileUpload': When a file upload occurs.
1559 $file: Image object representing the file that was uploaded
1560 $reupload: Boolean indicating if there was a previously another image there or
1561 not (since 1.17)
1562 $hasDescription: Boolean indicating that there was already a description page
1563 and a new one from the comment wasn't created (since 1.17)
1564
1565 'FormatAutocomments': When an autocomment is formatted by the Linker.
1566 &$comment: Reference to the accumulated comment. Initially null, when set the
1567 default code will be skipped.
1568 $pre: Boolean, true if there is text before this autocomment
1569 $auto: The extracted part of the parsed comment before the call to the hook.
1570 $post: Boolean, true if there is text after this autocomment
1571 $title: An optional title object used to links to sections. Can be null.
1572 $local: Boolean indicating whether section links should refer to local page.
1573 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1574 autocomment originated; null for the local wiki. Added in 1.26, should default
1575 to null in handler functions, for backwards compatibility.
1576
1577 'GalleryGetModes': Get list of classes that can render different modes of a
1578 gallery.
1579 &$modeArray: An associative array mapping mode names to classes that implement
1580 that mode. It is expected all registered classes are a subclass of
1581 ImageGalleryBase.
1582
1583 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1584 entitled to be in.
1585 $user: user to promote.
1586 &$promote: groups that will be added.
1587
1588 'GetBlockedStatus': DEPRECATED since 1.34 - use GetUserBlock instead. After
1589 loading blocking status of a user from the database
1590 &$user: user (object) being checked
1591
1592 'GetCacheVaryCookies': Get cookies that should vary cache options.
1593 $out: OutputPage object
1594 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1595 that have to vary cache options
1596
1597 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1598 notifications.
1599 &$title: Title object of page
1600 &$url: string value as output (out parameter, can modify)
1601 $query: query options as string passed to Title::getCanonicalURL()
1602
1603 'GetContentModels': Add content models to the list of available models.
1604 &$models: array containing current model list, as strings. Extensions should add to this list.
1605
1606 'GetDefaultSortkey': Override the default sortkey for a page.
1607 $title: Title object that we need to get a sortkey for
1608 &$sortkey: Sortkey to use.
1609
1610 'GetDifferenceEngine': Called when getting a new difference engine interface
1611 object. Can be used to decorate or replace the default difference engine.
1612 $context: IContextSource context to be used for diff
1613 $old: Revision ID to show and diff with
1614 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1615 $refreshCache: If set, refreshes the diff cache
1616 $unhide: If set, allow viewing deleted revs
1617 &$differenceEngine: The difference engine object to be used for the diff
1618
1619 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1620 underscore) magic words. Called by MagicWord.
1621 &$doubleUnderscoreIDs: array of strings
1622
1623 'GetExtendedMetadata': Get extended file metadata for the API
1624 &$combinedMeta: Array of the form:
1625 'MetadataPropName' => [
1626 value' => prop value,
1627 'source' => 'name of hook'
1628 ].
1629 $file: File object of file in question
1630 $context: RequestContext (including language to use)
1631 $single: Only extract the current language; if false, the prop value should
1632 be in the metadata multi-language array format:
1633 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1634 &$maxCacheTime: how long the results can be cached
1635
1636 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1637 &$title: Title object of page
1638 &$url: string value as output (out parameter, can modify)
1639 $query: query options as string passed to Title::getFullURL()
1640
1641 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1642 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1643 the custom output.
1644 &$output: string for the output timestamp
1645 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1646 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1647 $user: User whose preferences are being used to make timestamp
1648 $lang: Language that will be used to render the timestamp
1649
1650 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1651 &$title: Title object of page
1652 &$url: string value as output (out parameter, can modify)
1653 $query: query options as string passed to Title::getInternalURL()
1654
1655 'GetIP': modify the ip of the current user (called only once).
1656 &$ip: string holding the ip as determined so far
1657
1658 'GetLangPreferredVariant': Called in LanguageConverter#getPreferredVariant() to
1659 allow fetching the language variant code from cookies or other such
1660 alternative storage.
1661 &$req: language variant from the URL (string) or boolean false if no variant
1662 was specified in the URL; the value of this variable comes from
1663 LanguageConverter#getURLVariant()
1664
1665 'GetLinkColours': modify the CSS class of an array of page links.
1666 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1667 indexed by page_id.
1668 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1669 $title: Title object of the page being parsed, on which the links will be shown
1670
1671 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1672 working with internal urls (non-interwiki) then it may be preferable to work
1673 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1674 be buggy for internal urls on render if you do not re-implement the horrible
1675 hack that Title::getLocalURL uses in your own extension.
1676 &$title: Title object of page
1677 &$url: string value as output (out parameter, can modify)
1678 $query: query options as string passed to Title::getLocalURL()
1679
1680 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1681 without any fancy queries or variants.
1682 &$title: Title object of page
1683 &$url: string value as output (out parameter, can modify)
1684
1685 'GetLocalURL::Internal': Modify local URLs to internal pages.
1686 &$title: Title object of page
1687 &$url: string value as output (out parameter, can modify)
1688 $query: query options as string passed to Title::getLocalURL()
1689
1690 'GetLogTypesOnUser': Add log types where the target is a userpage
1691 &$types: Array of log types
1692
1693 'GetMetadataVersion': Modify the image metadata version currently in use. This
1694 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1695 that need to have versioned metadata should add an element to the end of the
1696 version array of the form 'handler_name=version'. Most media handlers won't need
1697 to do this unless they broke backwards compatibility with a previous version of
1698 the media handler metadata output.
1699 &$version: Array of version strings
1700
1701 'GetNewMessagesAlert': Disable or modify the new messages alert
1702 &$newMessagesAlert: An empty string by default. If the user has new talk page
1703 messages, this should be populated with an alert message to that effect
1704 $newtalks: An empty array if the user has no new messages or an array
1705 containing links and revisions if there are new messages (See
1706 User::getNewMessageLinks)
1707 $user: The user object of the user who is loading the page
1708 $out: OutputPage object (to check what type of page the user is on)
1709
1710 'GetPreferences': Modify user preferences.
1711 $user: User whose preferences are being modified.
1712 &$preferences: Preferences description array, to be fed to an HTMLForm object
1713
1714 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1715 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1716 custom output.
1717 &$output: string for the output timestamp
1718 &$diff: DateInterval representing the difference between the timestamps
1719 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1720 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1721 $user: User whose preferences are being used to make timestamp
1722 $lang: Language that will be used to render the timestamp
1723
1724 'GetSlotDiffRenderer': Replace or wrap the standard SlotDiffRenderer for some
1725 content type.
1726 $contentHandler: ContentHandler for which the slot diff renderer is fetched.
1727 &$slotDiffRenderer: SlotDiffRenderer to change or replace.
1728 $context: IContextSource
1729
1730 'GetUserBlock': Modify the block found by the block manager. This may be a
1731 single block or a composite block made from multiple blocks; the original
1732 blocks can be seen using CompositeBlock::getOriginalBlocks()
1733 $user: User targeted by the block
1734 $ip: string|null The IP of the current request if $user is the current user
1735 and they're not exempted from IP blocks. Null otherwise.
1736 &$block: AbstractBlock object
1737
1738 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1739 checked for. Use instead of userCan for most cases. Return false if the user
1740 can't do it, and populate $result with the reason in the form of
1741 [ messagename, param1, param2, ... ] or a MessageSpecifier instance (you
1742 might want to use ApiMessage to provide machine-readable details for the API).
1743 For consistency, error messages
1744 should be plain text with no special coloring, bolding, etc. to show that
1745 they're errors; presenting them properly to the user as errors is done by the
1746 caller.
1747 &$title: Title object being checked against
1748 &$user: Current user object
1749 $action: Action being checked
1750 &$result: User permissions error to add. If none, return true.
1751
1752 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1753 called only if expensive checks are enabled. Add a permissions error when
1754 permissions errors are checked for. Return false if the user can't do it, and
1755 populate $result with the reason in the form of [ messagename, param1, param2,
1756 ... ] or a MessageSpecifier instance (you might want to use ApiMessage to
1757 provide machine-readable details for the API). For consistency, error messages
1758 should be plain text with no special coloring, bolding, etc. to show that
1759 they're errors; presenting them properly to the user as errors is done by the
1760 caller.
1761 &$title: Title object being checked against
1762 &$user: Current user object
1763 $action: Action being checked
1764 &$result: User permissions error to add. If none, return true.
1765
1766 'GitViewers': Called when generating the list of git viewers for
1767 Special:Version, use this to change the list.
1768 &$extTypes: associative array of repo URLS to viewer URLs.
1769
1770 'HistoryRevisionTools': Override or extend the revision tools available from the
1771 page history view, i.e. undo, rollback, etc.
1772 $rev: Revision object
1773 &$links: Array of HTML links
1774 $prevRev: Revision object, next in line in page history, or null
1775 $user: Current user object
1776
1777 'HistoryPageToolLinks': Add one or more links to revision history page subtitle.
1778 $context: IContextSource (object)
1779 $linkRenderer: LinkRenderer instance
1780 &$links: Array of HTML strings
1781
1782 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1783 cache.
1784 $context: An IContextSource object with information about the request being
1785 served.
1786
1787 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1788 image insertion. You can skip the default logic entirely by returning false, or
1789 just modify a few things using call-by-reference.
1790 &$skin: Skin object
1791 &$title: Title object of the image
1792 &$file: File object, or false if it doesn't exist
1793 &$frameParams: Various parameters with special meanings; see documentation in
1794 includes/Linker.php for Linker::makeImageLink
1795 &$handlerParams: Various parameters with special meanings; see documentation in
1796 includes/Linker.php for Linker::makeImageLink
1797 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1798 &$res: Final HTML output, used if you return false
1799 $parser: Parser instance
1800 &$query: Query params for desc URL
1801 &$widthOption: Used by the parser to remember the user preference thumbnailsize
1802
1803 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1804 the image on an image page.
1805 &$imagePage: ImagePage object ($this)
1806 &$output: $wgOut
1807
1808 'ImagePageAfterImageLinks': Called after the image links section on an image
1809 page is built.
1810 $imagePage: ImagePage object ($this)
1811 &$html: HTML for the hook to add
1812
1813 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1814 $imagePage: ImagePage object ($this)
1815 $file: the file
1816 &$line: the HTML of the history line
1817 &$css: the line CSS class
1818
1819 'ImagePageFindFile': Called when fetching the file associated with an image
1820 page.
1821 $page: ImagePage object
1822 &$file: File object
1823 &$displayFile: displayed File object
1824
1825 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1826 $page: ImagePage object
1827 &$toc: Array of <li> strings
1828
1829 'ImgAuthBeforeStream': Executed before file is streamed to user, but only when
1830 using img_auth.php.
1831 &$title: the Title object of the file as it would appear for the upload page
1832 &$path: the original file and path name when img_auth was invoked by the web
1833 server
1834 &$name: the name only component of the file
1835 &$result: The location to pass back results of the hook routine (only used if
1836 failed)
1837 $result[0]=The index of the header message
1838 $result[1]=The index of the body text message
1839 $result[2 through n]=Parameters passed to body text message. Please note the
1840 header message cannot receive/use parameters.
1841
1842 'ImgAuthModifyHeaders': Executed just before a file is streamed to a user via
1843 img_auth.php, allowing headers to be modified beforehand.
1844 $title: LinkTarget object
1845 &$headers: HTTP headers ( name => value, names are case insensitive ).
1846 Two headers get special handling: If-Modified-Since (value must be
1847 a valid HTTP date) and Range (must be of the form "bytes=(\d*-\d*)")
1848 will be honored when streaming the file.
1849
1850 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1851 Return false to stop further processing of the tag
1852 $reader: XMLReader object
1853 $logInfo: Array of information
1854
1855 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1856 Return false to stop further processing of the tag
1857 $reader: XMLReader object
1858 &$pageInfo: Array of information
1859
1860 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1861 Return false to stop further processing of the tag
1862 $reader: XMLReader object
1863 $pageInfo: Array of page information
1864 $revisionInfo: Array of revision information
1865
1866 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1867 Return false to stop further processing of the tag
1868 $reader: XMLReader object
1869
1870 'ImportHandleUnknownUser': When a user doesn't exist locally, this hook is
1871 called to give extensions an opportunity to auto-create it. If the auto-creation
1872 is successful, return false.
1873 $name: User name
1874
1875 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1876 Return false to stop further processing of the tag
1877 $reader: XMLReader object
1878 $revisionInfo: Array of information
1879
1880 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1881 and edit summaries for transwiki imports.
1882 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1883 &$pageTitle: String that contains page title.
1884
1885 'ImportSources': Called when reading from the $wgImportSources configuration
1886 variable. Can be used to lazy-load the import sources list.
1887 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1888 comment in DefaultSettings.php for the detail of how to structure this array.
1889
1890 'InfoAction': When building information to display on the action=info page.
1891 $context: IContextSource object
1892 &$pageInfo: Array of information
1893
1894 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1895 &$title: Title object for the current page
1896 &$request: WebRequest
1897 &$ignoreRedirect: boolean to skip redirect check
1898 &$target: Title/string of redirect target
1899 &$article: Article object
1900
1901 'InternalParseBeforeLinks': during Parser's internalParse method before links
1902 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1903 &$parser: Parser object
1904 &$text: string containing partially parsed text
1905 &$stripState: Parser's internal StripState object
1906
1907 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1908 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1909 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1910 template/parser function execution which respect nowiki and HTML-comments.
1911 &$parser: Parser object
1912 &$text: string containing partially parsed text
1913 &$stripState: Parser's internal StripState object
1914
1915 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1916 Return true without providing an interwiki to continue interwiki search.
1917 $prefix: interwiki prefix we are looking for.
1918 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1919 iw_trans and optionally iw_api and iw_wikiid.
1920
1921 'InvalidateEmailComplete': Called after a user's email has been invalidated
1922 successfully.
1923 $user: user (object) whose email is being invalidated
1924
1925 'IRCLineURL': When constructing the URL to use in an IRC notification.
1926 Callee may modify $url and $query, URL will be constructed as $url . $query
1927 &$url: URL to index.php
1928 &$query: Query string
1929 $rc: RecentChange object that triggered url generation
1930
1931 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1932 &$article: article (object) being checked
1933
1934 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1935 &$ip: IP being check
1936 &$result: Change this value to override the result of IP::isTrustedProxy()
1937
1938 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1939 $url: URL used to upload from
1940 &$allowed: Boolean indicating if uploading is allowed for given URL
1941
1942 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1943 instance to return false if the domain name doesn't match your organization.
1944 $addr: The e-mail address entered by the user
1945 &$result: Set this and return false to override the internal checks
1946
1947 'isValidPassword': Override the result of User::isValidPassword()
1948 $password: The password entered by the user
1949 &$result: Set this and return false to override the internal checks
1950 $user: User the password is being validated for
1951
1952 'Language::getMessagesFileName':
1953 $code: The language code or the language we're looking for a messages file for
1954 &$file: The messages file path, you can override this to change the location.
1955
1956 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1957 remove namespaces. Do not use this hook to add namespaces. Use
1958 CanonicalNamespaces for that.
1959 &$namespaces: Array of namespaces indexed by their numbers
1960
1961 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1962 &$names: array of language code => language name
1963 $code: language of the preferred translations
1964
1965 'LanguageLinks': Manipulate a page's language links. This is called
1966 in various places to allow extensions to define the effective language
1967 links for a page.
1968 $title: The page's Title.
1969 &$links: Array with elements of the form "language:title" in the order
1970 that they will be output.
1971 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1972 Currently unused, but planned to provide support for marking individual
1973 language links in the UI, e.g. for featured articles.
1974
1975 'LanguageSelector': Hook to change the language selector available on a page.
1976 $out: The output page.
1977 $cssClassName: CSS class name of the language selector.
1978
1979 'LinkBegin': DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead.
1980 Used when generating internal and interwiki links in Linker::link(), before
1981 processing starts. Return false to skip default processing and return $ret. See
1982 documentation for Linker::link() for details on the expected meanings of
1983 parameters.
1984 $skin: the Skin object
1985 $target: the Title that the link is pointing to
1986 &$html: the contents that the <a> tag should have (raw HTML); null means
1987 "default".
1988 &$customAttribs: the HTML attributes that the <a> tag should have, in
1989 associative array form, with keys and values unescaped. Should be merged
1990 with default values, with a value of false meaning to suppress the
1991 attribute.
1992 &$query: the query string to add to the generated URL (the bit after the "?"),
1993 in associative array form, with keys and values unescaped.
1994 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1995 &$ret: the value to return if your hook returns false.
1996
1997 'LinkEnd': DEPRECATED since 1.28! Use HtmlPageLinkRendererEnd hook instead
1998 Used when generating internal and interwiki links in Linker::link(),
1999 just before the function returns a value. If you return true, an <a> element
2000 with HTML attributes $attribs and contents $html will be returned. If you
2001 return false, $ret will be returned.
2002 $skin: the Skin object
2003 $target: the Title object that the link is pointing to
2004 $options: the options. Will always include either 'known' or 'broken', and may
2005 include 'noclasses'.
2006 &$html: the final (raw HTML) contents of the <a> tag, after processing.
2007 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2008 associative array form.
2009 &$ret: the value to return if your hook returns false.
2010
2011 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
2012 before the return.
2013 &$url: the image url
2014 &$alt: the image's alt text
2015 &$img: the new image HTML (if returning false)
2016
2017 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
2018 before the return.
2019 &$url: the link url
2020 &$text: the link text
2021 &$link: the new link HTML (if returning false)
2022 &$attribs: the attributes to be applied.
2023 $linkType: The external link type
2024
2025 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
2026 before the return.
2027 $title: the Title object that the link is pointing to
2028 $file: the File object or false if broken link
2029 &$html: the link text
2030 &$attribs: the attributes to be applied
2031 &$ret: the value to return if your hook returns false
2032
2033 'LogEventsListLineEnding': Called before a Special:Log line is finished
2034 $page: the LogEventsList object
2035 &$ret: the HTML line
2036 $entry: the DatabaseLogEntry object for this row
2037 &$classes: the classes to add to the surrounding <li>
2038 &$attribs: associative array of other HTML attributes for the <li> element.
2039 Currently only data attributes reserved to MediaWiki are allowed
2040 (see Sanitizer::isReservedDataAttribute).
2041
2042
2043 'HtmlPageLinkRendererBegin':
2044 Used when generating internal and interwiki links in
2045 LinkRenderer, before processing starts. Return false to skip default
2046 processing and return $ret.
2047 $linkRenderer: the LinkRenderer object
2048 $target: the LinkTarget that the link is pointing to
2049 &$text: the contents that the <a> tag should have; either a plain, unescaped
2050 string or a HtmlArmor object; null means "default".
2051 &$customAttribs: the HTML attributes that the <a> tag should have, in
2052 associative array form, with keys and values unescaped. Should be merged
2053 with default values, with a value of false meaning to suppress the
2054 attribute.
2055 &$query: the query string to add to the generated URL (the bit after the "?"),
2056 in associative array form, with keys and values unescaped.
2057 &$ret: the value to return if your hook returns false.
2058
2059 'HtmlPageLinkRendererEnd':
2060 Used when generating internal and interwiki links in LinkRenderer,
2061 just before the function returns a value. If you return true, an <a> element
2062 with HTML attributes $attribs and contents $html will be returned. If you
2063 return false, $ret will be returned.
2064 $linkRenderer: the LinkRenderer object
2065 $target: the LinkTarget object that the link is pointing to
2066 $isKnown: boolean indicating whether the page is known or not
2067 &$text: the contents that the <a> tag should have; either a plain, unescaped
2068 string or a HtmlArmor object.
2069 &$attribs: the final HTML attributes of the <a> tag, after processing, in
2070 associative array form.
2071 &$ret: the value to return if your hook returns false.
2072
2073 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
2074 actual update.
2075 &$linksUpdate: the LinksUpdate object
2076
2077 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
2078 each link table insert. For example, pagelinks, imagelinks, externallinks.
2079 $linksUpdate: LinksUpdate object
2080 $table: the table to insert links to
2081 $insertions: an array of links to insert
2082
2083 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
2084 including delete and insert, has completed for all link tables
2085 &$linksUpdate: the LinksUpdate object
2086 $ticket: prior result of LBFactory::getEmptyTransactionTicket()
2087
2088 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
2089 &$linksUpdate: the LinksUpdate object
2090
2091 'ListDefinedTags': When trying to find all defined tags.
2092 &$tags: The list of tags.
2093
2094 'LoadExtensionSchemaUpdates': Called during database installation and updates.
2095 $updater: A DatabaseUpdater subclass
2096
2097 'LocalFile::getHistory': Called before file history query performed.
2098 &$file: the File object
2099 &$tables: tables
2100 &$fields: select fields
2101 &$conds: conditions
2102 &$opts: query options
2103 &$join_conds: JOIN conditions
2104
2105 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
2106 $file: the File object
2107 $archiveName: name of an old file version or false if it's the current one
2108
2109 'LocalisationCacheRecache': Called when loading the localisation data into
2110 cache.
2111 $cache: The LocalisationCache object
2112 $code: language code
2113 &$alldata: The localisation data from core and extensions
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 NamespaceInfo::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 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 $config: Config object (since 1.34)
2835
2836 'ResourceLoaderJqueryMsgModuleMagicWords': Called in
2837 ResourceLoaderJqueryMsgModule to allow adding magic words for jQueryMsg.
2838 The value should be a string, and they can depend only on the
2839 ResourceLoaderContext.
2840 $context: ResourceLoaderContext
2841 &$magicWords: Associative array mapping all-caps magic word to a string value
2842
2843 'ResourceLoaderRegisterModules': Right before modules information is required,
2844 such as when responding to a resource
2845 loader request or generating HTML output.
2846 &$resourceLoader: ResourceLoader object
2847
2848 'ResourceLoaderTestModules': DEPRECATED since 1.33! Register ResourceLoader modules
2849 that are only available when `$wgEnableJavaScriptTest` is true. Use this for test
2850 suites and other test-only resources.
2851 &$testModules: one array of modules per test framework. The modules array
2852 follows the same format as `$wgResourceModules`. For example:
2853 $testModules['qunit']['ext.Example.test'] = [
2854 'localBasePath' => __DIR__ . '/tests/qunit',
2855 'remoteExtPath' => 'Example/tests/qunit',
2856 'script' => [ 'tests/qunit/foo.js' ],
2857 'dependencies' => [ 'ext.Example.foo' ]
2858 ];
2859 &$ResourceLoader: object
2860
2861 'RevisionDataUpdates': Called when constructing a list of DeferrableUpdate to be
2862 executed to record secondary data about a revision.
2863 $title The Title of the page the revision belongs to
2864 $renderedRevision a RenderedRevision object representing the new revision and providing access
2865 to the RevisionRecord as well as ParserOutput of that revision.
2866 &$updates A list of DeferrableUpdate that can be manipulated by the hook handler.
2867
2868 'RevisionRecordInserted': Called after a revision is inserted into the database.
2869 $revisionRecord: the RevisionRecord that has just been inserted.
2870
2871 'RevisionInsertComplete': DEPRECATED since 1.31! Use RevisionRecordInserted hook
2872 instead. Called after a revision is inserted into the database.
2873 $revision: the Revision
2874 $data: DEPRECATED! Always null!
2875 $flags: DEPRECATED! Always null!
2876
2877 'SearchableNamespaces': An option to modify which namespaces are searchable.
2878 &$arr: Array of namespaces ($nsId => $name) which will be used.
2879
2880 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2881 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2882 runs after.
2883 $term: Search term string
2884 &$title: Outparam; set to $title object and return false for a match
2885
2886 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2887 if nothing was found.
2888 $term: Search term string
2889 &$title: Outparam; set to $title object and return false for a match
2890
2891 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2892 the normal operations.
2893 $allSearchTerms: Array of the search terms in all content languages
2894 &$titleResult: Outparam; the value to return. A Title object or null.
2895
2896 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2897 searches.
2898 $term: Search term string
2899 &$title: Current Title object that is being returned (null if none found).
2900
2901 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2902 search results.
2903 $title: Current Title object being displayed in search results.
2904 &$id: Revision ID (default is false, for latest)
2905
2906 'SearchIndexFields': Add fields to search index mapping.
2907 &$fields: Array of fields, all implement SearchIndexField
2908 $engine: SearchEngine instance for which mapping is being built.
2909
2910 'SearchDataForIndex': Add data to search document. Allows to add any data to
2911 the field map used to index the document.
2912 &$fields: Array of name => value pairs for fields
2913 $handler: ContentHandler for the content being indexed
2914 $page: WikiPage that is being indexed
2915 $output: ParserOutput that is produced from the page
2916 $engine: SearchEngine for which the indexing is intended
2917
2918 'SearchResultsAugment': Allows extension to add its code to the list of search
2919 result augmentors.
2920 &$setAugmentors: List of whole-set augmentor objects, must implement
2921 ResultSetAugmentor.
2922 &$rowAugmentors: List of per-row augmentor objects, must implement
2923 ResultAugmentor.
2924 Note that lists should be in the format name => object and the names in both
2925 lists should be distinct.
2926
2927 'SecondaryDataUpdates': DEPRECATED since 1.32! Use RevisionDataUpdates or override
2928 ContentHandler::getSecondaryDataUpdates instead.
2929 Allows modification of the list of DataUpdates to perform when page content is modified.
2930 $title: Title of the page that is being edited.
2931 $oldContent: Content object representing the page's content before the edit.
2932 $recursive: bool indicating whether DataUpdates should trigger recursive
2933 updates (relevant mostly for LinksUpdate).
2934 $parserOutput: ParserOutput representing the rendered version of the page
2935 after the edit.
2936 &$updates: a list of DataUpdate objects, to be modified or replaced by
2937 the hook handler.
2938
2939 'SecuritySensitiveOperationStatus': Affect the return value from
2940 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2941 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2942 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2943 authentication isn't possible for the current session type.
2944 $operation: (string) The operation being checked.
2945 $session: (MediaWiki\Session\Session) The current session. The
2946 currently-authenticated user may be retrieved as $session->getUser().
2947 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2948 the time of last auth is unknown, or -1 if authentication is not possible.
2949
2950 'SelfLinkBegin': Called before a link to the current article is displayed to
2951 allow the display of the link to be customized.
2952 $nt: the Title object
2953 &$html: html to display for the link
2954 &$trail: optional text to display before $html
2955 &$prefix: optional text to display after $html
2956 &$ret: the value to return if your hook returns false
2957
2958 'SendWatchlistEmailNotification': Return true to send watchlist email
2959 notification
2960 $targetUser: the user whom to send watchlist email notification
2961 $title: the page title
2962 $enotif: EmailNotification object
2963
2964 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2965 loaded from storage. Return false to prevent it from being used.
2966 &$reason: String rejection reason to be logged
2967 $info: MediaWiki\Session\SessionInfo being validated
2968 $request: WebRequest being loaded from
2969 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2970 $data: Array|false Data array for the MediaWiki\Session\Session
2971
2972 'SessionMetadata': Add metadata to a session being saved.
2973 $backend: MediaWiki\Session\SessionBackend being saved.
2974 &$metadata: Array Metadata to be stored. Add new keys here.
2975 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2976 request and 0+ FauxRequests.
2977
2978 'SetupAfterCache': Called in Setup.php, after cache objects are set
2979
2980 'ShortPagesQuery': Allow extensions to modify the query used by
2981 Special:ShortPages.
2982 &$tables: tables to join in the query
2983 &$conds: conditions for the query
2984 &$joinConds: join conditions for the query
2985 &$options: options for the query
2986
2987 'ShowMissingArticle': Called when generating the output for a non-existent page.
2988 $article: The article object corresponding to the page
2989
2990 'ShowSearchHit': Customize display of search hit.
2991 $searchPage: The SpecialSearch instance.
2992 $result: The SearchResult to show
2993 $terms: Search terms, for highlighting (unreliable as search engine dependent).
2994 &$link: HTML of link to the matching page. May be modified.
2995 &$redirect: HTML of redirect info. May be modified.
2996 &$section: HTML of matching section. May be modified.
2997 &$extract: HTML of content extract. May be modified.
2998 &$score: HTML of score. May be modified.
2999 &$size: HTML of page size. May be modified.
3000 &$date: HTML of of page modification date. May be modified.
3001 &$related: HTML of additional info for the matching page. May be modified.
3002 &$html: May be set to the full HTML that should be used to represent the search
3003 hit. Must include the <li> ... </li> tags. Will only be used if the hook
3004 function returned false.
3005
3006 'ShowSearchHitTitle': Customise display of search hit title/link.
3007 &$title: Title to link to
3008 &$titleSnippet: Label for the link representing the search result. Typically the
3009 article title.
3010 $result: The SearchResult object
3011 $terms: array of search terms extracted by SearchDatabase search engines
3012 (may not be populated by other search engines).
3013 $specialSearch: The SpecialSearch object
3014 &$query: Array of query string parameters for the link representing the search
3015 result.
3016 &$attributes: Array of title link attributes, can be modified by extension.
3017
3018 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
3019 Warning: This hook is run on each display. You should consider to use
3020 'SkinBuildSidebar' that is aggressively cached.
3021 $skin: Skin object
3022 &$bar: Sidebar content
3023 Modify $bar to add or modify sidebar portlets.
3024
3025 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
3026 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
3027 the sitenotice/anonnotice.
3028 $skin: Skin object
3029
3030 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
3031 allow the normal method of notice selection/rendering to work, or change the
3032 value of $siteNotice and return false to alter it.
3033 &$siteNotice: HTML returned as the sitenotice
3034 $skin: Skin object
3035
3036 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
3037 $skin: Skin object
3038 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
3039 the stock bottom scripts.
3040
3041 'SkinAfterContent': Allows extensions to add text after the page content and
3042 article metadata. This hook should work in all skins. Set the &$data variable to
3043 the text you're going to add.
3044 &$data: (string) Text to be printed out directly (without parsing)
3045 $skin: Skin object
3046
3047 'SkinBuildSidebar': At the end of Skin::buildSidebar().
3048 $skin: Skin object
3049 &$bar: Sidebar contents
3050 Modify $bar to add or modify sidebar portlets.
3051
3052 'SkinCopyrightFooter': Allow for site and per-namespace customization of
3053 copyright notice.
3054 $title: displayed page title
3055 $type: 'normal' or 'history' for old/diff views
3056 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
3057 message must be in HTML format, not wikitext!
3058 &$link: overridable HTML link to be passed into the message as $1
3059 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
3060 content language.
3061
3062 'SkinEditSectionLinks': Modify the section edit links
3063 $skin: Skin object rendering the UI
3064 $title: Title object for the title being linked to (may not be the same as
3065 the page title, if the section is included from a template)
3066 $section: The designation of the section being pointed to, to be included in
3067 the link, like "&section=$section"
3068 $tooltip: The default tooltip. Escape before using.
3069 By default, this is wrapped in the 'editsectionhint' message.
3070 &$result: Array containing all link detail arrays. Each link detail array should
3071 contain the following keys:
3072 - targetTitle - Target Title object
3073 - text - String for the text
3074 - attribs - Array of attributes
3075 - query - Array of query parameters to add to the URL
3076 $lang: The language code to use for the link in the wfMessage function
3077
3078 'SkinGetPoweredBy': TODO
3079 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
3080 the MediaWiki icon but plain text instead.
3081 $skin: Skin object
3082
3083 'SkinPreloadExistence': Supply titles that should be added to link existence
3084 cache before the page is rendered.
3085 &$titles: Array of Title objects
3086 $skin: Skin object
3087
3088 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
3089 If false is returned $subpages will be used instead of the HTML
3090 subPageSubtitle() generates.
3091 If true is returned, $subpages will be ignored and the rest of
3092 subPageSubtitle() will run.
3093 &$subpages: Subpage links HTML
3094 $skin: Skin object
3095 $out: OutputPage object
3096
3097 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
3098 link" tab.
3099 &$sktemplate: SkinTemplate object
3100 &$nav_urls: array of tabs
3101 &$revid: The revision id of the permanent link
3102 &$revid2: The revision id of the permanent link, second time
3103
3104 'SkinTemplateGetLanguageLink': After building the data for a language link from
3105 which the actual html is constructed.
3106 &$languageLink: array containing data about the link. The following keys can be
3107 modified: href, text, title, class, lang, hreflang. Each of them is a string.
3108 $languageLinkTitle: Title object belonging to the external language link.
3109 $title: Title object of the page the link belongs to.
3110 $outputPage: The OutputPage object the links are built from.
3111
3112 'SkinTemplateNavigation': Called on content pages after the tabs have been
3113 added, but before variants have been added.
3114 &$sktemplate: SkinTemplate object
3115 &$links: Structured navigation links. This is used to alter the navigation for
3116 skins which use buildNavigationUrls such as Vector.
3117
3118 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
3119 tab is added but before variants have been added.
3120 &$sktemplate: SkinTemplate object
3121 &$links: Structured navigation links. This is used to alter the navigation for
3122 skins which use buildNavigationUrls such as Vector.
3123
3124 'SkinTemplateNavigation::Universal': Called on both content and special pages
3125 after variants have been added.
3126 &$sktemplate: SkinTemplate object
3127 &$links: Structured navigation links. This is used to alter the navigation for
3128 skins which use buildNavigationUrls such as Vector.
3129
3130 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
3131 page output.
3132 &$sktemplate: SkinTemplate object
3133 &$tpl: QuickTemplate engine object
3134
3135 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
3136 &$sktemplate: SkinTemplate object
3137 &$res: set to true to prevent active tabs
3138
3139 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
3140 You can either create your own array, or alter the parameters for
3141 the normal one.
3142 &$sktemplate: The SkinTemplate instance.
3143 $title: Title instance for the page.
3144 $message: Visible label of tab.
3145 $selected: Whether this is a selected tab.
3146 $checkEdit: Whether or not the action=edit query should be added if appropriate.
3147 &$classes: Array of CSS classes to apply.
3148 &$query: Query string to add to link.
3149 &$text: Link text.
3150 &$result: Complete assoc. array if you want to return true.
3151
3152 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
3153 been rendered (useful for adding more).
3154 &$sk: The QuickTemplate based skin template running the hook.
3155 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
3156 extensions that add support for BaseTemplateToolbox should watch for this
3157 dummy parameter with "$dummy=false" in their code and return without echoing
3158 any HTML to avoid creating duplicate toolbox items.
3159
3160 'SoftwareInfo': Called by Special:Version for returning information about the
3161 software.
3162 &$software: The array of software in format 'name' => 'version'. See
3163 SpecialVersion::softwareInformation().
3164
3165 'SpecialBlockModifyFormFields': Add more fields to Special:Block
3166 $sp: SpecialPage object, for context
3167 &$fields: Current HTMLForm fields
3168
3169 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
3170 $id: User id number, only provided for backwards-compatibility
3171 $user: User object representing user contributions are being fetched for
3172 $sp: SpecialPage instance, providing context
3173
3174 'SpecialContributions::formatRow::flags': Called before rendering a
3175 Special:Contributions row.
3176 $context: IContextSource object
3177 $row: Revision information from the database
3178 &$flags: List of flags on this row
3179
3180 'SpecialContributions::getForm::filters': Called with a list of filters to render
3181 on Special:Contributions.
3182 $sp: SpecialContributions object, for context
3183 &$filters: List of filter object definitions (compatible with OOUI form)
3184
3185 'SpecialListusersDefaultQuery': Called right before the end of
3186 UsersPager::getDefaultQuery().
3187 $pager: The UsersPager instance
3188 &$query: The query array to be returned
3189
3190 'SpecialListusersFormatRow': Called right before the end of
3191 UsersPager::formatRow().
3192 &$item: HTML to be returned. Will be wrapped in an <li> after the hook finishes
3193 $row: Database row object
3194
3195 'SpecialListusersHeader': Called after adding the submit button in
3196 UsersPager::getPageHeader().
3197 $pager: The UsersPager instance
3198 &$out: The header HTML
3199
3200 'SpecialListusersHeaderForm': Called before adding the submit button in
3201 UsersPager::getPageHeader().
3202 $pager: The UsersPager instance
3203 &$out: The header HTML
3204
3205 'SpecialListusersQueryInfo': Called right before the end of.
3206 UsersPager::getQueryInfo()
3207 $pager: The UsersPager instance
3208 &$query: The query array to be returned
3209
3210 'SpecialLogAddLogSearchRelations': Add log relations to the current log
3211 $type: String of the log type
3212 $request: WebRequest object for getting the value provided by the current user
3213 &$qc: Array for query conditions to add
3214
3215 'SpecialMovepageAfterMove': Called after moving a page.
3216 &$movePage: MovePageForm object
3217 &$oldTitle: old title (object)
3218 &$newTitle: new title (object)
3219
3220 'SpecialMuteModifyFormFields': Add more fields to Special:Mute
3221 $sp: SpecialPage object, for context
3222 &$fields: Current HTMLForm fields descriptors
3223
3224 'SpecialMuteSubmit': DEPRECATED since 1.34! Used only for instrumentation on SpecialMute
3225 $data: Array containing information about submitted options on SpecialMute form
3226
3227 'SpecialNewpagesConditions': Called when building sql query for
3228 Special:NewPages.
3229 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3230 $opts: FormOptions object containing special page options
3231 &$conds: array of WHERE conditionals for query
3232 &$tables: array of tables to be queried
3233 &$fields: array of columns to select
3234 &$join_conds: join conditions for the tables
3235
3236 'SpecialNewPagesFilters': Called after building form options at NewPages.
3237 $special: the special page object
3238 &$filters: associative array of filter definitions. The keys are the HTML
3239 name/URL parameters. Each key maps to an associative array with a 'msg'
3240 (message key) and a 'default' value.
3241
3242 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3243 this hook to remove a core special page or conditionally register special pages.
3244 &$list: list (array) of core special pages
3245
3246 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3247 $special: the SpecialPage object
3248 $subPage: the subpage string or null if no subpage was specified
3249
3250 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3251 Return false to prevent execution.
3252 $special: the SpecialPage object
3253 $subPage: the subpage string or null if no subpage was specified
3254
3255 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3256 $name: name of the special page
3257 &$form: HTMLForm object
3258
3259 'SpecialPasswordResetOnSubmit': When executing a form submission on
3260 Special:PasswordReset.
3261 &$users: array of User objects.
3262 $data: array of data submitted by the user
3263 &$error: string, error code (message key) used to describe to error (out
3264 parameter). The hook needs to return false when setting this, otherwise it
3265 will have no effect.
3266
3267 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3268 use this to change some selection criteria or substitute a different title.
3269 &$randstr: The random number from wfRandom()
3270 &$isRedir: Boolean, whether to select a redirect or non-redirect
3271 &$namespaces: An array of namespace indexes to get the title from
3272 &$extra: An array of extra SQL statements
3273 &$title: If the hook returns false, a Title object to use instead of the
3274 result from the normal query
3275
3276 'SpecialRecentChangesPanel': Called when building form options in
3277 SpecialRecentChanges.
3278 &$extraOpts: array of added items, to which can be added
3279 $opts: FormOptions for this request
3280
3281 'SpecialResetTokensTokens': Called when building token list for
3282 SpecialResetTokens.
3283 &$tokens: array of token information arrays in the format of
3284 [
3285 'preference' => '<preference-name>',
3286 'label-message' => '<message-key>',
3287 ]
3288
3289 'SpecialSearchCreateLink': Called when making the message to create a page or
3290 go to the existing page.
3291 $t: title object searched for
3292 &$params: an array of the default message name and page title (as parameter)
3293
3294 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3295 canceled and a normal search will be performed. Returning true without setting
3296 $url does a standard redirect to $title. Setting $url redirects to the
3297 specified URL.
3298 $term: The string the user searched for
3299 $title: The title the 'go' feature has decided to forward the user to
3300 &$url: Initially null, hook subscribers can set this to specify the final url to
3301 redirect to
3302
3303 'SpecialSearchNogomatch': Called when the 'Go' feature is triggered (generally
3304 from autocomplete search other than the main bar on Special:Search) and the
3305 target doesn't exist. Full text search results are generated after this hook is
3306 called.
3307 &$title: title object generated from the text entered by the user
3308
3309 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3310 the advanced form, a.k.a. power search box.
3311 &$showSections: an array to add values with more options to
3312 $term: the search term (not a title object)
3313 &$opts: an array of hidden options (containing 'redirs' and 'profile')
3314
3315 'SpecialSearchProfileForm': Allows modification of search profile forms.
3316 $search: special page object
3317 &$form: String: form html
3318 $profile: String: current search profile
3319 $term: String: search term
3320 $opts: Array: key => value of hidden options for inclusion in custom forms
3321
3322 'SpecialSearchProfiles': Allows modification of search profiles.
3323 &$profiles: profiles, which can be modified.
3324
3325 'SpecialSearchResults': Called before search result display
3326 $term: string of search term
3327 &$titleMatches: empty or ISearchResultSet object
3328 &$textMatches: empty or ISearchResultSet object
3329
3330 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3331 on the search results page. Useful for including an external search
3332 provider. To disable the output of MediaWiki search output, return
3333 false.
3334 $specialSearch: SpecialSearch object ($this)
3335 $output: $wgOut
3336 $term: Search term specified by the user
3337
3338 'SpecialSearchResultsAppend': Called immediately before returning HTML
3339 on the search results page. Useful for including a feedback link.
3340 $specialSearch: SpecialSearch object ($this)
3341 $output: $wgOut
3342 $term: Search term specified by the user
3343
3344 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3345 $search: SpecialSearch special page object
3346 $profile: String: current search profile
3347 $engine: the search engine
3348
3349 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3350 &$extraStats: Array to save the new stats
3351 $extraStats['<name of statistic>'] => <value>;
3352 <value> can be an array with the keys "name" and "number":
3353 "name" is the HTML to be displayed in the name column
3354 "number" is the number to be displayed.
3355 or, <value> can be the number to be displayed and <name> is the
3356 message key to use in the name column,
3357 $context: IContextSource object
3358
3359 'SpecialTrackingCategories::preprocess': Called after LinkBatch on
3360 Special:TrackingCategories
3361 $specialPage: The SpecialTrackingCategories object
3362 $trackingCategories: Array of data from Special:TrackingCategories with msg and
3363 cats
3364
3365 'SpecialTrackingCategories::generateCatLink': Called for each cat link on
3366 Special:TrackingCategories
3367 $specialPage: The SpecialTrackingCategories object
3368 $catTitle: The Title object of the linked category
3369 &$html: The Result html
3370
3371 'SpecialUploadComplete': Called after successfully uploading a file from
3372 Special:Upload.
3373 &$form: The SpecialUpload object
3374
3375 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3376 $wgVersion: Current $wgVersion for you to use
3377 &$versionUrl: Raw url to link to (eg: release notes)
3378
3379 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3380 SpecialWatchlist. Allows extensions to register custom values they have
3381 inserted to rc_type so they can be returned as part of the watchlist.
3382 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3383
3384 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3385 URL for a title when we have no other parameters on the URL. Gives a chance for
3386 extensions that alter page view behavior radically to abort that redirect or
3387 handle it manually.
3388 $request: WebRequest
3389 $title: Title of the currently found title obj
3390 $output: OutputPage object
3391
3392 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3393 rendered (by ThumbnailImage:toHtml method).
3394 $thumbnail: the ThumbnailImage object
3395 &$attribs: image attribute array
3396 &$linkAttribs: image link attribute array
3397
3398 'TitleArrayFromResult': Called when creating an TitleArray object from a
3399 database result.
3400 &$titleArray: set this to an object to override the default object returned
3401 $res: database result used to create the object
3402
3403 'TitleExists': Called when determining whether a page exists at a given title.
3404 $title: The title being tested.
3405 &$exists: Whether the title exists.
3406
3407 'TitleGetEditNotices': Allows extensions to add edit notices
3408 $title: The Title object for the page the edit notices are for
3409 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3410 &$notices: Array of notices. Keys are i18n message keys, values are
3411 parseAsBlock()ed messages.
3412
3413 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3414 that can be applied.
3415 $title: The title in question.
3416 &$types: The types of protection available.
3417
3418 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3419 overriding default behavior for determining if a page exists. If $isKnown is
3420 kept as null, regular checks happen. If it's a boolean, this value is returned
3421 by the isKnown method.
3422 $title: Title object that is being checked
3423 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3424
3425 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3426 that this hook is not called for interwiki pages or pages in immovable
3427 namespaces: for these, isMovable() always returns false.
3428 $title: Title object that is being checked
3429 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3430 Hooks may change this value to override the return value of
3431 Title::isMovable().
3432
3433
3434 'TitleMove': Before moving an article (title).
3435 $old: old title
3436 $nt: new title
3437 $user: user who does the move
3438 $reason: string of the reason provided by the user
3439 &$status: Status object. To abort the move, add a fatal error to this object
3440 (i.e. call $status->fatal()).
3441
3442 'TitleMoveStarting': Before moving an article (title), but just after the atomic
3443 DB section starts.
3444 $old: old title
3445 $nt: new title
3446 $user: user who does the move
3447
3448 'TitleMoveComplete': After moving an article (title), post-commit.
3449 &$old: old title
3450 &$nt: new title
3451 &$user: user who did the move
3452 $pageid: database ID of the page that's been moved
3453 $redirid: database ID of the created redirect
3454 $reason: reason for the move
3455 $revision: the Revision created by the move
3456
3457 'TitleMoveCompleting': After moving an article (title), pre-commit.
3458 $old: old title
3459 $nt: new title
3460 $user: user who did the move
3461 $pageid: database ID of the page that's been moved
3462 $redirid: database ID of the created redirect
3463 $reason: reason for the move
3464 $revision: the Revision created by the move
3465
3466 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3467 or override the quick permissions check.
3468 $title: The Title object being accessed
3469 $user: The User performing the action
3470 $action: Action being performed
3471 &$errors: Array of errors
3472 $doExpensiveQueries: Whether to do expensive DB queries
3473 $short: Whether to return immediately on first error
3474
3475 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3476 adding the default error message if nothing allows the user to read the page. If
3477 a handler wants a title to *not* be whitelisted, it should also return false.
3478 $title: Title object being checked against
3479 $user: Current user object
3480 &$whitelisted: Boolean value of whether this title is whitelisted
3481
3482 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3483 $title: Title object to purge
3484 &$urls: An array of URLs to purge from the caches, to be manipulated.
3485
3486 'UnblockUser': Before an IP address or user is unblocked.
3487 &$block: The Block object about to be saved
3488 &$user: The user performing the unblock (not the one being unblocked)
3489 &$reason: If the hook is aborted, the error message to be returned in an array
3490
3491 'UnblockUserComplete': After an IP address or user has been unblocked.
3492 $block: The Block object that was saved
3493 $user: The user who performed the unblock (not the one being unblocked)
3494
3495 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3496 PageArchive object has been created but before any further processing is done.
3497 &$archive: PageArchive object
3498 $title: Title object of the page that we're viewing
3499
3500 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3501 PageArchive object has been created but before any further processing is done.
3502 &$archive: PageArchive object
3503 $title: Title object of the page that we're viewing
3504
3505 'UndeleteForm::undelete': Called in UndeleteForm::undelete, after checking that
3506 the site is not in read-only mode, that the Title object is not null and after
3507 a PageArchive object has been constructed but before performing any further
3508 processing.
3509 &$archive: PageArchive object
3510 $title: Title object of the page that we're about to undelete
3511
3512 'UndeletePageToolLinks': Add one or more links to edit page subtitle when a page
3513 has been previously deleted.
3514 $context: IContextSource (object)
3515 $linkRenderer: LinkRenderer instance
3516 &$links: Array of HTML strings
3517
3518 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3519 $title: title object related to the revision
3520 $rev: revision (object) that will be viewed
3521
3522 'UnitTestsAfterDatabaseSetup': Called right after MediaWiki's test
3523 infrastructure has finished creating/duplicating core tables for unit tests.
3524 $database: Database in question
3525 $prefix: Table prefix to be used in unit tests
3526
3527 'UnitTestsBeforeDatabaseTeardown': Called right before MediaWiki tears down its
3528 database infrastructure used for unit tests.
3529
3530 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3531 Since 1.24: Paths pointing to a directory will be recursively scanned for
3532 test case files matching the suffix "Test.php".
3533 &$paths: list of test cases and directories to search.
3534
3535 'UnwatchArticle': Before a watch is removed from an article.
3536 &$user: user watching
3537 &$page: WikiPage object to be removed
3538 &$status: Status object to be returned if the hook returns false
3539
3540 'UnwatchArticleComplete': After a watch is removed from an article.
3541 $user: user that watched
3542 &$page: WikiPage object that was watched
3543
3544 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3545 &$formattedPageStatus: list of valid page states
3546
3547 'UploadComplete': Upon completion of a file upload.
3548 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3549 $uploadBase->getLocalFile().
3550
3551 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3552 $type: (string) the requested upload type
3553 &$className: the class name of the Upload instance to be created
3554
3555 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3556 poke at member variables like $mUploadDescription before the file is saved.
3557 Do not use this hook to break upload processing.
3558 This will return the user to a blank form with no error message;
3559 use UploadVerifyUpload or UploadVerifyFile instead.
3560 &$upload: SpecialUpload object
3561
3562 'UploadForm:getInitialPageText': After the initial page text for file uploads
3563 is generated, to allow it to be altered.
3564 &$pageText: the page text
3565 $msg: array of header messages
3566 $config: Config object
3567
3568 'UploadForm:initial': Before the upload form is generated. You might set the
3569 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3570 text (HTML) either before or after the editform.
3571 &$upload: SpecialUpload object
3572
3573 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3574 assembled.
3575 &$descriptor: (array) the HTMLForm descriptor
3576
3577 'UploadFormSourceDescriptors': after the standard source inputs have been
3578 added to the descriptor
3579 &$descriptor: (array) the HTMLForm descriptor
3580 &$radio: Boolean, if source type should be shown as radio button
3581 $selectedSourceType: The selected source type
3582
3583 'UploadStashFile': Before a file is stashed (uploaded to stash).
3584 Note that code which has not been updated for MediaWiki 1.28 may not call this
3585 hook. If your extension absolutely, positively must prevent some files from
3586 being uploaded, use UploadVerifyFile or UploadVerifyUpload.
3587 $upload: (object) An instance of UploadBase, with all info about the upload
3588 $user: (object) An instance of User, the user uploading this file
3589 $props: (array|null) File properties, as returned by
3590 MWFileProps::getPropsFromPath(). Note this is not always guaranteed to be set,
3591 e.g. in test scenarios. Call MWFileProps::getPropsFromPath() yourself in case
3592 you need the information.
3593 &$error: output: If the file stashing should be prevented, set this to the
3594 reason in the form of [ messagename, param1, param2, ... ] or a
3595 MessageSpecifier instance (you might want to use ApiMessage to provide machine
3596 -readable details for the API).
3597
3598 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3599 in most cases over UploadVerification.
3600 $upload: (object) an instance of UploadBase, with all info about the upload
3601 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3602 Handlers will typically only apply for specific MIME types.
3603 &$error: (object) output: true if the file is valid. Otherwise, set this to the
3604 reason in the form of [ messagename, param1, param2, ... ] or a
3605 MessageSpecifier instance (you might want to use ApiMessage to provide machine
3606 -readable details for the API).
3607
3608 'UploadVerifyUpload': Upload verification, based on both file properties like
3609 MIME type (same as UploadVerifyFile) and the information entered by the user
3610 (upload comment, file page contents etc.).
3611 $upload: (object) An instance of UploadBase, with all info about the upload
3612 $user: (object) An instance of User, the user uploading this file
3613 $props: (array|null) File properties, as returned by
3614 MWFileProps::getPropsFromPath(). Note this is not always guaranteed to be set,
3615 e.g. in test scenarios. Call MWFileProps::getPropsFromPath() yourself in case
3616 you need the information.
3617 $comment: (string) Upload log comment (also used as edit summary)
3618 $pageText: (string) File description page text (only used for new uploads)
3619 &$error: output: If the file upload should be prevented, set this to the reason
3620 in the form of [ messagename, param1, param2, ... ] or a MessageSpecifier
3621 instance (you might want to use ApiMessage to provide machine-readable details
3622 for the API).
3623
3624 'UserIsBot': when determining whether a user is a bot account
3625 $user: the user
3626 &$isBot: whether this is user a bot or not (boolean)
3627
3628 'User::mailPasswordInternal': before creation and mailing of a user's new
3629 temporary password
3630 &$user: the user who sent the message out
3631 &$ip: IP of the user who sent the message out
3632 &$u: the account whose new password will be set
3633
3634 'UserAddGroup': Called when adding a group or changing a group's expiry; return
3635 false to override stock group addition.
3636 $user: the user object that is to have a group added
3637 &$group: the group to add; can be modified
3638 &$expiry: the expiry time in TS_MW format, or null if the group is not to
3639 expire; can be modified
3640
3641 'UserArrayFromResult': Called when creating an UserArray object from a database
3642 result.
3643 &$userArray: set this to an object to override the default object returned
3644 $res: database result used to create the object
3645
3646 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3647 want to display an error message, try getUserPermissionsErrors.
3648 &$title: Title object being checked against
3649 &$user: Current user object
3650 $action: Action being checked
3651 &$result: Pointer to result returned if hook returns false. If null is returned,
3652 userCan checks are continued by internal code.
3653
3654 'UserCanSendEmail': To override User::canSendEmail() permission check.
3655 &$user: User (object) whose permission is being checked
3656 &$canSend: bool set on input, can override on output
3657
3658 'UserClearNewTalkNotification': Called when clearing the "You have new
3659 messages!" message, return false to not delete it.
3660 &$user: User (object) that will clear the message
3661 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3662
3663 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3664 &$user: User to get groups for
3665 &$groups: Current effective groups
3666
3667 'UserGetAllRights': After calculating a list of all available rights.
3668 &$rights: Array of rights, which may be added to.
3669
3670 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3671 before returning the options to the caller. Warning: This hook is called for
3672 every call to User::getDefaultOptions(), which means it's potentially called
3673 dozens or hundreds of times. You may want to cache the results of non-trivial
3674 operations in your hook function for this reason.
3675 &$defaultOptions: Array of preference keys and their default values.
3676
3677 'UserGetEmail': Called when getting an user email address.
3678 $user: User object
3679 &$email: email, change this to override local email
3680
3681 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3682 email authentication.
3683 $user: User object
3684 &$timestamp: timestamp, change this to override local email authentication
3685 timestamp
3686
3687 'UserGetLanguageObject': Called when getting user's interface language object.
3688 $user: User object
3689 &$code: Language code that will be used to create the object
3690 $context: IContextSource object
3691
3692 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3693 &$reservedUsernames: $wgReservedUsernames
3694
3695 'UserGetRights': Called in User::getRights().
3696 $user: User to get rights for
3697 &$rights: Current rights
3698
3699 'UserGetRightsRemove': Called in User::getRights(). This hook override
3700 the UserGetRights hook. It can be used to remove rights from user
3701 and ensure that will not be reinserted by the other hook callbacks
3702 therefore this hook should not be used to add any rights, use UserGetRights instead.
3703 $user: User to get rights for
3704 &$rights: Current rights
3705
3706 'UserGroupsChanged': Called after user groups are changed.
3707 $user: User whose groups changed
3708 $added: Groups added
3709 $removed: Groups removed
3710 $performer: User who performed the change, false if via autopromotion
3711 $reason: The reason, if any, given by the user performing the change,
3712 false if via autopromotion.
3713 $oldUGMs: An associative array (group name => UserGroupMembership object) of
3714 the user's group memberships before the change.
3715 $newUGMs: An associative array (group name => UserGroupMembership object) of
3716 the user's current group memberships.
3717
3718 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3719 specific block exemptions if a user is already blocked).
3720 $user: User in question
3721 $title: Title of the page in question
3722 &$blocked: Out-param, whether or not the user is blocked from that page.
3723 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3724 to edit their own user talk pages.
3725
3726 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3727 &$user: User object
3728 $ip: User's IP address
3729 &$blocked: Whether the user is blocked, to be modified by the hook
3730 &$block: The Block object, to be modified by the hook
3731
3732 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3733 false if a UserGetRights hook might remove the named right.
3734 $right: The user right being checked
3735
3736 'UserIsHidden': DEPRECATED since 1.34 - use GetUserBlock instead, and add a
3737 system block that hides the user. Check if the user's name should be hidden.
3738 See User::isHidden().
3739 $user: User in question.
3740 &$hidden: Set true if the user's name should be hidden.
3741
3742 'UserIsLocked': Check if the user is locked. See User::isLocked().
3743 $user: User in question.
3744 &$locked: Set true if the user should be locked.
3745
3746 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3747 environmental means; occurs after session is loaded.
3748 $user: user object being loaded
3749
3750 'UserLoadDefaults': Called when loading a default user.
3751 $user: user object
3752 $name: user name
3753
3754 'UserLoadFromDatabase': Called when loading a user from the database.
3755 $user: user object
3756 &$s: database query object
3757
3758 'UserLoadOptions': When user options/preferences are being loaded from the
3759 database.
3760 $user: User object
3761 &$options: Options, can be modified.
3762
3763 'UserLoggedIn': Called after a user is logged in
3764 $user: User object for the logged-in user
3765
3766 'UserLoginComplete': Show custom content after a user has logged in via the Web
3767 interface. For functionality that needs to run after any login (API or web) use
3768 UserLoggedIn.
3769 &$user: the user object that was created on login
3770 &$inject_html: Any HTML to inject after the "logged in" message.
3771 $direct: (bool) The hook is called directly after a successful login. This will
3772 only happen once per login. A UserLoginComplete call with direct=false can
3773 happen when the user visits the login page while already logged in.
3774
3775 'UserLogout': Before a user logs out.
3776 &$user: the user object that is about to be logged out
3777
3778 'UserLogoutComplete': After a user has logged out.
3779 &$user: the user object _after_ logout (won't have name, ID, etc.)
3780 &$inject_html: Any HTML to inject after the "logged out" message.
3781 $oldName: name of the user before logout (string)
3782
3783 'UserMailerChangeReturnPath': Called to generate a VERP return address
3784 when UserMailer sends an email, with a bounce handling extension.
3785 $to: Array of MailAddress objects for the recipients
3786 &$returnPath: The return address string
3787
3788 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3789 to split up an email with multiple the To: field into separate emails.
3790 &$to: array of MailAddress objects; unset the ones which should be mailed
3791 separately
3792
3793 'UserMailerTransformContent': Called in UserMailer::send() to change email
3794 contents. Extensions can block sending the email by returning false and setting
3795 $error.
3796 $to: array of MailAdresses of the targets
3797 $from: MailAddress of the sender
3798 &$body: email body, either a string (for plaintext emails) or an array with
3799 'text' and 'html' keys
3800 &$error: should be set to an error message string
3801
3802 'UserMailerTransformMessage': Called in UserMailer::send() to change email after
3803 it has gone through the MIME transform. Extensions can block sending the email
3804 by returning false and setting $error.
3805 $to: array of MailAdresses of the targets
3806 $from: MailAddress of the sender
3807 &$subject: email subject (not MIME encoded)
3808 &$headers: email headers (except To: and Subject:) as an array of header
3809 name => value pairs
3810 &$body: email body (in MIME format) as a string
3811 &$error: should be set to an error message string
3812
3813 'UserRemoveGroup': Called when removing a group; return false to override stock
3814 group removal.
3815 $user: the user object that is to have a group removed
3816 &$group: the group to be removed, can be modified
3817
3818 'UserRequiresHTTPS': Called to determine whether a user needs
3819 to be switched to HTTPS.
3820 $user: User in question.
3821 &$https: Boolean whether $user should be switched to HTTPS.
3822
3823 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3824 have been requested to be reset. This hook can be used to exclude certain
3825 options from being reset even when the user has requested all prefs to be reset,
3826 because certain options might be stored in the user_properties database table
3827 despite not being visible and editable via Special:Preferences.
3828 $user: the User (object) whose preferences are being reset
3829 &$newOptions: array of new (site default) preferences
3830 $options: array of the user's old preferences
3831 $resetKinds: array containing the kinds of preferences to reset
3832
3833 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3834 message(s).
3835 &$user: user retrieving new talks messages
3836 &$talks: array of new talks page(s)
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 since 1.32! 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 being dumped. DEPRECATED, use $rev instead.
4000 $text: The revision text to be dumped. DEPRECATED, use $rev instead.
4001 $rev: The RevisionRecord that is being dumped to XML
4002
4003 More hooks might be available but undocumented, you can execute
4004 "php maintenance/findHooks.php" to find hidden ones.