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