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