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