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