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