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