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