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