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