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