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