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