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