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