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