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