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