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