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