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