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