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