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