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