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