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