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