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