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