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