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