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