Merge "Adding a bunch of hooks from wikiHow into DifferenceEngine"
[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 'DifferenceEngineMarkPatrolledLink': Allows extensions to change the "mark as patrolled" link
1140 which is shown both on the diff header as well as on the bottom of a page, usually
1141 wrapped in a span element which has class="patrollink".
1142 $differenceEngine: DifferenceEngine object
1143 &$markAsPatrolledLink: The "mark as patrolled" link HTML (string)
1144 $rcid: Recent change ID (rc_id) for this change (int)
1145 $token: Patrol token; $rcid is used in generating this variable
1146
1147 'DifferenceEngineMarkPatrolledRCID': Allows extensions to possibly change the rcid parameter.
1148 For example the rcid might be set to zero due to the user being the same as the
1149 performer of the change but an extension might still want to show it under certain
1150 conditions.
1151 &$rcid: rc_id (int) of the change or 0
1152 $differenceEngine: DifferenceEngine object
1153 $change: RecentChange object
1154 $user: User object representing the current user
1155
1156 'DifferenceEngineNewHeader': Allows extensions to change the $newHeader variable, which
1157 contains information about the new revision, such as the revision's author, whether
1158 the revision was marked as a minor edit or not, etc.
1159 $differenceEngine: DifferenceEngine object
1160 &$newHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1161 include things like revision author info, revision comment, RevisionDelete link and more
1162 $formattedRevisionTools: Array containing revision tools, some of which may have
1163 been injected with the DiffRevisionTools hook
1164 $nextlink: String containing the link to the next revision (if any); also included in $newHeader
1165 $rollback: Rollback link (string) to roll this revision back to the previous one, if any
1166 $newminor: String indicating if the new revision was marked as a minor edit
1167 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1168 whether we should show just the diff; passed in as a query string parameter to the
1169 various URLs constructed here (i.e. $nextlink)
1170 $rdel: RevisionDelete link for the new revision, if the current user is allowed
1171 to use the RevisionDelete feature
1172 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1173
1174 'DifferenceEngineOldHeader': Allows extensions to change the $oldHeader variable, which
1175 contains information about the old revision, such as the revision's author, whether
1176 the revision was marked as a minor edit or not, etc.
1177 $differenceEngine: DifferenceEngine object
1178 &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which
1179 include things like revision author info, revision comment, RevisionDelete link and more
1180 $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
1181 $oldminor: String indicating if the old revision was marked as a minor edit
1182 $diffOnly: Boolean parameter passed to DifferenceEngine#showDiffPage, indicating
1183 whether we should show just the diff; passed in as a query string parameter to the
1184 various URLs constructed here (i.e. $prevlink)
1185 $ldel: RevisionDelete link for the old revision, if the current user is allowed
1186 to use the RevisionDelete feature
1187 $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions
1188
1189 'DifferenceEngineOldHeaderNoOldRev': Change the $oldHeader variable in cases when
1190 there is no old revision
1191 &$oldHeader: empty string by default
1192
1193 'DifferenceEngineRenderRevisionAddParserOutput': Allows extensions to change the parser output.
1194 Return false to not add parser output via OutputPage's addParserOutput method.
1195 $differenceEngine: DifferenceEngine object
1196 $out: OutputPage object
1197 $parserOutput: ParserOutput object
1198 $wikiPage: WikiPage object
1199
1200 'DifferenceEngineRenderRevisionShowFinalPatrolLink': An extension can hook into this hook
1201 point and return false to not show the final "mark as patrolled" link on the bottom
1202 of a page.
1203 This hook has no arguments.
1204
1205 'DifferenceEngineShowDiff': Allows extensions to affect the diff text which
1206 eventually gets sent to the OutputPage object.
1207 $differenceEngine: DifferenceEngine object
1208
1209 'DifferenceEngineShowEmptyOldContent': Allows extensions to change the diff table
1210 body (without header) in cases when there is no old revision or the old and new
1211 revisions are identical.
1212 $differenceEngine: DifferenceEngine object
1213
1214 'DifferenceEngineShowDiffPage': Add additional output via the available OutputPage
1215 object into the diff view
1216 $out: OutputPage object
1217
1218 'DiffRevisionTools': Override or extend the revision tools available from the
1219 diff view, i.e. undo, etc.
1220 $newRev: Revision object of the "new" revision
1221 &$links: Array of HTML links
1222 $oldRev: Revision object of the "old" revision (may be null)
1223 $user: Current user object
1224
1225 'DiffViewHeader': Called before diff display
1226 $diff: DifferenceEngine object that's calling
1227 $oldRev: Revision object of the "old" revision (may be null/invalid)
1228 $newRev: Revision object of the "new" revision
1229
1230 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1231 an article
1232 &$article: article (object) being viewed
1233 &$oldid: oldid (int) being viewed
1234
1235 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1236 Override the HTML generated for section edit links
1237 $skin: Skin object rendering the UI
1238 $title: Title object for the title being linked to (may not be the same as
1239 the page title, if the section is included from a template)
1240 $section: The designation of the section being pointed to, to be included in
1241 the link, like "&section=$section"
1242 $tooltip: The default tooltip. Escape before using.
1243 By default, this is wrapped in the 'editsectionhint' message.
1244 &$result: The HTML to return, prefilled with the default plus whatever other
1245 changes earlier hooks have made
1246 $lang: The language code to use for the link in the wfMessage function
1247
1248 'EditFilter': Perform checks on an edit
1249 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1250 $text: Contents of the edit box
1251 $section: Section being edited
1252 &$error: Error message to return
1253 $summary: Edit summary for page
1254
1255 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1256 Post-section-merge edit filter.
1257 $editor: EditPage instance (object)
1258 $text: content of the edit box
1259 &$error: error message to return
1260 $summary: Edit summary for page
1261
1262 'EditFilterMergedContent': Post-section-merge edit filter.
1263 This may be triggered by the EditPage or any other facility that modifies page
1264 content. Use the $status object to indicate whether the edit should be allowed,
1265 and to provide a reason for disallowing it. Return false to abort the edit, and
1266 true to continue. Returning true if $status->isOK() returns false means "don't
1267 save but continue user interaction", e.g. show the edit form.
1268 $status->apiHookResult can be set to an array to be returned by api.php
1269 action=edit. This is used to deliver captchas.
1270 $context: object implementing the IContextSource interface.
1271 $content: content of the edit box, as a Content object.
1272 $status: Status object to represent errors, etc.
1273 $summary: Edit summary for page
1274 $user: the User object representing the user whois performing the edit.
1275 $minoredit: whether the edit was marked as minor by the user.
1276
1277 'EditFormInitialText': Allows modifying the edit form when editing existing
1278 pages
1279 $editPage: EditPage object
1280
1281 'EditFormPreloadText': Allows population of the edit form when creating
1282 new pages
1283 &$text: Text to preload with
1284 &$title: Title object representing the page being created
1285
1286 'EditPage::attemptSave': Called before an article is
1287 saved, that is before WikiPage::doEditContent() is called
1288 $editpage_Obj: the current EditPage object
1289
1290 'EditPage::attemptSave:after': Called after an article save attempt
1291 $editpage_Obj: the current EditPage object
1292 $status: the resulting Status object
1293 $resultDetails: Result details array
1294
1295 'EditPage::importFormData': allow extensions to read additional data
1296 posted in the form
1297 $editpage: EditPage instance
1298 $request: Webrequest
1299 return value is ignored (should always return true)
1300
1301 'EditPage::showEditForm:fields': allows injection of form field into edit form
1302 Return value is ignored (should always return true)
1303 &$editor: the EditPage instance for reference
1304 &$out: an OutputPage instance to write to
1305
1306 'EditPage::showEditForm:initial': before showing the edit form
1307 Return false to halt editing; you'll need to handle error messages, etc.
1308 yourself. Alternatively, modifying $error and returning true will cause the
1309 contents of $error to be echoed at the top of the edit form as wikitext.
1310 Return true without altering $error to allow the edit to proceed.
1311 &$editor: EditPage instance (object)
1312 &$out: an OutputPage instance to write to
1313
1314 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1315 but for the read-only 'view source' variant of the edit form.
1316 Return value is ignored (should always return true)
1317 $editor: EditPage instance (object)
1318 &$out: an OutputPage instance to write to
1319
1320 'EditPage::showStandardInputs:options': allows injection of form fields into
1321 the editOptions area
1322 Return value is ignored (should always be true)
1323 $editor: EditPage instance (object)
1324 $out: an OutputPage instance to write to
1325 &$tabindex: HTML tabindex of the last edit check/button
1326
1327 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1328 when there's an edit conflict. Return false to halt normal diff output; in
1329 this case you're responsible for computing and outputting the entire "conflict"
1330 part, i.e., the "difference between revisions" and "your text" headers and
1331 sections.
1332 &$editor: EditPage instance
1333 &$out: OutputPage instance
1334
1335 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1336 textarea in the edit form.
1337 &$editpage: The current EditPage object
1338 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1339 &$tabindex: HTML tabindex of the last edit check/button
1340
1341 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1342 in the edit form.
1343 &$editpage: The current EditPage object
1344 &$checks: Array of edit checks like "watch this page"/"minor edit"
1345 &$tabindex: HTML tabindex of the last edit check/button
1346
1347 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1348 textarea in the edit form.
1349 &$toolbar: The toolbar HTMl
1350
1351 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1352 contribution/copyright notice.
1353 $title: title of page being edited
1354 &$msg: localization message name, overridable. Default is either
1355 'copyrightwarning' or 'copyrightwarning2'.
1356
1357 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1358 "Show changes". Note that it is preferable to implement diff handling for
1359 different data types using the ContentHandler facility.
1360 $editPage: EditPage object
1361 &$newtext: wikitext that will be used as "your version"
1362
1363 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1364 Allow modifying the wikitext that will be used in "Show changes". Note that it
1365 is preferable to implement diff handling for different data types using the
1366 ContentHandler facility.
1367 $editPage: EditPage object
1368 &$newtext: wikitext that will be used as "your version"
1369
1370 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1371 previewed. Note that it is preferable to implement previews for different data
1372 types using the ContentHandler facility.
1373 $editPage: EditPage object
1374 &$content: Content object to be previewed (may be replaced by hook function)
1375
1376 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1377 Allow modifying the wikitext that will be previewed. Note that it is preferable
1378 to implement previews for different data types using the ContentHandler
1379 facility.
1380 $editPage: EditPage object
1381 &$toparse: wikitext that will be parsed
1382
1383 'EditPageNoSuchSection': When a section edit request is given for an
1384 non-existent section
1385 &$editpage: The current EditPage object
1386 &$res: the HTML of the error text
1387
1388 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1389 of terms of service summary link that might exist separately from the copyright
1390 notice.
1391 $title: title of page being edited
1392 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1393
1394 'EmailConfirmed': When checking that the user's email address is "confirmed".
1395 This runs before the other checks, such as anonymity and the real check; return
1396 true to allow those checks to occur, and false if checking is done.
1397 &$user: User being checked
1398 &$confirmed: Whether or not the email address is confirmed
1399
1400 'EmailUser': Before sending email from one user to another.
1401 &$to: MailAddress object of receiving user
1402 &$from: MailAddress object of sending user
1403 &$subject: subject of the mail
1404 &$text: text of the mail
1405 &$error: Out-param for an error
1406
1407 'EmailUserCC': Before sending the copy of the email to the author.
1408 &$to: MailAddress object of receiving user
1409 &$from: MailAddress object of sending user
1410 &$subject: subject of the mail
1411 &$text: text of the mail
1412
1413 'EmailUserComplete': After sending email from one user to another.
1414 $to: MailAddress object of receiving user
1415 $from: MailAddress object of sending user
1416 $subject: subject of the mail
1417 $text: text of the mail
1418
1419 'EmailUserForm': After building the email user form object.
1420 &$form: HTMLForm object
1421
1422 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1423 user.
1424 $user: The user who is trying to email another user.
1425 $editToken: The user's edit token.
1426 &$hookErr: Out-param for the error. Passed as the parameters to
1427 OutputPage::showErrorPage.
1428
1429 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1430 group of changes in EnhancedChangesList.
1431 Hook subscribers can return false to omit this line from recentchanges.
1432 $changesList: EnhancedChangesList object
1433 &$links: The links that were generated by EnhancedChangesList
1434 $block: The RecentChanges objects in that block
1435
1436 'EnhancedChangesListModifyLineData': to alter data used to build
1437 a grouped recent change inner line in EnhancedChangesList.
1438 Hook subscribers can return false to omit this line from recentchanges.
1439 $changesList: EnhancedChangesList object
1440 &$data: An array with all the components that will be joined in order to create the line
1441 $block: An array of RecentChange objects in that block
1442 $rc: The RecentChange object for this line
1443 &$classes: An array of classes to change
1444
1445 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1446 a non-grouped recent change line in EnhancedChangesList.
1447 $changesList: EnhancedChangesList object
1448 &$data: An array with all the components that will be joined in order to create the line
1449 $rc: The RecentChange object for this line
1450
1451 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1452 throttle.
1453 $ip: The ip address of the user
1454
1455 'ExtensionTypes': Called when generating the extensions credits, use this to
1456 change the tables headers.
1457 &$extTypes: associative array of extensions types
1458
1459 'ExtractThumbParameters': DEPRECATED! Media handler should override
1460 MediaHandler::parseParamString instead.
1461 Called when extracting thumbnail parameters from a thumbnail file name.
1462 $thumbname: the base name of the thumbnail file
1463 &$params: the currently extracted params (has source name, temp or archived
1464 zone)
1465
1466 'FetchChangesList': When fetching the ChangesList derivative for a particular
1467 user.
1468 $user: User the list is being fetched for
1469 &$skin: Skin object to be used with the list
1470 &$list: List object (defaults to NULL, change it to an object instance and
1471 return false override the list derivative used)
1472
1473 'FileDeleteComplete': When a file is deleted.
1474 &$file: reference to the deleted file
1475 &$oldimage: in case of the deletion of an old image, the name of the old file
1476 &$article: in case all revisions of the file are deleted a reference to the
1477 WikiFilePage associated with the file.
1478 &$user: user who performed the deletion
1479 &$reason: reason
1480
1481 'FileTransformed': When a file is transformed and moved into storage.
1482 $file: reference to the File object
1483 $thumb: the MediaTransformOutput object
1484 $tmpThumbPath: The temporary file system path of the transformed file
1485 $thumbPath: The permanent storage path of the transformed file
1486
1487 'FileUndeleteComplete': When a file is undeleted
1488 $title: title object to the file
1489 $fileVersions: array of undeleted versions. Empty if all versions were restored
1490 $user: user who performed the undeletion
1491 $reason: reason
1492
1493 'FileUpload': When a file upload occurs.
1494 $file: Image object representing the file that was uploaded
1495 $reupload: Boolean indicating if there was a previously another image there or
1496 not (since 1.17)
1497 $hasDescription: Boolean indicating that there was already a description page
1498 and a new one from the comment wasn't created (since 1.17)
1499
1500 'FormatAutocomments': When an autocomment is formatted by the Linker.
1501 &$comment: Reference to the accumulated comment. Initially null, when set the
1502 default code will be skipped.
1503 $pre: Boolean, true if there is text before this autocomment
1504 $auto: The extracted part of the parsed comment before the call to the hook.
1505 $post: Boolean, true if there is text after this autocomment
1506 $title: An optional title object used to links to sections. Can be null.
1507 $local: Boolean indicating whether section links should refer to local page.
1508 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1509 autocomment originated; null for the local wiki. Added in 1.26, should default
1510 to null in handler functions, for backwards compatibility.
1511
1512 'GalleryGetModes': Get list of classes that can render different modes of a
1513 gallery.
1514 &$modeArray: An associative array mapping mode names to classes that implement
1515 that mode. It is expected all registered classes are a subclass of
1516 ImageGalleryBase.
1517
1518 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1519 entitled to be in.
1520 $user: user to promote.
1521 &$promote: groups that will be added.
1522
1523 'GetBlockedStatus': after loading blocking status of an user from the database
1524 &$user: user (object) being checked
1525
1526 'GetCacheVaryCookies': Get cookies that should vary cache options.
1527 $out: OutputPage object
1528 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1529 that have to vary cache options
1530
1531 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1532 notifications.
1533 &$title: Title object of page
1534 &$url: string value as output (out parameter, can modify)
1535 $query: query options passed to Title::getCanonicalURL()
1536
1537 'GetDefaultSortkey': Override the default sortkey for a page.
1538 $title: Title object that we need to get a sortkey for
1539 &$sortkey: Sortkey to use.
1540
1541 'GetDifferenceEngine': Called when getting a new difference engine interface
1542 object Return false for valid object in $differenceEngine or true for the
1543 default difference engine.
1544 $context: IContextSource context to be used for diff
1545 $old: Revision ID to show and diff with
1546 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1547 $refreshCache: If set, refreshes the diff cache
1548 $unhide: If set, allow viewing deleted revs
1549 &$differenceEngine: output parameter, difference engine object to be used for
1550 diff
1551
1552 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1553 underscore) magic words. Called by MagicWord.
1554 &$doubleUnderscoreIDs: array of strings
1555
1556 'GetExtendedMetadata': Get extended file metadata for the API
1557 &$combinedMeta: Array of the form:
1558 'MetadataPropName' => array(
1559 value' => prop value,
1560 'source' => 'name of hook'
1561 ).
1562 $file: File object of file in question
1563 $context: RequestContext (including language to use)
1564 $single: Only extract the current language; if false, the prop value should
1565 be in the metadata multi-language array format:
1566 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1567 &$maxCacheTime: how long the results can be cached
1568
1569 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1570 &$title: Title object of page
1571 &$url: string value as output (out parameter, can modify)
1572 $query: query options passed to Title::getFullURL()
1573
1574 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1575 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1576 the custom output.
1577 &$output: string for the output timestamp
1578 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1579 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1580 $user: User whose preferences are being used to make timestamp
1581 $lang: Language that will be used to render the timestamp
1582
1583 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1584 &$title: Title object of page
1585 &$url: string value as output (out parameter, can modify)
1586 $query: query options passed to Title::getInternalURL()
1587
1588 'GetIP': modify the ip of the current user (called only once).
1589 &$ip: string holding the ip as determined so far
1590
1591 'GetLinkColours': modify the CSS class of an array of page links.
1592 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1593 indexed by page_id.
1594 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1595
1596 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1597 working with internal urls (non-interwiki) then it may be preferable to work
1598 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1599 be buggy for internal urls on render if you do not re-implement the horrible
1600 hack that Title::getLocalURL uses in your own extension.
1601 &$title: Title object of page
1602 &$url: string value as output (out parameter, can modify)
1603 $query: query options passed to Title::getLocalURL()
1604
1605 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1606 without any fancy queries or variants.
1607 &$title: Title object of page
1608 &$url: string value as output (out parameter, can modify)
1609
1610 'GetLocalURL::Internal': Modify local URLs to internal pages.
1611 &$title: Title object of page
1612 &$url: string value as output (out parameter, can modify)
1613 $query: query options passed to Title::getLocalURL()
1614
1615 'GetLogTypesOnUser': Add log types where the target is a userpage
1616 &$types: Array of log types
1617
1618 'GetMetadataVersion': Modify the image metadata version currently in use. This
1619 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1620 that need to have versioned metadata should add an element to the end of the
1621 version array of the form 'handler_name=version'. Most media handlers won't need
1622 to do this unless they broke backwards compatibility with a previous version of
1623 the media handler metadata output.
1624 &$version: Array of version strings
1625
1626 'GetNewMessagesAlert': Disable or modify the new messages alert
1627 &$newMessagesAlert: An empty string by default. If the user has new talk page
1628 messages, this should be populated with an alert message to that effect
1629 $newtalks: An empty array if the user has no new messages or an array
1630 containing links and revisions if there are new messages (See
1631 User::getNewMessageLinks)
1632 $user: The user object of the user who is loading the page
1633 $out: OutputPage object (to check what type of page the user is on)
1634
1635 'GetPreferences': Modify user preferences.
1636 $user: User whose preferences are being modified.
1637 &$preferences: Preferences description array, to be fed to an HTMLForm object
1638
1639 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1640 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1641 custom output.
1642 &$output: string for the output timestamp
1643 &$diff: DateInterval representing the difference between the timestamps
1644 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1645 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1646 $user: User whose preferences are being used to make timestamp
1647 $lang: Language that will be used to render the timestamp
1648
1649 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1650 checked for. Use instead of userCan for most cases. Return false if the user
1651 can't do it, and populate $result with the reason in the form of
1652 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1653 might want to use ApiMessage to provide machine-readable details for the API).
1654 For consistency, error messages
1655 should be plain text with no special coloring, bolding, etc. to show that
1656 they're errors; presenting them properly to the user as errors is done by the
1657 caller.
1658 &$title: Title object being checked against
1659 &$user: Current user object
1660 $action: Action being checked
1661 &$result: User permissions error to add. If none, return true.
1662
1663 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1664 called only if expensive checks are enabled. Add a permissions error when
1665 permissions errors are checked for. Return false if the user can't do it, and
1666 populate $result with the reason in the form of array( messagename, param1,
1667 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1668 to provide machine-readable details for the API). For consistency, error
1669 messages should be plain text with no
1670 special coloring, bolding, etc. to show that they're errors; presenting them
1671 properly to the user as errors is done by the caller.
1672 &$title: Title object being checked against
1673 &$user: Current user object
1674 $action: Action being checked
1675 &$result: User permissions error to add. If none, return true.
1676
1677 'GitViewers': Called when generating the list of git viewers for
1678 Special:Version, use this to change the list.
1679 &$extTypes: associative array of repo URLS to viewer URLs.
1680
1681 'HistoryRevisionTools': Override or extend the revision tools available from the
1682 page history view, i.e. undo, rollback, etc.
1683 $rev: Revision object
1684 &$links: Array of HTML links
1685 $prevRev: Revision object, next in line in page history, or null
1686 $user: Current user object
1687
1688 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1689 cache.
1690 $context: An IContextSource object with information about the request being
1691 served.
1692
1693 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1694 image insertion. You can skip the default logic entirely by returning false, or
1695 just modify a few things using call-by-reference.
1696 &$skin: Skin object
1697 &$title: Title object of the image
1698 &$file: File object, or false if it doesn't exist
1699 &$frameParams: Various parameters with special meanings; see documentation in
1700 includes/Linker.php for Linker::makeImageLink
1701 &$handlerParams: Various parameters with special meanings; see documentation in
1702 includes/Linker.php for Linker::makeImageLink
1703 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1704 &$res: Final HTML output, used if you return false
1705
1706 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1707 the image on an image page.
1708 &$imagePage: ImagePage object ($this)
1709 &$output: $wgOut
1710
1711 'ImagePageAfterImageLinks': Called after the image links section on an image
1712 page is built.
1713 $imagePage: ImagePage object ($this)
1714 &$html: HTML for the hook to add
1715
1716 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1717 $imagePage: ImagePage object ($this)
1718 $file: the file
1719 &$line: the HTML of the history line
1720 &$css: the line CSS class
1721
1722 'ImagePageFindFile': Called when fetching the file associated with an image
1723 page.
1724 $page: ImagePage object
1725 &$file: File object
1726 &$displayFile: displayed File object
1727
1728 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1729 $page: ImagePage object
1730 &$toc: Array of <li> strings
1731
1732 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1733 using img_auth.php.
1734 &$title: the Title object of the file as it would appear for the upload page
1735 &$path: the original file and path name when img_auth was invoked by the web
1736 server
1737 &$name: the name only component of the file
1738 &$result: The location to pass back results of the hook routine (only used if
1739 failed)
1740 $result[0]=The index of the header message
1741 $result[1]=The index of the body text message
1742 $result[2 through n]=Parameters passed to body text message. Please note the
1743 header message cannot receive/use parameters.
1744
1745 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1746 Return false to stop further processing of the tag
1747 $reader: XMLReader object
1748 $logInfo: Array of information
1749
1750 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1751 Return false to stop further processing of the tag
1752 $reader: XMLReader object
1753 &$pageInfo: Array of information
1754
1755 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1756 Return false to stop further processing of the tag
1757 $reader: XMLReader object
1758 $pageInfo: Array of page information
1759 $revisionInfo: Array of revision information
1760
1761 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1762 Return false to stop further processing of the tag
1763 $reader: XMLReader object
1764
1765 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1766 Return false to stop further processing of the tag
1767 $reader: XMLReader object
1768 $revisionInfo: Array of information
1769
1770 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1771 and edit summaries for transwiki imports.
1772 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1773 &$pageTitle: String that contains page title.
1774
1775 'ImportSources': Called when reading from the $wgImportSources configuration
1776 variable. Can be used to lazy-load the import sources list.
1777 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1778 comment in DefaultSettings.php for the detail of how to structure this array.
1779
1780 'InfoAction': When building information to display on the action=info page.
1781 $context: IContextSource object
1782 &$pageInfo: Array of information
1783
1784 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1785 &$title: Title object for the current page
1786 &$request: WebRequest
1787 &$ignoreRedirect: boolean to skip redirect check
1788 &$target: Title/string of redirect target
1789 &$article: Article object
1790
1791 'InternalParseBeforeLinks': during Parser's internalParse method before links
1792 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1793 &$parser: Parser object
1794 &$text: string containing partially parsed text
1795 &$stripState: Parser's internal StripState object
1796
1797 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1798 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1799 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1800 template/parser function execution which respect nowiki and HTML-comments.
1801 &$parser: Parser object
1802 &$text: string containing partially parsed text
1803 &$stripState: Parser's internal StripState object
1804
1805 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1806 Return true without providing an interwiki to continue interwiki search.
1807 $prefix: interwiki prefix we are looking for.
1808 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1809 iw_trans and optionally iw_api and iw_wikiid.
1810
1811 'InvalidateEmailComplete': Called after a user's email has been invalidated
1812 successfully.
1813 $user: user (object) whose email is being invalidated
1814
1815 'IRCLineURL': When constructing the URL to use in an IRC notification.
1816 Callee may modify $url and $query, URL will be constructed as $url . $query
1817 &$url: URL to index.php
1818 &$query: Query string
1819 $rc: RecentChange object that triggered url generation
1820
1821 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1822 &$article: article (object) being checked
1823
1824 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1825 &$ip: IP being check
1826 &$result: Change this value to override the result of IP::isTrustedProxy()
1827
1828 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1829 $url: URL used to upload from
1830 &$allowed: Boolean indicating if uploading is allowed for given URL
1831
1832 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1833 instance to return false if the domain name doesn't match your organization.
1834 $addr: The e-mail address entered by the user
1835 &$result: Set this and return false to override the internal checks
1836
1837 'isValidPassword': Override the result of User::isValidPassword()
1838 $password: The password entered by the user
1839 &$result: Set this and return false to override the internal checks
1840 $user: User the password is being validated for
1841
1842 'Language::getMessagesFileName':
1843 $code: The language code or the language we're looking for a messages file for
1844 &$file: The messages file path, you can override this to change the location.
1845
1846 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1847 $wgExtensionMessagesFiles instead.
1848 Use this to define synonyms of magic words depending of the language
1849 &$magicExtensions: associative array of magic words synonyms
1850 $lang: language code (string)
1851
1852 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1853 remove namespaces. Do not use this hook to add namespaces. Use
1854 CanonicalNamespaces for that.
1855 &$namespaces: Array of namespaces indexed by their numbers
1856
1857 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1858 listed in $wgExtensionMessagesFiles instead.
1859 Use to define aliases of special pages names depending of the language
1860 &$specialPageAliases: associative array of magic words synonyms
1861 $lang: language code (string)
1862
1863 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1864 &$names: array of language code => language name
1865 $code: language of the preferred translations
1866
1867 'LanguageLinks': Manipulate a page's language links. This is called
1868 in various places to allow extensions to define the effective language
1869 links for a page.
1870 $title: The page's Title.
1871 &$links: Associative array mapping language codes to prefixed links of the
1872 form "language:title".
1873 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1874 Currently unused, but planned to provide support for marking individual
1875 language links in the UI, e.g. for featured articles.
1876
1877 'LanguageSelector': Hook to change the language selector available on a page.
1878 $out: The output page.
1879 $cssClassName: CSS class name of the language selector.
1880
1881 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1882 Used when generating internal and interwiki links in
1883 Linker::link(), before processing starts. Return false to skip default
1884 processing and return $ret. See documentation for Linker::link() for details on
1885 the expected meanings of parameters.
1886 $skin: the Skin object
1887 $target: the Title that the link is pointing to
1888 &$html: the contents that the <a> tag should have (raw HTML); null means
1889 "default".
1890 &$customAttribs: the HTML attributes that the <a> tag should have, in
1891 associative array form, with keys and values unescaped. Should be merged
1892 with default values, with a value of false meaning to suppress the
1893 attribute.
1894 &$query: the query string to add to the generated URL (the bit after the "?"),
1895 in associative array form, with keys and values unescaped.
1896 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1897 &$ret: the value to return if your hook returns false.
1898
1899 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1900 Used when generating internal and interwiki links in Linker::link(),
1901 just before the function returns a value. If you return true, an <a> element
1902 with HTML attributes $attribs and contents $html will be returned. If you
1903 return false, $ret will be returned.
1904 $skin: the Skin object
1905 $target: the Title object that the link is pointing to
1906 $options: the options. Will always include either 'known' or 'broken', and may
1907 include 'noclasses'.
1908 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1909 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1910 associative array form.
1911 &$ret: the value to return if your hook returns false.
1912
1913 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1914 before the return.
1915 &$url: the image url
1916 &$alt: the image's alt text
1917 &$img: the new image HTML (if returning false)
1918
1919 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1920 before the return.
1921 &$url: the link url
1922 &$text: the link text
1923 &$link: the new link HTML (if returning false)
1924 &$attribs: the attributes to be applied.
1925 $linkType: The external link type
1926
1927 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1928 before the return.
1929 $title: the Title object that the link is pointing to
1930 $file: the File object or false if broken link
1931 &$html: the link text
1932 &$attribs: the attributes to be applied
1933 &$ret: the value to return if your hook returns false
1934
1935 'HtmlPageLinkRendererBegin':
1936 Used when generating internal and interwiki links in
1937 LinkRenderer, before processing starts. Return false to skip default
1938 processing and return $ret.
1939 $linkRenderer: the LinkRenderer object
1940 $target: the LinkTarget that the link is pointing to
1941 &$html: the contents that the <a> tag should have (raw HTML); null means
1942 "default".
1943 &$customAttribs: the HTML attributes that the <a> tag should have, in
1944 associative array form, with keys and values unescaped. Should be merged
1945 with default values, with a value of false meaning to suppress the
1946 attribute.
1947 &$query: the query string to add to the generated URL (the bit after the "?"),
1948 in associative array form, with keys and values unescaped.
1949 &$ret: the value to return if your hook returns false.
1950
1951 'HtmlPageLinkRendererEnd':
1952 Used when generating internal and interwiki links in LinkRenderer,
1953 just before the function returns a value. If you return true, an <a> element
1954 with HTML attributes $attribs and contents $html will be returned. If you
1955 return false, $ret will be returned.
1956 $linkRenderer: the LinkRenderer object
1957 $target: the LinkTarget object that the link is pointing to
1958 $isKnown: boolean indicating whether the page is known or not
1959 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1960 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1961 associative array form.
1962 &$ret: the value to return if your hook returns false.
1963
1964 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1965 actual update.
1966 &$linksUpdate: the LinksUpdate object
1967
1968 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1969 each link table insert. For example, pagelinks, imagelinks, externallinks.
1970 $linksUpdate: LinksUpdate object
1971 $table: the table to insert links to
1972 $insertions: an array of links to insert
1973
1974 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1975 including delete and insert, has completed for all link tables
1976 &$linksUpdate: the LinksUpdate object
1977
1978 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1979 &$linksUpdate: the LinksUpdate object
1980
1981 'ListDefinedTags': When trying to find all defined tags.
1982 &$tags: The list of tags.
1983
1984 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1985 $updater: A DatabaseUpdater subclass
1986
1987 'LocalFile::getHistory': Called before file history query performed.
1988 &$file: the File object
1989 &$tables: tables
1990 &$fields: select fields
1991 &$conds: conditions
1992 &$opts: query options
1993 &$join_conds: JOIN conditions
1994
1995 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1996 $file: the File object
1997 $archiveName: name of an old file version or false if it's the current one
1998
1999 'LocalisationCacheRecache': Called when loading the localisation data into
2000 cache.
2001 $cache: The LocalisationCache object
2002 $code: language code
2003 &$alldata: The localisation data from core and extensions
2004 &$purgeBlobs: whether to purge/update the message blobs via
2005 MessageBlobStore::clear()
2006
2007 'LocalisationCacheRecacheFallback': Called for each language when merging
2008 fallback data into the cache.
2009 $cache: The LocalisationCache object
2010 $code: language code
2011 &$alldata: The localisation data from core and extensions. Note some keys may
2012 be omitted if they won't be merged into the final result.
2013
2014 'LocalisationChecksBlacklist': When fetching the blacklist of
2015 localisation checks.
2016 &$blacklist: array of checks to blacklist. See the bottom of
2017 maintenance/language/checkLanguage.inc for the format of this variable.
2018
2019 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
2020 optional localisation messages
2021 &$ignored: Array of ignored message keys
2022 &$optional: Array of optional message keys
2023
2024 'LocalUserCreated': Called when a local user has been created
2025 $user: User object for the created user
2026 $autocreated: Boolean, whether this was an auto-creation
2027
2028 'LogEventsListGetExtraInputs': When getting extra inputs to display on
2029 Special:Log for a specific log type
2030 $type: String of log type being displayed
2031 $logEventsList: LogEventsList object for context and access to the WebRequest
2032 &$input: string HTML of an input element
2033
2034 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
2035 Returning false will prevent the string from being added to the OutputPage.
2036 &$s: html string to show for the log extract
2037 $types: String or Array Log types to show
2038 $page: String or Title The page title to show log entries for
2039 $user: String The user who made the log entries
2040 $param: Associative Array with the following additional options:
2041 - lim Integer Limit of items to show, default is 50
2042 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
2043 - showIfEmpty boolean Set to false if you don't want any output in case the
2044 loglist is empty if set to true (default), "No matching items in log" is
2045 displayed if loglist is empty
2046 - msgKey Array If you want a nice box with a message, set this to the key of
2047 the message. First element is the message key, additional optional elements
2048 are parameters for the key that are processed with
2049 wfMessage()->params()->parseAsBlock()
2050 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
2051 offset
2052 - wrap String Wrap the message in html (usually something like
2053 "&lt;div ...>$1&lt;/div>").
2054 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
2055
2056 'LogException': Called before an exception (or PHP error) is logged. This is
2057 meant for integration with external error aggregation services; returning false
2058 will NOT prevent logging.
2059 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
2060 $suppressed: true if the error was suppressed via
2061 error_reporting()/wfSuppressWarnings()
2062
2063 'LoginAuthenticateAudit': A login attempt for a valid user account either
2064 succeeded or failed. No return data is accepted; this hook is for auditing only.
2065 $user: the User object being authenticated against
2066 $password: the password being submitted and found wanting
2067 $retval: a LoginForm class constant with authenticateUserData() return
2068 value (SUCCESS, WRONG_PASS, etc.).
2069
2070 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
2071 error messages. Allows to add additional error messages (except messages already
2072 in LoginForm::$validErrorMessages).
2073 &$messages: Already added messages (inclusive messages from
2074 LoginForm::$validErrorMessages)
2075
2076 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
2077 Called during login to allow extensions the opportunity to inform a user that
2078 their username doesn't exist for a specific reason, instead of letting the
2079 login form give the generic error message that the account does not exist. For
2080 example, when the account has been renamed or deleted.
2081 $user: the User object being authenticated against.
2082 &$msg: the message identifier for abort reason, or an array to pass a message
2083 key and parameters.
2084
2085 'LogLine': Processes a single log entry on Special:Log.
2086 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2087 logging.log_type database field.
2088 $log_action: string for the type of log action (e.g. 'delete', 'block',
2089 'create2'). Corresponds to logging.log_action database field.
2090 $title: Title object that corresponds to logging.log_namespace and
2091 logging.log_title database fields.
2092 $paramArray: Array of parameters that corresponds to logging.log_params field.
2093 Note that only $paramArray[0] appears to contain anything.
2094 &$comment: string that corresponds to logging.log_comment database field, and
2095 which is displayed in the UI.
2096 &$revert: string that is displayed in the UI, similar to $comment.
2097 $time: timestamp of the log entry (added in 1.12)
2098
2099 'LonelyPagesQuery': Allow extensions to modify the query used by
2100 Special:LonelyPages.
2101 &$tables: tables to join in the query
2102 &$conds: conditions for the query
2103 &$joinConds: join conditions for the query
2104
2105 'MagicWordwgVariableIDs': When defining new magic words IDs.
2106 &$variableIDs: array of strings
2107
2108 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2109 script.
2110 $refreshLinks: RefreshLinks object
2111
2112 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2113 Ideally, this hook should only be used to add variables that depend on
2114 the current page/request; static configuration should be added through
2115 ResourceLoaderGetConfigVars instead.
2116 &$vars: variable (or multiple variables) to be added into the output of
2117 Skin::makeVariablesScript
2118 $out: The OutputPage which called the hook, can be used to get the real title.
2119
2120 'MarkPatrolled': Before an edit is marked patrolled.
2121 $rcid: ID of the revision to be marked patrolled
2122 &$user: the user (object) marking the revision as patrolled
2123 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2124 sysop in order to mark an edit patrolled.
2125 $auto: true if the edit is being marked as patrolled automatically
2126
2127 'MarkPatrolledComplete': After an edit is marked patrolled.
2128 $rcid: ID of the revision marked as patrolled
2129 &$user: user (object) who marked the edit patrolled
2130 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2131 sysop to patrol the edit.
2132 $auto: true if the edit is being marked as patrolled automatically
2133
2134 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2135 something completely different, after the basic globals have been set up, but
2136 before ordinary actions take place.
2137 $output: $wgOut
2138 $article: Article on which the action will be performed
2139 $title: Title on which the action will be performed
2140 $user: $wgUser
2141 $request: $wgRequest
2142 $mediaWiki: The $mediawiki object
2143
2144 'MediaWikiServices': Called when a global MediaWikiServices instance is
2145 initialized. Extensions may use this to define, replace, or wrap services.
2146 However, the preferred way to define a new service is
2147 the $wgServiceWiringFiles array.
2148 $services: MediaWikiServices
2149
2150 'MessageCache::get': When fetching a message. Can be used to override the key
2151 for customisations. Given and returned message key must be in special format:
2152 1) first letter must be in lower case according to the content language.
2153 2) spaces must be replaced with underscores
2154 &$key: message key (string)
2155
2156 'MessageCacheReplace': When a message page is changed. Useful for updating
2157 caches.
2158 $title: name of the page changed.
2159 $text: new contents of the page.
2160
2161 'MessagesPreLoad': When loading a message from the database.
2162 $title: title of the message (string)
2163 &$message: value (string), change it to the message you want to define
2164
2165 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2166 $mimeMagic: Instance of MimeMagic.
2167 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2168 &$tail: More or equal than last 65558 bytes of the file in a string
2169 (in - Do not alter!).
2170 $file: File path.
2171 &$mime: MIME type (out).
2172
2173 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2174 MIME type detected by considering the file extension.
2175 $mimeMagic: Instance of MimeMagic.
2176 $ext: File extension.
2177 &$mime: MIME type (in/out).
2178
2179 'MimeMagicInit': Before processing the list mapping MIME types to media types
2180 and the list mapping MIME types to file extensions.
2181 As an extension author, you are encouraged to submit patches to MediaWiki's
2182 core to add new MIME types to mime.types.
2183 $mimeMagic: Instance of MimeMagic.
2184 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2185 for adding new MIME info to the list.
2186 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2187 for adding new MIME types to the list.
2188
2189 'ModifyExportQuery': Modify the query used by the exporter.
2190 $db: The database object to be queried.
2191 &$tables: Tables in the query.
2192 &$conds: Conditions in the query.
2193 &$opts: Options for the query.
2194 &$join_conds: Join conditions for the query.
2195
2196 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2197 page.
2198 $oldTitle: Title object of the current (old) location
2199 $newTitle: Title object of the new location
2200 $user: User making the move
2201 $reason: string of the reason provided by the user
2202 $status: Status object to pass error messages to
2203
2204 'MovePageIsValidMove': Specify whether a page can be moved for technical
2205 reasons.
2206 $oldTitle: Title object of the current (old) location
2207 $newTitle: Title object of the new location
2208 $status: Status object to pass error messages to
2209
2210 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2211 namespace.
2212 $index: Integer; the index of the namespace being checked.
2213 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2214 namespace are movable. Hooks may change this value to override the return
2215 value of MWNamespace::isMovable().
2216
2217 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2218 $title: the diff page title (nullable)
2219 &$oldId: the actual old Id to use in the diff
2220 &$newId: the actual new Id to use in the diff (0 means current)
2221 $old: the ?old= param value from the url
2222 $new: the ?new= param value from the url
2223
2224 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2225 edit.
2226 $wikiPage: the WikiPage edited
2227 $rev: the new revision
2228 $baseID: the revision ID this was based off, if any
2229 $user: the editing user
2230
2231 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2232 return false to omit the line from RecentChanges and Watchlist special pages.
2233 &$changeslist: The OldChangesList instance.
2234 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2235 $rc: The RecentChange object.
2236 &$classes: array of css classes for the <li> element
2237
2238 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2239 can alter or append to the array of URLs for search & suggestion formats.
2240 &$urls: array of associative arrays with Url element attributes
2241
2242 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2243 when a page view triggers a re-rendering of the page. This may happen
2244 particularly if the parser cache is split by user language, and no cached
2245 rendering of the page exists in the user's language. The hook is called
2246 before checking whether page_links_updated indicates that the links are up
2247 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2248 without triggering any updates.
2249 $page: the Page that was rendered.
2250 $title: the Title of the rendered page.
2251 $parserOutput: ParserOutput resulting from rendering the page.
2252
2253 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2254 users and/or IP addresses too.
2255 &$otherBlockLink: An array with links to other block logs
2256 $ip: The requested IP address or username
2257
2258 'OutputPageBeforeHTML': A page has been processed by the parser and the
2259 resulting HTML is about to be displayed.
2260 &$parserOutput: the parserOutput (object) that corresponds to the page
2261 &$text: the text that will be displayed, in HTML (string)
2262
2263 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2264 body tag to allow for extensions to add attributes to the body of the page they
2265 might need. Or to allow building extensions to add body classes that aren't of
2266 high enough demand to be included in core.
2267 $out: The OutputPage which called the hook, can be used to get the real title
2268 $sk: The Skin that called OutputPage::headElement
2269 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2270
2271 'OutputPageCheckLastModified': when checking if the page has been modified
2272 since the last visit.
2273 &$modifiedTimes: array of timestamps.
2274 The following keys are set: page, user, epoch
2275 $out: OutputPage object (since 1.28)
2276
2277 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2278 categories. Implementations should return false if they generate the category
2279 links, so the default link generation is skipped.
2280 &$out: OutputPage instance (object)
2281 $categories: associative array, keys are category names, values are category
2282 types ("normal" or "hidden")
2283 &$links: array, intended to hold the result. Must be an associative array with
2284 category types as keys and arrays of HTML links as values.
2285
2286 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2287 &$out: OutputPage instance (object)
2288 $parserOutput: parserOutput instance being added in $out
2289
2290 'PageContentInsertComplete': After a new article is created.
2291 $wikiPage: WikiPage created
2292 $user: User creating the article
2293 $content: New content as a Content object
2294 $summary: Edit summary/comment
2295 $isMinor: Whether or not the edit was marked as minor
2296 $isWatch: (No longer used)
2297 $section: (No longer used)
2298 $flags: Flags passed to WikiPage::doEditContent()
2299 $revision: New Revision of the article
2300
2301 'PageContentLanguage': Allows changing the language in which the content of a
2302 page is written. Defaults to the wiki content language ($wgContLang).
2303 $title: Title object
2304 &$pageLang: the page content language (either an object or a language code)
2305 $wgLang: the user language
2306
2307 'PageContentSave': Before an article is saved.
2308 $wikiPage: the WikiPage (object) being saved
2309 $user: the user (object) saving the article
2310 $content: the new article content, as a Content object
2311 $summary: the article summary (comment)
2312 $isminor: minor flag
2313 $iswatch: watch flag
2314 $section: section #
2315
2316 'PageContentSaveComplete': After an article has been updated.
2317 $wikiPage: WikiPage modified
2318 $user: User performing the modification
2319 $content: New content, as a Content object
2320 $summary: Edit summary/comment
2321 $isMinor: Whether or not the edit was marked as minor
2322 $isWatch: (No longer used)
2323 $section: (No longer used)
2324 $flags: Flags passed to WikiPage::doEditContent()
2325 $revision: New Revision of the article (can be null for edits that change
2326 nothing)
2327 $status: Status object about to be returned by doEditContent()
2328 $baseRevId: the rev ID (or false) this edit was based on
2329
2330 'PageHistoryBeforeList': When a history page list is about to be constructed.
2331 &$article: the article that the history is loading for
2332 $context: RequestContext object
2333
2334 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2335 $historyAction: the action object
2336 &$row: the revision row for this line
2337 &$s: the string representing this parsed line
2338 &$classes: array containing the <li> element classes
2339
2340 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2341 any output is generated, to allow batch lookups for prefetching information
2342 needed for display. If the hook handler returns false, the regular behavior of
2343 doBatchLookups() is skipped.
2344 $pager: the PageHistoryPager
2345 $result: a ResultWrapper representing the query result
2346
2347 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2348 constructed.
2349 &$pager: the pager
2350 &$queryInfo: the query parameters
2351
2352 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2353 which depends on user options should install this hook and append its values to
2354 the key.
2355 &$confstr: reference to a hash key string which can be modified
2356 $user: User (object) requesting the page
2357 &$forOptions: array of options the hash is for
2358
2359 'PageViewUpdates': Allow database (or other) changes to be made after a
2360 page view is seen by MediaWiki. Note this does not capture views made
2361 via external caches such as Squid.
2362 $wikipage: WikiPage (object) for the page being viewed.
2363 $user: User (object) for the user who is viewing.
2364
2365 'ParserAfterParse': Called from Parser::parse() just after the call to
2366 Parser::internalParse() returns.
2367 &$parser: parser object
2368 &$text: text being parsed
2369 &$stripState: stripState used (object)
2370
2371 'ParserAfterStrip': Called at end of parsing time.
2372 TODO: No more strip, deprecated ?
2373 &$parser: parser object
2374 &$text: text being parsed
2375 &$stripState: stripState used (object)
2376
2377 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2378 &$parser: Parser object being used
2379 &$text: text that will be returned
2380
2381 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2382 Parser::internalParseHalfParsed()
2383 &$parser: Parser object being used
2384 &$text: text that will be returned
2385
2386 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2387 &$parser: Parser object
2388 &$text: text to parse
2389 &$stripState: StripState instance being used
2390
2391 'ParserBeforeStrip': Called at start of parsing time.
2392 TODO: No more strip, deprecated ?
2393 &$parser: parser object
2394 &$text: text being parsed
2395 &$stripState: stripState used (object)
2396
2397 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2398 &$parser: Parser object being used
2399 &$text: actual text
2400
2401 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2402 the parser cache.
2403 $parserCache: ParserCache object $parserOutput was stored in
2404 $parserOutput: ParserOutput object that was stored
2405 $title: Title of the page that was parsed to generate $parserOutput
2406 $popts: ParserOptions used for generating $parserOutput
2407 $revId: ID of the revision that was parsed to create $parserOutput
2408
2409 'ParserClearState': Called at the end of Parser::clearState().
2410 &$parser: Parser object being cleared
2411
2412 'ParserCloned': Called when the parser is cloned.
2413 $parser: Newly-cloned Parser object
2414
2415 'ParserFirstCallInit': Called when the parser initialises for the first time.
2416 &$parser: Parser object being cleared
2417
2418 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2419 custom magic word
2420 &$parser: Parser object
2421 &$varCache: array to store the value in case of multiples calls of the
2422 same magic word
2423 &$index: index (string) of the magic
2424 &$ret: value of the magic word (the hook should set it)
2425 &$frame: PPFrame object to use for expanding any template variables
2426
2427 'ParserGetVariableValueTs': Use this to change the value of the time for the
2428 {{LOCAL...}} magic word.
2429 &$parser: Parser object
2430 &$time: actual time (timestamp)
2431
2432 'ParserGetVariableValueVarCache': use this to change the value of the variable
2433 cache or return false to not use it.
2434 &$parser: Parser object
2435 &$varCache: variable cache (array)
2436
2437 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2438 ParserLimitReportFormat instead.
2439 Called at the end of Parser:parse() when the parser will
2440 include comments about size of the text parsed.
2441 $parser: Parser object
2442 &$limitReport: text that will be included (without comment tags)
2443
2444 'ParserLimitReportFormat': Called for each row in the parser limit report that
2445 needs formatting. If nothing handles this hook, the default is to use "$key" to
2446 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2447 format the value.
2448 $key: Key for the limit report item (string)
2449 &$value: Value of the limit report item
2450 &$report: String onto which to append the data
2451 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2452 text intended for display in a monospaced font.
2453 $localize: If false, $report should be output in English.
2454
2455 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2456 will include comments about size of the text parsed. Hooks should use
2457 $output->setLimitReportData() to populate data. Functions for this hook should
2458 not use $wgLang; do that in ParserLimitReportFormat instead.
2459 $parser: Parser object
2460 $output: ParserOutput object
2461
2462 'ParserMakeImageParams': Called before the parser make an image link, use this
2463 to modify the parameters of the image.
2464 $title: title object representing the file
2465 $file: file object that will be used to create the image
2466 &$params: 2-D array of parameters
2467 $parser: Parser object that called the hook
2468
2469 'ParserSectionCreate': Called each time the parser creates a document section
2470 from wikitext. Use this to apply per-section modifications to HTML (like
2471 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2472 can begin in one section and end in another. Make sure your code can handle
2473 that case gracefully. See the EditSectionClearerLink extension for an example.
2474 $parser: the calling Parser instance
2475 $section: the section number, zero-based, but section 0 is usually empty
2476 &$sectionContent: ref to the content of the section. modify this.
2477 $showEditLinks: boolean describing whether this section has an edit link
2478
2479 'ParserTestGlobals': Allows to define globals for parser tests.
2480 &$globals: Array with all the globals which should be set for parser tests.
2481 The arrays keys serve as the globals names, its values are the globals values.
2482
2483 'ParserTestParser': Called when creating a new instance of Parser in
2484 tests/parser/parserTest.inc.
2485 &$parser: Parser object created
2486
2487 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2488 run. Use when page save hooks require the presence of custom tables to ensure
2489 that tests continue to run properly.
2490 &$tables: array of table names
2491
2492 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2493 $page: the WikiPage of the candidate edit
2494 $content: the Content object of the candidate edit
2495 $output: the ParserOutput result of the candidate edit
2496 $summary: the change summary of the candidate edit
2497 $user: the User considering the edit
2498
2499 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2500 $user: User object whose policy you are modifying
2501 &$effectivePolicy: Array of policy statements that apply to this user
2502 $purpose: string indicating purpose of the check, one of 'login', 'create',
2503 or 'reset'
2504
2505 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2506 to a user.
2507 $block: Block object (which is set to be autoblocking)
2508 &$blockIds: Array of block IDs of the autoblock
2509
2510 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2511 my talk page, my contributions" etc).
2512 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2513 &$title: Title object representing the current page
2514 $skin: SkinTemplate object providing context (e.g. to check if the user is
2515 logged in, etc.)
2516
2517 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2518 &$user: User performing the action
2519 $action: Action being performed
2520 &$result: Whether or not the action should be prevented
2521 Change $result and return false to give a definitive answer, otherwise
2522 the built-in rate limiting checks are used, if enabled.
2523 $incrBy: Amount to increment counter by
2524
2525 'PlaceNewSection': Override placement of new sections. Return false and put the
2526 merged text into $text to override the default behavior.
2527 $wikipage: WikiPage object
2528 $oldtext: the text of the article before editing
2529 $subject: subject of the new section
2530 &$text: text of the new section
2531
2532 'PostLoginRedirect': Modify the post login redirect behavior.
2533 Occurs after signing up or logging in, allows for interception of redirect.
2534 &$returnTo: The page name to return to, as a string
2535 &$returnToQuery: array of url parameters, mapping parameter names to values
2536 &$type: type of login redirect as string;
2537 error: display a return to link ignoring $wgRedirectOnLogin
2538 signup: display a return to link using $wgRedirectOnLogin if needed
2539 success: display a return to link using $wgRedirectOnLogin if needed
2540 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2541
2542 'PreferencesFormPreSave': Override preferences being saved
2543 $formData: array of user submitted data
2544 $form: PreferencesForm object, also a ContextSource
2545 $user: User object with preferences to be saved set
2546 &$result: boolean indicating success
2547
2548 'PreferencesGetLegend': Override the text used for the <legend> of a
2549 preferences section.
2550 $form: the PreferencesForm object. This is a ContextSource as well
2551 $key: the section name
2552 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2553 be overridden
2554
2555 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2556 Override the title prefix search used for OpenSearch and
2557 AJAX search suggestions. Put results into &$results outparam and return false.
2558 $ns: array of int namespace keys to search in
2559 $search: search term (not guaranteed to be conveniently normalized)
2560 $limit: maximum number of results to return
2561 &$results: out param: array of page names (strings)
2562 $offset: number of results to offset from the beginning
2563
2564 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2565 namespace from the search string so that extensions can attempt it.
2566 &$namespaces: array of int namespace keys to search in (change this if you can
2567 extract namespaces)
2568 &$search: search term (replace this with term without the namespace if you can
2569 extract one)
2570
2571 'PrefsEmailAudit': Called when user changes their email address.
2572 $user: User (object) changing his email address
2573 $oldaddr: old email address (string)
2574 $newaddr: new email address (string)
2575
2576 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2577 in the form.
2578 $article: the title being (un)protected
2579 &$output: a string of the form HTML so far
2580
2581 'ProtectionForm::save': Called when a protection form is submitted.
2582 $article: the Page being (un)protected
2583 &$errorMsg: an html message string of an error or an array of message name and
2584 its parameters
2585 $reasonstr: a string describing the reason page protection level is altered
2586
2587 'ProtectionForm::showLogExtract': Called after the protection log extract is
2588 shown.
2589 $article: the page the form is shown for
2590 $out: OutputPage object
2591
2592 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2593 random pages.
2594 &$tables: Database tables to be used in the query
2595 &$conds: Conditions to be applied in the query
2596 &$joinConds: Join conditions to be applied in the query
2597
2598 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2599 &$obj: RawAction object
2600 &$text: The text that's going to be the output
2601
2602 'RecentChange_save': Called at the end of RecentChange::save().
2603 &$recentChange: RecentChange object
2604
2605 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2606 names such as "oldid" that are preserved when using redirecting special pages
2607 such as Special:MyPage and Special:MyTalk.
2608 &$redirectParams: An array of parameters preserved by redirecting special pages.
2609
2610 'RejectParserCacheValue': Return false to reject an otherwise usable
2611 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2612 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2613 EXTREME CARE.
2614 $parserOutput: ParserOutput value.
2615 $wikiPage: WikiPage object.
2616 $parserOptions: ParserOptions object.
2617
2618 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2619 instance. Can be used by an extension override what skin is used in certain
2620 contexts.
2621 $context: (IContextSource) The RequestContext the skin is being created for.
2622 &$skin: A variable reference you may set a Skin instance or string key on to
2623 override the skin that will be used for the context.
2624
2625 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2626 flagged to lack same-origin security. Return false to indicate the lack. Note
2627 if the "somehow" involves HTTP headers, you'll probably need to make sure
2628 the header is varied on.
2629 $request: The WebRequest object.
2630
2631 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2632 $user: The user having their password expiration reset
2633 &$newExpire: The new expiration date
2634
2635 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2636 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2637 to override its behavior. See the module docs for more information.
2638 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2639 depend on
2640 $context: ResourceLoaderContext|null
2641
2642 'ResourceLoaderGetConfigVars': Called at the end of
2643 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2644 configuration variables to JavaScript. Things that depend on the current page
2645 or request state must be added through MakeGlobalVariablesScript instead.
2646 &$vars: array( variable name => value )
2647
2648 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2649 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2650 context-based variables.
2651 &$lessVars: array of variables already added
2652
2653 'ResourceLoaderRegisterModules': Right before modules information is required,
2654 such as when responding to a resource
2655 loader request or generating HTML output.
2656 &$resourceLoader: ResourceLoader object
2657
2658 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2659 called after the addition of 'qunit' and MediaWiki testing resources.
2660 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2661 included in core, is fed using tests/qunit/QUnitTestResources.php.
2662 To add a new qunit module named 'myext.tests':
2663 $testModules['qunit']['myext.tests'] = array(
2664 'script' => 'extension/myext/tests.js',
2665 'dependencies' => <any module dependency you might have>
2666 );
2667 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2668 added to any module.
2669 &$ResourceLoader: object
2670
2671 'RevisionInsertComplete': Called after a revision is inserted into the database.
2672 &$revision: the Revision
2673 $data: the data stored in old_text. The meaning depends on $flags: if external
2674 is set, it's the URL of the revision text in external storage; otherwise,
2675 it's the revision text itself. In either case, if gzip is set, the revision
2676 text is gzipped.
2677 $flags: a comma-delimited list of strings representing the options used. May
2678 include: utf8 (this will always be set for new revisions); gzip; external.
2679
2680 'SearchableNamespaces': An option to modify which namespaces are searchable.
2681 &$arr: Array of namespaces ($nsId => $name) which will be used.
2682
2683 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2684 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2685 runs after.
2686 $term: Search term string
2687 &$title: Outparam; set to $title object and return false for a match
2688
2689 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2690 if nothing was found.
2691 $term: Search term string
2692 &$title: Outparam; set to $title object and return false for a match
2693
2694 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2695 the normal operations.
2696 $allSearchTerms: Array of the search terms in all content languages
2697 &$titleResult: Outparam; the value to return. A Title object or null.
2698
2699 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2700 searches.
2701 $term: Search term string
2702 &$title: Current Title object that is being returned (null if none found).
2703
2704 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2705 search results.
2706 $title: Current Title object being displayed in search results.
2707 &$id: Revision ID (default is false, for latest)
2708
2709 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2710 perform when page content is modified. Currently called by
2711 AbstractContent::getSecondaryDataUpdates.
2712 $title: Title of the page that is being edited.
2713 $oldContent: Content object representing the page's content before the edit.
2714 $recursive: bool indicating whether DataUpdates should trigger recursive
2715 updates (relevant mostly for LinksUpdate).
2716 $parserOutput: ParserOutput representing the rendered version of the page
2717 after the edit.
2718 &$updates: a list of DataUpdate objects, to be modified or replaced by
2719 the hook handler.
2720
2721 'SecuritySensitiveOperationStatus': Affect the return value from
2722 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2723 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2724 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2725 authentication isn't possible for the current session type.
2726 $operation: (string) The operation being checked.
2727 $session: (MediaWiki\Session\Session) The current session. The
2728 currently-authenticated user may be retrieved as $session->getUser().
2729 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2730 the time of last auth is unknown, or -1 if authentication is not possible.
2731
2732 'SelfLinkBegin': Called before a link to the current article is displayed to
2733 allow the display of the link to be customized.
2734 $nt: the Title object
2735 &$html: html to display for the link
2736 &$trail: optional text to display before $html
2737 &$prefix: optional text to display after $html
2738 &$ret: the value to return if your hook returns false
2739
2740 'SendWatchlistEmailNotification': Return true to send watchlist email
2741 notification
2742 $targetUser: the user whom to send watchlist email notification
2743 $title: the page title
2744 $enotif: EmailNotification object
2745
2746 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2747 loaded from storage. Return false to prevent it from being used.
2748 &$reason: String rejection reason to be logged
2749 $info: MediaWiki\Session\SessionInfo being validated
2750 $request: WebRequest being loaded from
2751 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2752 $data: Array|false Data array for the MediaWiki\Session\Session
2753
2754 'SessionMetadata': Add metadata to a session being saved.
2755 $backend: MediaWiki\Session\SessionBackend being saved.
2756 &$metadata: Array Metadata to be stored. Add new keys here.
2757 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2758 request and 0+ FauxRequests.
2759
2760 'SetupAfterCache': Called in Setup.php, after cache objects are set
2761
2762 'ShortPagesQuery': Allow extensions to modify the query used by
2763 Special:ShortPages.
2764 &$tables: tables to join in the query
2765 &$conds: conditions for the query
2766 &$joinConds: join conditions for the query
2767 &$options: options for the query
2768
2769 'ShowMissingArticle': Called when generating the output for a non-existent page.
2770 $article: The article object corresponding to the page
2771
2772 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2773 Customise the output of raw CSS and JavaScript in page views.
2774 $text: Text being shown
2775 $title: Title of the custom script/stylesheet page
2776 $output: Current OutputPage object
2777
2778 'ShowSearchHit': Customize display of search hit.
2779 $searchPage: The SpecialSearch instance.
2780 $result: The SearchResult to show
2781 $terms: Search terms, for highlighting
2782 &$link: HTML of link to the matching page. May be modified.
2783 &$redirect: HTML of redirect info. May be modified.
2784 &$section: HTML of matching section. May be modified.
2785 &$extract: HTML of content extract. May be modified.
2786 &$score: HTML of score. May be modified.
2787 &$size: HTML of page size. May be modified.
2788 &$date: HTML of of page modification date. May be modified.
2789 &$related: HTML of additional info for the matching page. May be modified.
2790 &$html: May be set to the full HTML that should be used to represent the search
2791 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2792 function returned false.
2793
2794 'ShowSearchHitTitle': Customise display of search hit title/link.
2795 &$title: Title to link to
2796 &$text: Text to use for the link
2797 $result: The search result
2798 $terms: The search terms entered
2799 $page: The SpecialSearch object
2800 &$query: Query string to be appended to the link
2801
2802 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2803 Warning: This hook is run on each display. You should consider to use
2804 'SkinBuildSidebar' that is aggressively cached.
2805 $skin: Skin object
2806 &$bar: Sidebar content
2807 Modify $bar to add or modify sidebar portlets.
2808
2809 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2810 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2811 the sitenotice/anonnotice.
2812 $skin: Skin object
2813
2814 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2815 allow the normal method of notice selection/rendering to work, or change the
2816 value of $siteNotice and return false to alter it.
2817 &$siteNotice: HTML returned as the sitenotice
2818 $skin: Skin object
2819
2820 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2821 $skin: Skin object
2822 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2823 the stock bottom scripts.
2824
2825 'SkinAfterContent': Allows extensions to add text after the page content and
2826 article metadata. This hook should work in all skins. Set the &$data variable to
2827 the text you're going to add.
2828 &$data: (string) Text to be printed out directly (without parsing)
2829 $skin: Skin object
2830
2831 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2832 $skin: Skin object
2833 &$bar: Sidebar contents
2834 Modify $bar to add or modify sidebar portlets.
2835
2836 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2837 copyright notice.
2838 $title: displayed page title
2839 $type: 'normal' or 'history' for old/diff views
2840 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2841 message must be in HTML format, not wikitext!
2842 &$link: overridable HTML link to be passed into the message as $1
2843 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2844 content language.
2845
2846 'SkinEditSectionLinks': Modify the section edit links
2847 $skin: Skin object rendering the UI
2848 $title: Title object for the title being linked to (may not be the same as
2849 the page title, if the section is included from a template)
2850 $section: The designation of the section being pointed to, to be included in
2851 the link, like "&section=$section"
2852 $tooltip: The default tooltip. Escape before using.
2853 By default, this is wrapped in the 'editsectionhint' message.
2854 &$result: Array containing all link detail arrays. Each link detail array should
2855 contain the following keys:
2856 - targetTitle - Target Title object
2857 - text - String for the text
2858 - attribs - Array of attributes
2859 - query - Array of query parameters to add to the URL
2860 - options - Array of options for Linker::link
2861 $lang: The language code to use for the link in the wfMessage function
2862
2863 'SkinGetPoweredBy': TODO
2864 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2865 the MediaWiki icon but plain text instead.
2866 $skin: Skin object
2867
2868 'SkinPreloadExistence': Supply titles that should be added to link existence
2869 cache before the page is rendered.
2870 &$titles: Array of Title objects
2871 $skin: Skin object
2872
2873 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2874 If false is returned $subpages will be used instead of the HTML
2875 subPageSubtitle() generates.
2876 If true is returned, $subpages will be ignored and the rest of
2877 subPageSubtitle() will run.
2878 &$subpages: Subpage links HTML
2879 $skin: Skin object
2880 $out: OutputPage object
2881
2882 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2883 link" tab.
2884 &$sktemplate: SkinTemplate object
2885 &$nav_urls: array of tabs
2886 &$revid: The revision id of the permanent link
2887 &$revid2: The revision id of the permanent link, second time
2888
2889 'SkinTemplateGetLanguageLink': After building the data for a language link from
2890 which the actual html is constructed.
2891 &$languageLink: array containing data about the link. The following keys can be
2892 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2893 $languageLinkTitle: Title object belonging to the external language link.
2894 $title: Title object of the page the link belongs to.
2895 $outputPage: The OutputPage object the links are built from.
2896
2897 'SkinTemplateNavigation': Called on content pages after the tabs have been
2898 added, but before variants have been added.
2899 &$sktemplate: SkinTemplate object
2900 &$links: Structured navigation links. This is used to alter the navigation for
2901 skins which use buildNavigationUrls such as Vector.
2902
2903 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2904 tab is added but before variants have been added.
2905 &$sktemplate: SkinTemplate object
2906 &$links: Structured navigation links. This is used to alter the navigation for
2907 skins which use buildNavigationUrls such as Vector.
2908
2909 'SkinTemplateNavigation::Universal': Called on both content and special pages
2910 after variants have been added.
2911 &$sktemplate: SkinTemplate object
2912 &$links: Structured navigation links. This is used to alter the navigation for
2913 skins which use buildNavigationUrls such as Vector.
2914
2915 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2916 page output.
2917 &$sktemplate: SkinTemplate object
2918 &$tpl: QuickTemplate engine object
2919
2920 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2921 &$sktemplate: SkinTemplate object
2922 &$res: set to true to prevent active tabs
2923
2924 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2925 You can either create your own array, or alter the parameters for
2926 the normal one.
2927 &$sktemplate: The SkinTemplate instance.
2928 $title: Title instance for the page.
2929 $message: Visible label of tab.
2930 $selected: Whether this is a selected tab.
2931 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2932 &$classes: Array of CSS classes to apply.
2933 &$query: Query string to add to link.
2934 &$text: Link text.
2935 &$result: Complete assoc. array if you want to return true.
2936
2937 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2938 been rendered (useful for adding more).
2939 &$sk: The QuickTemplate based skin template running the hook.
2940 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2941 extensions that add support for BaseTemplateToolbox should watch for this
2942 dummy parameter with "$dummy=false" in their code and return without echoing
2943 any HTML to avoid creating duplicate toolbox items.
2944
2945 'SoftwareInfo': Called by Special:Version for returning information about the
2946 software.
2947 &$software: The array of software in format 'name' => 'version'. See
2948 SpecialVersion::softwareInformation().
2949
2950 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2951 $sp: SpecialPage object, for context
2952 &$fields: Current HTMLForm fields
2953
2954 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2955 $id: User id number, only provided for backwards-compatibility
2956 $user: User object representing user contributions are being fetched for
2957 $sp: SpecialPage instance, providing context
2958
2959 'SpecialContributions::formatRow::flags': Called before rendering a
2960 Special:Contributions row.
2961 $context: IContextSource object
2962 $row: Revision information from the database
2963 &$flags: List of flags on this row
2964
2965 'SpecialContributions::getForm::filters': Called with a list of filters to render
2966 on Special:Contributions.
2967 $sp: SpecialContributions object, for context
2968 &$filters: List of filters rendered as HTML
2969
2970 'SpecialListusersDefaultQuery': Called right before the end of
2971 UsersPager::getDefaultQuery().
2972 $pager: The UsersPager instance
2973 &$query: The query array to be returned
2974
2975 'SpecialListusersFormatRow': Called right before the end of
2976 UsersPager::formatRow().
2977 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2978 $row: Database row object
2979
2980 'SpecialListusersHeader': Called before closing the <fieldset> in
2981 UsersPager::getPageHeader().
2982 $pager: The UsersPager instance
2983 &$out: The header HTML
2984
2985 'SpecialListusersHeaderForm': Called before adding the submit button in
2986 UsersPager::getPageHeader().
2987 $pager: The UsersPager instance
2988 &$out: The header HTML
2989
2990 'SpecialListusersQueryInfo': Called right before the end of.
2991 UsersPager::getQueryInfo()
2992 $pager: The UsersPager instance
2993 &$query: The query array to be returned
2994
2995 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2996 $type: String of the log type
2997 $request: WebRequest object for getting the value provided by the current user
2998 &$qc: Array for query conditions to add
2999
3000 'SpecialMovepageAfterMove': Called after moving a page.
3001 &$movePage: MovePageForm object
3002 &$oldTitle: old title (object)
3003 &$newTitle: new title (object)
3004
3005 'SpecialNewpagesConditions': Called when building sql query for
3006 Special:NewPages.
3007 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
3008 $opts: FormOptions object containing special page options
3009 &$conds: array of WHERE conditionals for query
3010 &$tables: array of tables to be queried
3011 &$fields: array of columns to select
3012 &$join_conds: join conditions for the tables
3013
3014 'SpecialNewPagesFilters': Called after building form options at NewPages.
3015 $special: the special page object
3016 &$filters: associative array of filter definitions. The keys are the HTML
3017 name/URL parameters. Each key maps to an associative array with a 'msg'
3018 (message key) and a 'default' value.
3019
3020 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
3021 this hook to remove a core special page or conditionally register special pages.
3022 &$list: list (array) of core special pages
3023
3024 'SpecialPageAfterExecute': Called after SpecialPage::execute.
3025 $special: the SpecialPage object
3026 $subPage: the subpage string or null if no subpage was specified
3027
3028 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
3029 Return false to prevent execution.
3030 $special: the SpecialPage object
3031 $subPage: the subpage string or null if no subpage was specified
3032
3033 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
3034 $name: name of the special page
3035 &$form: HTMLForm object
3036
3037 'SpecialPasswordResetOnSubmit': When executing a form submission on
3038 Special:PasswordReset.
3039 &$users: array of User objects.
3040 $data: array of data submitted by the user
3041 &$error: string, error code (message key) used to describe to error (out
3042 parameter). The hook needs to return false when setting this, otherwise it
3043 will have no effect.
3044
3045 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
3046 use this to change some selection criteria or substitute a different title.
3047 &$randstr: The random number from wfRandom()
3048 &$isRedir: Boolean, whether to select a redirect or non-redirect
3049 &$namespaces: An array of namespace indexes to get the title from
3050 &$extra: An array of extra SQL statements
3051 &$title: If the hook returns false, a Title object to use instead of the
3052 result from the normal query
3053
3054 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3055 instead.
3056 Called after building form options at RecentChanges.
3057 $special: the special page object
3058 &$filters: associative array of filter definitions. The keys are the HTML
3059 name/URL parameters. Each key maps to an associative array with a 'msg'
3060 (message key) and a 'default' value.
3061
3062 'SpecialRecentChangesPanel': Called when building form options in
3063 SpecialRecentChanges.
3064 &$extraOpts: array of added items, to which can be added
3065 $opts: FormOptions for this request
3066
3067 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
3068 instead.
3069 Called when building SQL query for SpecialRecentChanges and
3070 SpecialRecentChangesLinked.
3071 &$conds: array of WHERE conditionals for query
3072 &$tables: array of tables to be queried
3073 &$join_conds: join conditions for the tables
3074 $opts: FormOptions for this request
3075 &$query_options: array of options for the database request
3076 &$select: Array of columns to select
3077
3078 'SpecialResetTokensTokens': Called when building token list for
3079 SpecialResetTokens.
3080 &$tokens: array of token information arrays in the format of
3081 array(
3082 'preference' => '<preference-name>',
3083 'label-message' => '<message-key>',
3084 )
3085
3086 'SpecialSearchCreateLink': Called when making the message to create a page or
3087 go to the existing page.
3088 $t: title object searched for
3089 &$params: an array of the default message name and page title (as parameter)
3090
3091 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3092 canceled and a normal search will be performed. Returning true without setting
3093 $url does a standard redirect to $title. Setting $url redirects to the
3094 specified URL.
3095 $term: The string the user searched for
3096 $title: The title the 'go' feature has decided to forward the user to
3097 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3098
3099 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3100 target doesn't exist.
3101 &$title: title object generated from the text entered by the user
3102
3103 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3104 the advanced form, a.k.a. power search box.
3105 &$showSections: an array to add values with more options to
3106 $term: the search term (not a title object)
3107 $opts: an array of hidden options (containing 'redirs' and 'profile')
3108
3109 'SpecialSearchProfileForm': Allows modification of search profile forms.
3110 $search: special page object
3111 &$form: String: form html
3112 $profile: String: current search profile
3113 $term: String: search term
3114 $opts: Array: key => value of hidden options for inclusion in custom forms
3115
3116 'SpecialSearchProfiles': Allows modification of search profiles.
3117 &$profiles: profiles, which can be modified.
3118
3119 'SpecialSearchResults': Called before search result display
3120 $term: string of search term
3121 &$titleMatches: empty or SearchResultSet object
3122 &$textMatches: empty or SearchResultSet object
3123
3124 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3125 on the search results page. Useful for including an external search
3126 provider. To disable the output of MediaWiki search output, return
3127 false.
3128 $specialSearch: SpecialSearch object ($this)
3129 $output: $wgOut
3130 $term: Search term specified by the user
3131
3132 'SpecialSearchResultsAppend': Called immediately before returning HTML
3133 on the search results page. Useful for including a feedback link.
3134 $specialSearch: SpecialSearch object ($this)
3135 $output: $wgOut
3136 $term: Search term specified by the user
3137
3138 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3139 $search: SpecialSearch special page object
3140 $profile: String: current search profile
3141 $engine: the search engine
3142
3143 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3144 &$extraStats: Array to save the new stats
3145 $extraStats['<name of statistic>'] => <value>;
3146 <value> can be an array with the keys "name" and "number":
3147 "name" is the HTML to be displayed in the name column
3148 "number" is the number to be displayed.
3149 or, <value> can be the number to be displayed and <name> is the
3150 message key to use in the name column,
3151 $context: IContextSource object
3152
3153 'SpecialUploadComplete': Called after successfully uploading a file from
3154 Special:Upload.
3155 &$form: The SpecialUpload object
3156
3157 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3158 $wgVersion: Current $wgVersion for you to use
3159 &$versionUrl: Raw url to link to (eg: release notes)
3160
3161 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3162 instead.
3163 Called after building form options at Watchlist.
3164 $special: the special page object
3165 &$filters: associative array of filter definitions. The keys are the HTML
3166 name/URL parameters. Each key maps to an associative array with a 'msg'
3167 (message key) and a 'default' value.
3168
3169 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3170 SpecialWatchlist. Allows extensions to register custom values they have
3171 inserted to rc_type so they can be returned as part of the watchlist.
3172 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3173
3174 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3175 Called when building sql query for SpecialWatchlist.
3176 &$conds: array of WHERE conditionals for query
3177 &$tables: array of tables to be queried
3178 &$join_conds: join conditions for the tables
3179 &$fields: array of query fields
3180 $opts: A FormOptions object with watchlist options for the current request
3181
3182 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3183 URL for a title when we have no other parameters on the URL. Gives a chance for
3184 extensions that alter page view behavior radically to abort that redirect or
3185 handle it manually.
3186 $request: WebRequest
3187 $title: Title of the currently found title obj
3188 $output: OutputPage object
3189
3190 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3191 rendered (by ThumbnailImage:toHtml method).
3192 $thumbnail: the ThumbnailImage object
3193 &$attribs: image attribute array
3194 &$linkAttribs: image link attribute array
3195
3196 'TitleArrayFromResult': Called when creating an TitleArray object from a
3197 database result.
3198 &$titleArray: set this to an object to override the default object returned
3199 $res: database result used to create the object
3200
3201 'TitleExists': Called when determining whether a page exists at a given title.
3202 $title: The title being tested.
3203 &$exists: Whether the title exists.
3204
3205 'TitleGetEditNotices': Allows extensions to add edit notices
3206 $title: The Title object for the page the edit notices are for
3207 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3208 &$notices: Array of notices. Keys are i18n message keys, values are
3209 parseAsBlock()ed messages.
3210
3211 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3212 that can be applied.
3213 $title: The title in question.
3214 &$types: The types of protection available.
3215
3216 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3217 overriding default behavior for determining if a page exists. If $isKnown is
3218 kept as null, regular checks happen. If it's a boolean, this value is returned
3219 by the isKnown method.
3220 $title: Title object that is being checked
3221 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3222
3223 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3224 Called when determining if a page is a CSS or JS page.
3225 $title: Title object that is being checked
3226 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3227 Hooks may change this value to override the return value of
3228 Title::isCssOrJsPage().
3229
3230 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3231 that this hook is not called for interwiki pages or pages in immovable
3232 namespaces: for these, isMovable() always returns false.
3233 $title: Title object that is being checked
3234 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3235 Hooks may change this value to override the return value of
3236 Title::isMovable().
3237
3238 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3239 Called when determining if a page is a wikitext or should
3240 be handled by separate handler (via ArticleViewCustom).
3241 $title: Title object that is being checked
3242 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3243 Hooks may change this value to override the return value of
3244 Title::isWikitextPage()
3245
3246 'TitleMove': Before moving an article (title).
3247 $old: old title
3248 $nt: new title
3249 $user: user who does the move
3250
3251 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3252 $old: old title
3253 $nt: new title
3254 $user: user who does the move
3255
3256 'TitleMoveComplete': After moving an article (title), post-commit.
3257 &$old: old title
3258 &$nt: new title
3259 &$user: user who did the move
3260 $pageid: database ID of the page that's been moved
3261 $redirid: database ID of the created redirect
3262 $reason: reason for the move
3263 $revision: the Revision created by the move
3264
3265 'TitleMoveCompleting': After moving an article (title), pre-commit.
3266 $old: old title
3267 $nt: new title
3268 $user: user who did the move
3269 $pageid: database ID of the page that's been moved
3270 $redirid: database ID of the created redirect
3271 $reason: reason for the move
3272 $revision: the Revision created by the move
3273
3274 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3275 or override the quick permissions check.
3276 $title: The Title object being accessed
3277 $user: The User performing the action
3278 $action: Action being performed
3279 &$errors: Array of errors
3280 $doExpensiveQueries: Whether to do expensive DB queries
3281 $short: Whether to return immediately on first error
3282
3283 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3284 adding the default error message if nothing allows the user to read the page. If
3285 a handler wants a title to *not* be whitelisted, it should also return false.
3286 $title: Title object being checked against
3287 $user: Current user object
3288 &$whitelisted: Boolean value of whether this title is whitelisted
3289
3290 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3291 $title: Title object to purge
3292 &$urls: An array of URLs to purge from the caches, to be manipulated.
3293
3294 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3295 PageArchive object has been created but before any further processing is done.
3296 &$archive: PageArchive object
3297 $title: Title object of the page that we're viewing
3298
3299 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3300 PageArchive object has been created but before any further processing is done.
3301 &$archive: PageArchive object
3302 $title: Title object of the page that we're viewing
3303
3304 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3305 the site is not in read-only mode, that the Title object is not null and after
3306 a PageArchive object has been constructed but before performing any further
3307 processing.
3308 &$archive: PageArchive object
3309 $title: Title object of the page that we're about to undelete
3310
3311 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3312 $title: title object related to the revision
3313 $rev: revision (object) that will be viewed
3314
3315 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3316 Since 1.24: Paths pointing to a directory will be recursively scanned for
3317 test case files matching the suffix "Test.php".
3318 &$paths: list of test cases and directories to search.
3319
3320 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3321 actions).
3322 $action: action name
3323 $article: article "acted on"
3324
3325 'UnwatchArticle': Before a watch is removed from an article.
3326 &$user: user watching
3327 &$page: WikiPage object to be removed
3328 &$status: Status object to be returned if the hook returns false
3329
3330 'UnwatchArticleComplete': After a watch is removed from an article.
3331 $user: user that watched
3332 &$page: WikiPage object that was watched
3333
3334 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3335 &$formattedPageStatus: list of valid page states
3336
3337 'UploadComplete': Upon completion of a file upload.
3338 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3339 $uploadBase->getLocalFile().
3340
3341 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3342 $type: (string) the requested upload type
3343 &$className: the class name of the Upload instance to be created
3344
3345 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3346 poke at member variables like $mUploadDescription before the file is saved. Do
3347 not use this hook to break upload processing. This will return the user to a
3348 blank form with no error message; use UploadVerification and UploadVerifyFile
3349 instead.
3350 &$form: UploadForm object
3351
3352 'UploadForm:initial': Before the upload form is generated. You might set the
3353 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3354 text (HTML) either before or after the editform.
3355 &$form: UploadForm object
3356
3357 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3358 assembled.
3359 &$descriptor: (array) the HTMLForm descriptor
3360
3361 'UploadFormSourceDescriptors': after the standard source inputs have been
3362 added to the descriptor
3363 &$descriptor: (array) the HTMLForm descriptor
3364 &$radio: Boolean, if source type should be shown as radio button
3365 $selectedSourceType: The selected source type
3366
3367 'UploadVerification': DEPRECATED! Use UploadVerifyFile instead.
3368 Additional chances to reject an uploaded file.
3369 $saveName: (string) destination file name
3370 $tempName: (string) filesystem path to the temporary file for checks
3371 &$error: (string) output: message key for message to show if upload canceled by
3372 returning false. May also be an array, where the first element is the message
3373 key and the remaining elements are used as parameters to the message.
3374
3375 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3376 in most cases over UploadVerification.
3377 $upload: (object) an instance of UploadBase, with all info about the upload
3378 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3379 Handlers will typically only apply for specific MIME types.
3380 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3381 representing the problem with the file, where the first element is the message
3382 key and the remaining elements are used as parameters to the message.
3383
3384 'UserIsBot': when determining whether a user is a bot account
3385 $user: the user
3386 &$isBot: whether this is user a bot or not (boolean)
3387
3388 'User::mailPasswordInternal': before creation and mailing of a user's new
3389 temporary password
3390 &$user: the user who sent the message out
3391 &$ip: IP of the user who sent the message out
3392 &$u: the account whose new password will be set
3393
3394 'UserAddGroup': Called when adding a group; return false to override
3395 stock group addition.
3396 $user: the user object that is to have a group added
3397 &$group: the group to add, can be modified
3398
3399 'UserArrayFromResult': Called when creating an UserArray object from a database
3400 result.
3401 &$userArray: set this to an object to override the default object returned
3402 $res: database result used to create the object
3403
3404 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3405 want to display an error message, try getUserPermissionsErrors.
3406 &$title: Title object being checked against
3407 &$user: Current user object
3408 $action: Action being checked
3409 &$result: Pointer to result returned if hook returns false. If null is returned,
3410 userCan checks are continued by internal code.
3411
3412 'UserCanSendEmail': To override User::canSendEmail() permission check.
3413 &$user: User (object) whose permission is being checked
3414 &$canSend: bool set on input, can override on output
3415
3416 'UserClearNewTalkNotification': Called when clearing the "You have new
3417 messages!" message, return false to not delete it.
3418 &$user: User (object) that will clear the message
3419 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3420
3421 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3422 Manipulate the login form.
3423 &$template: SimpleTemplate instance for the form
3424
3425 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3426 &$user: User to get groups for
3427 &$groups: Current effective groups
3428
3429 'UserGetAllRights': After calculating a list of all available rights.
3430 &$rights: Array of rights, which may be added to.
3431
3432 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3433 before returning the options to the caller. Warning: This hook is called for
3434 every call to User::getDefaultOptions(), which means it's potentially called
3435 dozens or hundreds of times. You may want to cache the results of non-trivial
3436 operations in your hook function for this reason.
3437 &$defaultOptions: Array of preference keys and their default values.
3438
3439 'UserGetEmail': Called when getting an user email address.
3440 $user: User object
3441 &$email: email, change this to override local email
3442
3443 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3444 email authentication.
3445 $user: User object
3446 &$timestamp: timestamp, change this to override local email authentication
3447 timestamp
3448
3449 'UserGetImplicitGroups': DEPRECATED!
3450 Called in User::getImplicitGroups().
3451 &$groups: List of implicit (automatically-assigned) groups
3452
3453 'UserGetLanguageObject': Called when getting user's interface language object.
3454 $user: User object
3455 &$code: Language code that will be used to create the object
3456 $context: IContextSource object
3457
3458 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3459 &$reservedUsernames: $wgReservedUsernames
3460
3461 'UserGetRights': Called in User::getRights().
3462 $user: User to get rights for
3463 &$rights: Current rights
3464
3465 'UserGroupsChanged': Called after user groups are changed.
3466 $user: User whose groups changed
3467 $added: Groups added
3468 $removed: Groups removed
3469 $performer: User who performed the change, false if via autopromotion
3470 $reason: The reason, if any, given by the user performing the change,
3471 false if via autopromotion.
3472
3473 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3474 specific block exemptions).
3475 $user: User in question
3476 $title: Title of the page in question
3477 &$blocked: Out-param, whether or not the user is blocked from that page.
3478 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3479 to edit their own user talk pages.
3480
3481 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3482 &$user: User object
3483 $ip: User's IP address
3484 &$blocked: Whether the user is blocked, to be modified by the hook
3485 &$block: The Block object, to be modified by the hook
3486
3487 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3488 false if a UserGetRights hook might remove the named right.
3489 $right: The user right being checked
3490
3491 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3492 $user: User in question.
3493 &$hidden: Set true if the user's name should be hidden.
3494
3495 'UserIsLocked': Check if the user is locked. See User::isLocked().
3496 $user: User in question.
3497 &$locked: Set true if the user should be locked.
3498
3499 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3500 environmental means; occurs after session is loaded.
3501 $user: user object being loaded
3502
3503 'UserLoadDefaults': Called when loading a default user.
3504 $user: user object
3505 $name: user name
3506
3507 'UserLoadFromDatabase': Called when loading a user from the database.
3508 $user: user object
3509 &$s: database query object
3510
3511 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3512 Called to authenticate users on external/environmental means; occurs before
3513 session is loaded.
3514 $user: user object being loaded
3515 &$result: set this to a boolean value to abort the normal authentication
3516 process
3517
3518 'UserLoadOptions': When user options/preferences are being loaded from the
3519 database.
3520 $user: User object
3521 &$options: Options, can be modified.
3522
3523 'UserLoggedIn': Called after a user is logged in
3524 $user: User object for the logged-in user
3525
3526 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3527 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3528 &$user: the user object that was created on login
3529 &$inject_html: Any HTML to inject after the "logged in" message.
3530
3531 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3532 Manipulate the login form.
3533 &$template: QuickTemplate instance for the form
3534
3535 'UserLogout': Before a user logs out.
3536 &$user: the user object that is about to be logged out
3537
3538 'UserLogoutComplete': After a user has logged out.
3539 &$user: the user object _after_ logout (won't have name, ID, etc.)
3540 &$inject_html: Any HTML to inject after the "logged out" message.
3541 $oldName: name of the user before logout (string)
3542
3543 'UserMailerChangeReturnPath': Called to generate a VERP return address
3544 when UserMailer sends an email, with a bounce handling extension.
3545 $to: Array of MailAddress objects for the recipients
3546 &$returnPath: The return address string
3547
3548 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3549 to split up an email with multiple the To: field into separate emails.
3550 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3551
3552 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3553 Extensions can block sending the email by returning false and setting $error.
3554 $to: array of MailAdresses of the targets
3555 $from: MailAddress of the sender
3556 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3557 &$error: should be set to an error message string
3558
3559 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3560 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3561 $to: array of MailAdresses of the targets
3562 $from: MailAddress of the sender
3563 &$subject: email subject (not MIME encoded)
3564 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3565 &$body: email body (in MIME format) as a string
3566 &$error: should be set to an error message string
3567
3568 'UserRemoveGroup': Called when removing a group; return false to override stock
3569 group removal.
3570 $user: the user object that is to have a group removed
3571 &$group: the group to be removed, can be modified
3572
3573 'UserRequiresHTTPS': Called to determine whether a user needs
3574 to be switched to HTTPS.
3575 $user: User in question.
3576 &$https: Boolean whether $user should be switched to HTTPS.
3577
3578 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3579 have been requested to be reset. This hook can be used to exclude certain
3580 options from being reset even when the user has requested all prefs to be reset,
3581 because certain options might be stored in the user_properties database table
3582 despite not being visible and editable via Special:Preferences.
3583 $user: the User (object) whose preferences are being reset
3584 &$newOptions: array of new (site default) preferences
3585 $options: array of the user's old preferences
3586 $resetKinds: array containing the kinds of preferences to reset
3587
3588 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3589 message(s).
3590 &$user: user retrieving new talks messages
3591 &$talks: array of new talks page(s)
3592
3593 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3594 After a user's group memberships are changed.
3595 &$user: User object that was changed
3596 $add: Array of strings corresponding to groups added
3597 $remove: Array of strings corresponding to groups removed
3598
3599 'UserSaveOptions': Called just before saving user preferences/options.
3600 $user: User object
3601 &$options: Options, modifiable
3602
3603 'UserSaveSettings': Called when saving user settings.
3604 $user: User object
3605
3606 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3607 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3608 instead. Otherwise, you can no longer count on user data being saved to cookies
3609 versus some other mechanism.
3610 Called when setting user cookies.
3611 $user: User object
3612 &$session: session array, will be added to the session
3613 &$cookies: cookies array mapping cookie name to its value
3614
3615 'UserSetEmail': Called when changing user email address.
3616 $user: User object
3617 &$email: new email, change this to override new email address
3618
3619 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3620 email authentication.
3621 $user: User object
3622 &$timestamp: new timestamp, change this to override local email
3623 authentication timestamp
3624
3625 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3626 "Foobar (Talk | Contribs | Block)".
3627 $userId: User id of the current user
3628 $userText: User name of the current user
3629 &$items: Array of user tool links as HTML fragments
3630
3631 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3632 FormatMetadata::getExtendedMeta (return false means cache will be
3633 invalidated and GetExtendedMetadata hook called again).
3634 $timestamp: The timestamp metadata was generated
3635 $file: The file the metadata is for
3636
3637 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3638 used to alter the SQL query which gets the list of wanted pages.
3639 &$wantedPages: WantedPagesPage object
3640 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3641
3642 'WatchArticle': Before a watch is added to an article.
3643 &$user: user that will watch
3644 &$page: WikiPage object to be watched
3645 &$status: Status object to be returned if the hook returns false
3646
3647 'WatchArticleComplete': After a watch is added to an article.
3648 &$user: user that watched
3649 &$page: WikiPage object watched
3650
3651 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3652 form, used to manipulate the list of pages or preload data based on that list.
3653 &$watchlistInfo: array of watchlisted pages in
3654 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3655
3656 'WatchlistEditorBuildRemoveLine': when building remove lines in
3657 Special:Watchlist/edit.
3658 &$tools: array of extra links
3659 $title: Title object
3660 $redirect: whether the page is a redirect
3661 $skin: Skin object
3662 &$link: HTML link to title
3663
3664 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3665 REQUEST_URI.
3666 $router: The PathRouter instance
3667
3668 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3669 Return false to prevent setting of the cookie.
3670 &$name: Cookie name passed to WebResponse::setcookie()
3671 &$value: Cookie value passed to WebResponse::setcookie()
3672 &$expire: Cookie expiration, as for PHP's setcookie()
3673 &$options: Options passed to WebResponse::setcookie()
3674
3675 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3676 run a MediaWiki cli script.
3677 &$script: MediaWiki cli script path
3678 &$parameters: Array of arguments and options to the script
3679 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3680 keys
3681
3682 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3683 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3684 &$qp: The list of QueryPages
3685
3686 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3687 $row: The DB row of the entry.
3688 $title: The Title of the page where the link comes FROM
3689 $target: The Title of the page where the link goes TO
3690 &$props: Array of HTML strings to display after the title.
3691
3692 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3693 dumps. One, and only one hook should set this, and return false.
3694 &$tables: Database tables to use in the SELECT query
3695 &$opts: Options to use for the query
3696 &$join: Join conditions
3697
3698 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3699 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3700 specific to a content model should be provided by the respective Content's
3701 getDeletionUpdates() method.
3702 $page: the WikiPage
3703 $content: the Content to generate updates for
3704 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3705
3706 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3707 extra metadata to be added.
3708 $obj: The XmlDumpWriter object.
3709 &$out: The output string.
3710 $row: The database row for the page.
3711 $title: The title of the page.
3712
3713 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3714 add extra metadata.
3715 &$obj: The XmlDumpWriter object.
3716 &$out: The text being output.
3717 $row: The database row for the revision.
3718 $text: The revision text.
3719
3720 More hooks might be available but undocumented, you can execute
3721 "php maintenance/findHooks.php" to find hidden ones.