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