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.
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'.
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.
21 The function part of a hook.
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 );
44 if ( $wgCapitalizeTitle ) {
45 wfCapitalizeTitle( $article );
48 # code to actually show the article goes here
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 );
62 if ( $wgCapitalizeTitle ) {
63 wfCapitalizeTitle( $article );
66 # code to actually show the article goes here
68 if ( $wgNotifyArticle ) {
69 wfNotifyArticleShow( $article );
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 ) );
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
96 function reverseArticleTitle( $article ) {
100 function reverseForExport( $article ) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
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
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.
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:
155 someFunction( $param1, $param2 )
157 someFunction( $someData, $param1, $param2 )
160 $object->onEventName( $param1, $param2 )
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
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 ) {
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.
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
215 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216 # protect the article
217 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
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
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
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 'AbortChangePassword': Return false to cancel password change.
253 $user: the User object to which the password change is occuring
254 $mOldpass: the old password provided by the user
255 $newpass: the new password provided by the user
256 &$abortMsg: the message identifier for abort reason
258 'AbortDiffCache': Can be used to cancel the caching of a diff.
259 &$diffEngine: DifferenceEngine object
261 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
262 $editor: The User who made the change.
263 $title: The Title of the page that was edited.
264 $rc: The current RecentChange object.
266 'AbortLogin': DEPRECATED! Create a PreAuthenticationProvider instead.
267 Return false to cancel account login.
268 $user: the User object being authenticated against
269 $password: the password being submitted, not yet checked for validity
270 &$retval: a LoginForm class constant to return from authenticateUserData();
271 default is LoginForm::ABORTED. Note that the client may be using a machine
272 API rather than the HTML user interface.
273 &$msg: the message identifier for abort reason (new in 1.18, not available
276 'AbortNewAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
277 Return false to cancel explicit account creation.
278 $user: the User object about to be created (read-only, incomplete)
279 &$msg: out parameter: HTML to display on abort
280 &$status: out parameter: Status object to return, replaces the older $msg param
282 Create the object with Status::newFatal() to ensure proper API error
283 messages are returned when creating account through API clients.
285 'AbortTalkPageEmailNotification': Return false to cancel talk page email
287 $targetUser: the user whom to send talk page email notification
288 $title: the page title
290 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
291 $name: name of the action
292 &$form: HTMLForm object
293 $article: Article object
295 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
296 Allows to change the fields on the form that will be generated.
297 $name: name of the action
298 &$fields: HTMLForm descriptor array
299 $article: Article object
301 'AddNewAccount': After a user account is created.
302 $user: the User object that was created. (Parameter added in 1.7)
303 $byEmail: true when account was created "by email" (added in 1.12)
305 'AddNewAccountApiForm': Allow modifying internal login form when creating an
307 $apiModule: the ApiCreateAccount module calling
308 $loginForm: the LoginForm used
310 'AddNewAccountApiResult': Modify API output when creating a new account via API.
311 $apiModule: the ApiCreateAccount module calling
312 $loginForm: the LoginForm used
313 &$result: associative array for API result data
315 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
316 are created. Can be used to omit specific feeds from being outputted. You must not use
317 this hook to add feeds, use OutputPage::addFeedLink() instead.
318 &$feedLinks: Array of created feed links
320 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
321 before OutputPage::sendCacheControl() and final ob_end_flush() which
322 will send the buffered output to the client. This allows for last-minute
323 modification of the output within the buffer by using ob_get_clean().
324 $output: The OutputPage object where output() was called
326 'AfterImportPage': When a page import is completed.
327 $title: Title under which the revisions were imported
328 $foreignTitle: ForeignTitle object based on data provided by the XML file
329 $revCount: Number of revisions in the XML file
330 $sRevCount: Number of successfully imported revisions
331 $pageInfo: associative array of page information
333 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
334 just before adding its HTML to parser output.
335 $parser: Parser object that called the hook
336 $ig: Gallery, an object of one of the gallery classes (inheriting from
338 &$html: HTML generated by the gallery
340 'AlternateEdit': Before checking if a user can edit a page and before showing
341 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
342 $editPage: the EditPage object
344 'AlternateEditPreview': Before generating the preview of the page when editing
345 ( EditPage::getPreviewText() ).
346 Return false and set $previewHTML and $parserOutput to output custom page
348 $editPage: the EditPage object
349 &$content: the Content object for the text field from the edit page
350 &$previewHTML: Text to be placed into the page for the preview
351 &$parserOutput: the ParserOutput object for the preview
353 'AlternateUserMailer': Called before mail is sent so that mail could be logged
354 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
355 the regular method of sending mail. Return a string to return a php-mail-error
356 message containing the error. Returning true will continue with sending email
358 $headers: Associative array of headers for the email
359 $to: MailAddress object or array
361 $subject: Subject of the email
362 $body: Body of the message
364 'APIAfterExecute': After calling the execute() method of an API module. Use
365 this to extend core API modules.
366 &$module: Module object
368 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
369 &$main: ApiMain object
371 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
372 authenticate and authorize API clients before executing the module. Return
373 false and set a message to cancel the request.
374 $module: Module object
376 &$message: API usage message to die with, as a message key or array
377 as accepted by ApiBase::dieUsageMsg.
379 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
380 processing request parameters. Return false to let the request fail, returning
381 an error message or an <edit result="Failure"> tag if $resultArr was filled.
382 Unlike for example 'EditFilterMergedContent' this also being run on undo.
383 $editPage: the EditPage object
384 $text: the new text of the article (has yet to be saved)
385 &$resultArr: data in this array will be added to the API result
387 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
388 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
389 this hook may cancel the hook to signal that the item is not viewable in the
391 $row: A row of data from ContribsPager. The set of data returned by
392 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
394 $context: An IContextSource implementation.
395 &$feedItem: Set this to a FeedItem instance if the callback can handle the
396 provided row. This is provided to the hook as a null, if it is non null then
397 another callback has already handled the hook.
399 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
400 highlighting, add output to $context->getOutput() and return false.
401 $context: An IContextSource.
402 $text: Text to be highlighted.
403 $mime: MIME type of $text.
404 $format: API format code for $text.
406 'APIGetAllowedParams': Use this hook to modify a module's parameters.
407 &$module: ApiBase Module object
408 &$params: Array of parameters
409 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
411 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
412 Use this hook to modify a module's description.
413 &$module: ApiBase Module object
414 &$desc: String description, or array of description strings
416 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
417 $module: ApiBase Module object
418 &$msg: Array of Message objects
420 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
422 Use this hook to modify a module's parameter descriptions.
423 &$module: ApiBase Module object
424 &$desc: Array of parameter descriptions
426 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
428 $module: ApiBase Module object
429 &$msg: Array of arrays of Message objects
431 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
432 $module: ApiBase Module object
433 &$help: Array of HTML strings to be joined for the output.
434 $options: Array Options passed to ApiHelp::getHelp
435 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
436 the page and values as for Linker::generateTOC().
438 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
439 module manager. Can be used to conditionally register API modules.
440 $moduleManager: ApiModuleManager Module manager instance
442 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
443 an exception is thrown during API action execution.
444 $apiMain: Calling ApiMain instance.
445 $e: Exception object.
447 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
448 can alter or append to the array.
449 &$results: array with integer keys to associative arrays. Keys in associative
451 - title: Title object.
452 - redirect from: Title or null.
453 - extract: Description for this result.
454 - extract trimmed: If truthy, the extract will not be trimmed to
455 $wgOpenSearchDescriptionLength.
456 - image: Thumbnail for this result. Value is an array with subkeys 'source'
457 (url), 'width', 'height', 'alt', 'align'.
458 - url: Url for the given title.
460 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
461 module manager. Can be used to conditionally register API query modules.
462 $moduleManager: ApiModuleManager Module manager instance
464 'APIQueryAfterExecute': After calling the execute() method of an
465 action=query submodule. Use this to extend core API modules.
466 &$module: Module object
468 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
469 an action=query submodule. Use this to extend core API modules.
470 &$module: Module object
471 &$resultPageSet: ApiPageSet object
473 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
474 Use this hook to add custom tokens to prop=info. Every token has an action,
475 which will be used in the intoken parameter and in the output
476 (actiontoken="..."), and a callback function which should return the token, or
477 false if the user isn't allowed to obtain it. The prototype of the callback
478 function is func($pageid, $title), where $pageid is the page ID of the page the
479 token is requested for and $title is the associated Title object. In the hook,
480 just add your callback to the $tokenFunctions array and return true (returning
481 false makes no sense).
482 &$tokenFunctions: array(action => callback)
484 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
486 Use this hook to add custom tokens to list=recentchanges. Every token has an
487 action, which will be used in the rctoken parameter and in the output
488 (actiontoken="..."), and a callback function which should return the token, or
489 false if the user isn't allowed to obtain it. The prototype of the callback
490 function is func($pageid, $title, $rc), where $pageid is the page ID of the
491 page associated to the revision the token is requested for, $title the
492 associated Title object and $rc the associated RecentChange object. In the
493 hook, just add your callback to the $tokenFunctions array and return true
494 (returning false makes no sense).
495 &$tokenFunctions: array(action => callback)
497 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
498 Use this hook to add custom tokens to prop=revisions. Every token has an
499 action, which will be used in the rvtoken parameter and in the output
500 (actiontoken="..."), and a callback function which should return the token, or
501 false if the user isn't allowed to obtain it. The prototype of the callback
502 function is func($pageid, $title, $rev), where $pageid is the page ID of the
503 page associated to the revision the token is requested for, $title the
504 associated Title object and $rev the associated Revision object. In the hook,
505 just add your callback to the $tokenFunctions array and return true (returning
506 false makes no sense).
507 &$tokenFunctions: array(action => callback)
509 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
510 sites general information.
511 $module: the current ApiQuerySiteInfo module
512 &$results: array of results, add things here
514 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
515 sites statistics information.
516 &$results: array of results, add things here
518 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
519 action=query&meta=tokens. Note that most modules will probably be able to use
520 the 'csrf' token instead of creating their own token types.
521 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
522 and key to pass to Session::getToken() )
524 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
525 Use this hook to add custom token to list=users. Every token has an action,
526 which will be used in the ustoken parameter and in the output
527 (actiontoken="..."), and a callback function which should return the token, or
528 false if the user isn't allowed to obtain it. The prototype of the callback
529 function is func($user) where $user is the User object. In the hook, just add
530 your callback to the $tokenFunctions array and return true (returning false
532 &$tokenFunctions: array(action => callback)
534 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
535 should have its own entry in the $apis array and have a unique name, passed as
536 key for the array that represents the service data. In this data array, the
537 key-value-pair identified by the apiLink key is required.
538 &$apis: array of services
540 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
541 Use this hook to extend action=tokens with new token types.
542 &$tokenTypes: supported token types in format 'type' => callback function
543 used to retrieve this type of tokens.
545 'Article::MissingArticleConditions': Before fetching deletion & move log entries
546 to display a message of a non-existing page being deleted/moved, give extensions
547 a chance to hide their (unrelated) log entries.
548 &$conds: Array of query conditions (all of which have to be met; conditions will
549 AND in the final query)
550 $logTypes: Array of log types being queried
552 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
554 After fetching content of an article from the database.
555 &$article: the article (object) being loaded from the database
556 &$content: the content (string) of the article
558 'ArticleAfterFetchContentObject': After fetching content of an article from the
560 &$article: the article (object) being loaded from the database
561 &$content: the content of the article, as a Content object
563 'ArticleConfirmDelete': Before writing the confirmation form for article
565 $article: the article (object) being deleted
566 $output: the OutputPage object
567 &$reason: the reason (string) the article is being deleted
569 'ArticleContentOnDiff': Before showing the article content below a diff. Use
570 this to change the content in this area or how it is loaded.
571 $diffEngine: the DifferenceEngine
572 $output: the OutputPage object
574 'ArticleContentViewCustom': Allows to output the text of the article in a
575 different format than wikitext. Note that it is preferable to implement proper
576 handing for a custom data type using the ContentHandler facility.
577 $content: content of the page, as a Content object
578 $title: title of the page
579 $output: reference to $wgOut
581 'ArticleDelete': Before an article is deleted.
582 &$wikiPage: the WikiPage (object) being deleted
583 &$user: the user (object) deleting the article
584 &$reason: the reason (string) the article is being deleted
585 &$error: if the deletion was prohibited, the (raw HTML) error message to display
587 &$status: Status object, modify this to throw an error. Overridden by $error
589 $suppress: Whether this is a suppression deletion or not (added in 1.27)
591 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
592 $title: Title of the article that has been deleted.
593 $outputPage: OutputPage that can be used to append the output.
595 'ArticleDeleteComplete': After an article is deleted.
596 &$wikiPage: the WikiPage that was deleted
597 &$user: the user that deleted the article
598 $reason: the reason the article was deleted
599 $id: id of the article that was deleted
600 $content: the Content of the deleted page
601 $logEntry: the ManualLogEntry used to record the deletion
603 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
605 &$wikiPage: WikiPage (object) of the user talk page
606 $recipient: User (object) who's talk page was edited
608 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
609 article has been changed.
610 &$wikiPage: the WikiPage (object)
611 &$editInfo: data holder that includes the parser output ($editInfo->output) for
612 that page after the change
613 $changed: bool for if the page was changed
615 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
616 recentchanges table, return false to not delete old entries.
617 &$wikiPage: WikiPage (object) being modified
619 'ArticleFromTitle': when creating an article object from a title object using
620 Wiki::articleFromTitle().
621 &$title: Title (object) used to create the article object
622 &$article: Article (object) that will be returned
623 $context: IContextSource (object)
625 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
626 After a new article is created.
627 $wikiPage: WikiPage created
628 $user: User creating the article
630 $summary: Edit summary/comment
631 $isMinor: Whether or not the edit was marked as minor
632 $isWatch: (No longer used)
633 $section: (No longer used)
634 $flags: Flags passed to WikiPage::doEditContent()
635 $revision: New Revision of the article
637 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
638 $targetTitle: target title (object)
639 $destTitle: destination title (object)
641 'ArticlePageDataAfter': After loading data of an article from the database.
642 &$wikiPage: WikiPage (object) whose data were loaded
643 &$row: row (object) returned from the database server
645 'ArticlePageDataBefore': Before loading data of an article from the database.
646 &$wikiPage: WikiPage (object) that data will be loaded
647 &$fields: fields (array) to load from the database
649 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
650 $wikiPage: the WikiPage being saved
651 $popts: parser options to be used for pre-save transformation
653 'ArticleProtect': Before an article is protected.
654 &$wikiPage: the WikiPage being protected
655 &$user: the user doing the protection
656 $protect: Set of restriction keys
657 $reason: Reason for protect
659 'ArticleProtectComplete': After an article is protected.
660 &$wikiPage: the WikiPage that was protected
661 &$user: the user who did the protection
662 $protect: Set of restriction keys
663 $reason: Reason for protect
665 'ArticlePurge': Before executing "&action=purge".
666 &$wikiPage: WikiPage (object) to purge
668 'ArticleRevisionUndeleted': After an article revision is restored.
669 &$title: the article title
670 $revision: the revision
671 $oldPageID: the page ID of the revision when archived (may be null)
673 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
674 revisions of an article.
675 $title: Title object of the article
676 $ids: Ids to set the visibility for
678 'ArticleRollbackComplete': After an article rollback is completed.
679 $wikiPage: the WikiPage that was edited
680 $user: the user who did the rollback
681 $revision: the revision the page was reverted back to
682 $current: the reverted revision
684 'ArticleSave': DEPRECATED! Use PageContentSave instead.
685 Before an article is saved.
686 $wikiPage: the WikiPage (object) being saved
687 $user: the user (object) saving the article
688 $text: the new article text
689 $summary: the article summary (comment)
694 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
695 After an article has been updated.
696 $wikiPage: WikiPage modified
697 $user: User performing the modification
699 $summary: Edit summary/comment
700 $isMinor: Whether or not the edit was marked as minor
701 $isWatch: (No longer used)
702 $section: (No longer used)
703 $flags: Flags passed to WikiPage::doEditContent()
704 $revision: New Revision of the article
705 $status: Status object about to be returned by doEditContent()
706 $baseRevId: the rev ID (or false) this edit was based on
708 'ArticleUndelete': When one or more revisions of an article are restored.
709 &$title: Title corresponding to the article restored
710 $create: Whether or not the restoration caused the page to be created (i.e. it
711 didn't exist before).
712 $comment: The comment associated with the undeletion.
713 $oldPageId: ID of page previously deleted (from archive table)
715 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
716 $pageArchive: the PageArchive object
717 &$logEntry: ManualLogEntry object
718 $user: User who is performing the log action
720 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
721 the user is redirected back to the page.
722 $article: the article
723 &$sectionanchor: The section anchor link (e.g. "#overview" )
724 &$extraq: Extra query parameters which can be added via hooked functions
726 'ArticleViewCustom': DEPRECATED! Use ArticleContentViewCustom instead.
727 Allows to output the text of the article in a different format than wikitext.
728 Note that it is preferable to implement proper handing for a custom data type
729 using the ContentHandler facility.
730 $text: text of the page
731 $title: title of the page
732 $output: reference to $wgOut
734 'ArticleViewFooter': After showing the footer section of an ordinary page view
735 $article: Article object
736 $patrolFooterShown: boolean whether patrol footer is shown
738 'ArticleViewHeader': Before the parser cache is about to be tried for article
740 &$article: the article
741 &$pcache: whether to try the parser cache or not
742 &$outputDone: whether the output for this page finished or not. Set to
743 a ParserOutput object to both indicate that the output is done and what
744 parser output was used.
746 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
747 redirect was followed.
748 &$article: target article (object)
750 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
751 for a reason other than misconfiguration or session loss. No return data is
752 accepted; this hook is for auditing only.
753 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
754 $user: The User object being authenticated against, or null if authentication
755 failed before getting that far.
756 $username: A guess at the user name being authenticated, or null if we can't
759 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
760 Called when creating a local account for an user logged in from an external
761 authentication method.
762 $user: User object created locally
764 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
765 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
766 extension to set it programmatically to a variable class.
767 &$auth: the $wgAuth object, probably a stub
769 'AutopromoteCondition': Check autopromote condition for user.
770 $type: condition type
773 &$result: result of checking autopromote condition
775 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
776 certain title are fetched.
778 $title: title of the page to which backlinks are sought
779 &$conds: query conditions
781 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
785 'BadImage': When checking against the bad image list. Change $bad and return
786 false to override. If an image is "bad", it is not rendered inline in wiki
787 pages or galleries in category pages.
788 $name: Image name being checked
789 &$bad: Whether or not the image is "bad"
791 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
792 custom HTML after the section. Any uses of the hook need to handle escaping.
793 $template: BaseTemplate
794 $portlet: string portlet name
797 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
798 and returning it for the skin to output. You can add items to the toolbox while
799 still letting the skin make final decisions on skin-specific markup conventions
801 &$sk: The BaseTemplate base skin template
802 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
803 BaseTemplate::makeListItem for details on the format of individual items
804 inside of this array.
806 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
807 "noarticletext-nopermission" at Article::showMissingArticle().
808 $article: article object
810 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
811 override how the redirect is output by modifying, or by returning false, and
812 letting standard HTTP rendering take place.
813 ATTENTION: This hook is likely to be removed soon due to overall design of the
815 $context: IContextSource object
816 &$redirect: string URL, modifiable
818 'BeforeInitialize': Before anything is initialized in
819 MediaWiki::performRequest().
820 &$title: Title being used for request
822 &$output: OutputPage object
824 $request: WebRequest object
825 $mediaWiki: Mediawiki object
827 'BeforePageDisplay': Prior to outputting a page.
828 &$out: OutputPage object
831 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
832 override how the redirect is output by modifying, or by returning false and
833 taking over the output.
834 $out: OutputPage object
835 &$redirect: URL, modifiable
836 &$code: HTTP code (eg '301' or '302'), modifiable
838 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
839 $parser: Parser object
841 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
842 as a key then the file will appear as a broken thumbnail.
843 &$descQuery: query string to add to thumbnail URL
845 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
846 $parser: Parser object
847 $title: title of the template
848 &$skip: skip this template and link it?
849 &$id: the id of the revision being parsed
851 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
852 &$parser: Parser object
853 &$ig: ImageGallery object
855 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
857 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
858 to a newly created user account.
859 &$injected_html: Any HTML to inject after the "logged in" message of a newly
862 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
863 normalizations have been performed, except for the $wgMaxImageArea check.
865 &$params: Array of parameters
866 &$checkImageAreaHookResult: null, set to true or false to override the
867 $wgMaxImageArea check result.
869 'BitmapHandlerTransform': before a file is transformed, gives extension the
870 possibility to transform it themselves
871 $handler: BitmapHandler
873 &$scalerParams: Array with scaler parameters
874 &$mto: null, set to a MediaTransformOutput
876 'BlockIp': Before an IP address or user is blocked.
877 &$block: the Block object about to be saved
878 &$user: the user _doing_ the block (not the one being blocked)
879 &$reason: if the hook is aborted, the error message to be returned in an array
881 'BlockIpComplete': After an IP address or user is blocked.
882 $block: the Block object that was saved
883 $user: the user who did the block (not the one being blocked)
885 'BookInformation': Before information output on Special:Booksources.
886 $isbn: ISBN to show information for
887 $output: OutputPage object in use
889 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
890 to be able to access the wiki via HTTPS.
891 $ip: The IP address in human-readable form
892 &$canDo: This reference should be set to false if the client may not be able
895 'CanonicalNamespaces': For extensions adding their own namespaces or altering
897 Note that if you need to specify namespace protection or content model for
898 a namespace that is added in a CanonicalNamespaces hook handler, you
899 should do so by altering $wgNamespaceProtection and
900 $wgNamespaceContentModels outside the handler, in top-level scope. The
901 point at which the CanonicalNamespaces hook fires is too late for altering
902 these variables. This applies even if the namespace addition is
903 conditional; it is permissible to declare a content model and protection
904 for a namespace and then decline to actually register it.
905 &$namespaces: Array of namespace numbers with corresponding canonical names
907 'CategoryAfterPageAdded': After a page is added to a category.
908 $category: Category that page was added to
909 $wikiPage: WikiPage that was added
911 'CategoryAfterPageRemoved': After a page is removed from a category.
912 $category: Category that page was removed from
913 $wikiPage: WikiPage that was removed
915 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
916 &$catpage: CategoryPage instance
918 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
919 in a Category page. Gives extensions the opportunity to batch load any
920 related data about the pages.
921 $type: The category type. Either 'page', 'file' or 'subcat'
922 $res: Query result from DatabaseBase::select()
924 'CategoryViewer::generateLink': Before generating an output link allow
925 extensions opportunity to generate a more specific or relevant link.
926 $type: The category type. Either 'page', 'img' or 'subcat'
927 $title: Title object for the categorized page
928 $html: Requested html content of anchor
929 &$link: Returned value. When set to a non-null value by a hook subscriber
930 this value will be used as the anchor instead of Linker::link
932 'ChangePasswordForm': For extensions that need to add a field to the
933 ChangePassword form via the Preferences form.
934 &$extraFields: An array of arrays that hold fields like would be passed to the
937 'ChangesListInitRows': Batch process change list rows prior to rendering.
938 $changesList: ChangesList instance
939 $rows: The data that will be rendered. May be a ResultWrapper instance or
942 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
943 &$changesList: ChangesList instance.
944 &$articlelink: HTML of link to article (already filled-in).
945 &$s: HTML of row that is being constructed.
946 &$rc: RecentChange instance.
947 $unpatrolled: Whether or not we are showing unpatrolled changes.
948 $watched: Whether or not the change is watched by the user.
950 'ChangesListSpecialPageFilters': Called after building form options on pages
951 inheriting from ChangesListSpecialPage (in core: RecentChanges,
952 RecentChangesLinked and Watchlist).
953 $special: ChangesListSpecialPage instance
954 &$filters: associative array of filter definitions. The keys are the HTML
955 name/URL parameters. Each key maps to an associative array with a 'msg'
956 (message key) and a 'default' value.
958 'ChangesListSpecialPageQuery': Called when building SQL query on pages
959 inheriting from ChangesListSpecialPage (in core: RecentChanges,
960 RecentChangesLinked and Watchlist).
961 $name: name of the special page, e.g. 'Watchlist'
962 &$tables: array of tables to be queried
963 &$fields: array of columns to select
964 &$conds: array of WHERE conditionals for query
965 &$query_options: array of options for the database request
966 &$join_conds: join conditions for the tables
967 $opts: FormOptions for this request
969 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
970 removed from all revisions and log entries to which it was applied). This gives
971 extensions a chance to take it off their books.
972 $tag: name of the tag
973 &$status: Status object. Add warnings to this as required. There is no point
974 setting errors, as the deletion has already been partly carried out by this
977 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
978 from the UI (Special:Tags) or via the API. You could use this hook if you want
979 to reserve a specific "namespace" of tags, or something similar.
980 $tag: name of the tag
981 $user: user initiating the action
982 &$status: Status object. Add your errors using `$status->fatal()` or warnings
983 using `$status->warning()`. Errors and warnings will be relayed to the user.
984 If you set an error, the user will be unable to create the tag.
986 'ChangeTagCanDelete': Tell whether a change tag should be able to be
987 deleted from the UI (Special:Tags) or via the API. The default is that tags
988 defined using the ListDefinedTags hook are not allowed to be deleted unless
989 specifically allowed. If you wish to allow deletion of the tag, set
990 `$status = Status::newGood()` to allow deletion, and then `return false` from
991 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
992 out custom deletion actions.
993 $tag: name of the tag
994 $user: user initiating the action
995 &$status: Status object. See above.
997 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
998 uses are in active use.
999 &$tags: list of all active tags. Append to this array.
1001 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1002 $collationName: Name of the collation in question
1003 &$collationObject: Null. Replace with a subclass of the Collation class that
1004 implements the collation given in $collationName.
1006 'ConfirmEmailComplete': Called after a user's email has been confirmed
1008 $user: user (object) whose email is being confirmed
1010 'ContentAlterParserOutput': Modify parser output for a given content object.
1011 Called by Content::getParserOutput after parsing has finished. Can be used
1012 for changes that depend on the result of the parsing but have to be done
1013 before LinksUpdate is called (such as adding tracking categories based on
1015 $content: The Content to render
1016 $title: Title of the page, as context
1017 $parserOutput: ParserOutput to manipulate
1019 'ContentGetParserOutput': Customize parser output for a given content object,
1020 called by AbstractContent::getParserOutput. May be used to override the normal
1021 model-specific rendering of page content.
1022 $content: The Content to render
1023 $title: Title of the page, as context
1024 $revId: The revision ID, as context
1025 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1026 the output can only depend on parameters provided to this hook function, not
1028 $generateHtml: boolean, indicating whether full HTML should be generated. If
1029 false, generation of HTML may be skipped, but other information should still
1030 be present in the ParserOutput object.
1031 &$output: ParserOutput, to manipulate or replace
1033 'ContentHandlerDefaultModelFor': Called when the default content model is
1034 determined for a given title. May be used to assign a different model for that
1036 $title: the Title in question
1037 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1039 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1040 a given content model name, but no entry for that model exists in
1042 $modeName: the requested content model name
1043 &$handler: set this to a ContentHandler object, if desired.
1045 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1046 be used on a given page. This is especially useful to prevent some content
1047 models to be used in some special location.
1048 $contentModel: ID of the content model in question
1049 $title: the Title in question.
1050 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1051 Handler functions that modify $ok should generally return false to prevent
1052 further hooks from further modifying $ok.
1054 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1055 &$pager: Pager object for contributions
1056 &$queryInfo: The query for the contribs Pager
1058 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1060 &$data: an array of results of all contribs queries
1061 $pager: The ContribsPager object hooked into
1062 $offset: Index offset, inclusive
1063 $limit: Exact query limit
1064 $descending: Query direction, false for ascending, true for descending
1066 'ContributionsLineEnding': Called before a contributions HTML line is finished
1067 $page: SpecialPage object for contributions
1068 &$ret: the HTML line
1069 $row: the DB row for this line
1070 &$classes: the classes to add to the surrounding <li>
1072 'ContributionsToolLinks': Change tool links above Special:Contributions
1073 $id: User identifier
1074 $title: User page title
1075 &$tools: Array of tool links
1077 'ConvertContent': Called by AbstractContent::convert when a conversion to
1078 another content model is requested.
1079 Handler functions that modify $result should generally return false to disable
1080 further attempts at conversion.
1081 $content: The Content object to be converted.
1082 $toModel: The ID of the content model to convert to.
1083 $lossy: boolean indicating whether lossy conversion is allowed.
1084 &$result: Output parameter, in case the handler function wants to provide a
1085 converted Content object. Note that $result->getContentModel() must return
1088 'CustomEditor': When invoking the page editor
1089 Return true to allow the normal editor to be used, or false if implementing
1090 a custom editor, e.g. for a special namespace, etc.
1091 $article: Article being edited
1092 $user: User performing the edit
1094 'DatabaseOraclePostInit': Called after initialising an Oracle database
1095 $db: the DatabaseOracle object
1097 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1098 for Special:DeletedContributions
1099 Similar to ContribsPager::reallyDoQuery
1100 &$data: an array of results of all contribs queries
1101 $pager: The DeletedContribsPager object hooked into
1102 $offset: Index offset, inclusive
1103 $limit: Exact query limit
1104 $descending: Query direction, false for ascending, true for descending
1106 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1108 Similar to ContributionsLineEnding
1109 $page: SpecialPage object for DeletedContributions
1110 &$ret: the HTML line
1111 $row: the DB row for this line
1112 &$classes: the classes to add to the surrounding <li>
1114 'DiffRevisionTools': Override or extend the revision tools available from the
1115 diff view, i.e. undo, etc.
1116 $newRev: Revision object of the "new" revision
1117 &$links: Array of HTML links
1118 $oldRev: Revision object of the "old" revision (may be null)
1119 $user: Current user object
1121 'DiffViewHeader': Called before diff display
1122 $diff: DifferenceEngine object that's calling
1123 $oldRev: Revision object of the "old" revision (may be null/invalid)
1124 $newRev: Revision object of the "new" revision
1126 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1128 &$article: article (object) being viewed
1129 &$oldid: oldid (int) being viewed
1131 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1132 Override the HTML generated for section edit links
1133 $skin: Skin object rendering the UI
1134 $title: Title object for the title being linked to (may not be the same as
1135 the page title, if the section is included from a template)
1136 $section: The designation of the section being pointed to, to be included in
1137 the link, like "§ion=$section"
1138 $tooltip: The default tooltip. Escape before using.
1139 By default, this is wrapped in the 'editsectionhint' message.
1140 &$result: The HTML to return, prefilled with the default plus whatever other
1141 changes earlier hooks have made
1142 $lang: The language code to use for the link in the wfMessage function
1144 'EditFilter': Perform checks on an edit
1145 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1146 $text: Contents of the edit box
1147 $section: Section being edited
1148 &$error: Error message to return
1149 $summary: Edit summary for page
1151 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1152 Post-section-merge edit filter.
1153 $editor: EditPage instance (object)
1154 $text: content of the edit box
1155 &$error: error message to return
1156 $summary: Edit summary for page
1158 'EditFilterMergedContent': Post-section-merge edit filter.
1159 This may be triggered by the EditPage or any other facility that modifies page
1160 content. Use the $status object to indicate whether the edit should be allowed,
1161 and to provide a reason for disallowing it. Return false to abort the edit, and
1162 true to continue. Returning true if $status->isOK() returns false means "don't
1163 save but continue user interaction", e.g. show the edit form.
1164 $status->apiHookResult can be set to an array to be returned by api.php
1165 action=edit. This is used to deliver captchas.
1166 $context: object implementing the IContextSource interface.
1167 $content: content of the edit box, as a Content object.
1168 $status: Status object to represent errors, etc.
1169 $summary: Edit summary for page
1170 $user: the User object representing the user whois performing the edit.
1171 $minoredit: whether the edit was marked as minor by the user.
1173 'EditFormInitialText': Allows modifying the edit form when editing existing
1175 $editPage: EditPage object
1177 'EditFormPreloadText': Allows population of the edit form when creating
1179 &$text: Text to preload with
1180 &$title: Title object representing the page being created
1182 'EditPage::attemptSave': Called before an article is
1183 saved, that is before WikiPage::doEditContent() is called
1184 $editpage_Obj: the current EditPage object
1186 'EditPage::attemptSave:after': Called after an article save attempt
1187 $editpage_Obj: the current EditPage object
1188 $status: the resulting Status object
1189 $resultDetails: Result details array
1191 'EditPage::importFormData': allow extensions to read additional data
1193 $editpage: EditPage instance
1194 $request: Webrequest
1195 return value is ignored (should always return true)
1197 'EditPage::showEditForm:fields': allows injection of form field into edit form
1198 Return value is ignored (should always return true)
1199 &$editor: the EditPage instance for reference
1200 &$out: an OutputPage instance to write to
1202 'EditPage::showEditForm:initial': before showing the edit form
1203 Return false to halt editing; you'll need to handle error messages, etc.
1204 yourself. Alternatively, modifying $error and returning true will cause the
1205 contents of $error to be echoed at the top of the edit form as wikitext.
1206 Return true without altering $error to allow the edit to proceed.
1207 &$editor: EditPage instance (object)
1208 &$out: an OutputPage instance to write to
1210 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1211 but for the read-only 'view source' variant of the edit form.
1212 Return value is ignored (should always return true)
1213 $editor: EditPage instance (object)
1214 &$out: an OutputPage instance to write to
1216 'EditPage::showStandardInputs:options': allows injection of form fields into
1217 the editOptions area
1218 Return value is ignored (should always be true)
1219 $editor: EditPage instance (object)
1220 $out: an OutputPage instance to write to
1221 &$tabindex: HTML tabindex of the last edit check/button
1223 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1224 when there's an edit conflict. Return false to halt normal diff output; in
1225 this case you're responsible for computing and outputting the entire "conflict"
1226 part, i.e., the "difference between revisions" and "your text" headers and
1228 &$editor: EditPage instance
1229 &$out: OutputPage instance
1231 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1232 textarea in the edit form.
1233 &$editpage: The current EditPage object
1234 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1235 &$tabindex: HTML tabindex of the last edit check/button
1237 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1239 &$editpage: The current EditPage object
1240 &$checks: Array of edit checks like "watch this page"/"minor edit"
1241 &$tabindex: HTML tabindex of the last edit check/button
1243 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1244 textarea in the edit form.
1245 &$toolbar: The toolbar HTMl
1247 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1248 contribution/copyright notice.
1249 $title: title of page being edited
1250 &$msg: localization message name, overridable. Default is either
1251 'copyrightwarning' or 'copyrightwarning2'.
1253 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1254 "Show changes". Note that it is preferable to implement diff handling for
1255 different data types using the ContentHandler facility.
1256 $editPage: EditPage object
1257 &$newtext: wikitext that will be used as "your version"
1259 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1260 Allow modifying the wikitext that will be used in "Show changes". Note that it
1261 is preferable to implement diff handling for different data types using the
1262 ContentHandler facility.
1263 $editPage: EditPage object
1264 &$newtext: wikitext that will be used as "your version"
1266 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1267 previewed. Note that it is preferable to implement previews for different data
1268 types using the ContentHandler facility.
1269 $editPage: EditPage object
1270 &$content: Content object to be previewed (may be replaced by hook function)
1272 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1273 Allow modifying the wikitext that will be previewed. Note that it is preferable
1274 to implement previews for different data types using the ContentHandler
1276 $editPage: EditPage object
1277 &$toparse: wikitext that will be parsed
1279 'EditPageNoSuchSection': When a section edit request is given for an
1280 non-existent section
1281 &$editpage: The current EditPage object
1282 &$res: the HTML of the error text
1284 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1285 of terms of service summary link that might exist separately from the copyright
1287 $title: title of page being edited
1288 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1290 'EmailConfirmed': When checking that the user's email address is "confirmed".
1291 This runs before the other checks, such as anonymity and the real check; return
1292 true to allow those checks to occur, and false if checking is done.
1293 &$user: User being checked
1294 &$confirmed: Whether or not the email address is confirmed
1296 'EmailUser': Before sending email from one user to another.
1297 &$to: MailAddress object of receiving user
1298 &$from: MailAddress object of sending user
1299 &$subject: subject of the mail
1300 &$text: text of the mail
1301 &$error: Out-param for an error
1303 'EmailUserCC': Before sending the copy of the email to the author.
1304 &$to: MailAddress object of receiving user
1305 &$from: MailAddress object of sending user
1306 &$subject: subject of the mail
1307 &$text: text of the mail
1309 'EmailUserComplete': After sending email from one user to another.
1310 $to: MailAddress object of receiving user
1311 $from: MailAddress object of sending user
1312 $subject: subject of the mail
1313 $text: text of the mail
1315 'EmailUserForm': After building the email user form object.
1316 &$form: HTMLForm object
1318 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1320 $user: The user who is trying to email another user.
1321 $editToken: The user's edit token.
1322 &$hookErr: Out-param for the error. Passed as the parameters to
1323 OutputPage::showErrorPage.
1325 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1326 group of changes in EnhancedChangesList.
1327 Hook subscribers can return false to omit this line from recentchanges.
1328 $changesList: EnhancedChangesList object
1329 &$links: The links that were generated by EnhancedChangesList
1330 $block: The RecentChanges objects in that block
1332 'EnhancedChangesListModifyLineData': to alter data used to build
1333 a grouped recent change inner line in EnhancedChangesList.
1334 Hook subscribers can return false to omit this line from recentchanges.
1335 $changesList: EnhancedChangesList object
1336 &$data: An array with all the components that will be joined in order to create the line
1337 $block: An array of RecentChange objects in that block
1338 $rc: The RecentChange object for this line
1340 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1341 a non-grouped recent change line in EnhancedChangesList.
1342 $changesList: EnhancedChangesList object
1343 &$data: An array with all the components that will be joined in order to create the line
1344 $rc: The RecentChange object for this line
1346 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1348 $ip: The ip address of the user
1350 'ExtensionTypes': Called when generating the extensions credits, use this to
1351 change the tables headers.
1352 &$extTypes: associative array of extensions types
1354 'ExtractThumbParameters': DEPRECATED! Media handler should override
1355 MediaHandler::parseParamString instead.
1356 Called when extracting thumbnail parameters from a thumbnail file name.
1357 $thumbname: the base name of the thumbnail file
1358 &$params: the currently extracted params (has source name, temp or archived
1361 'FetchChangesList': When fetching the ChangesList derivative for a particular
1363 $user: User the list is being fetched for
1364 &$skin: Skin object to be used with the list
1365 &$list: List object (defaults to NULL, change it to an object instance and
1366 return false override the list derivative used)
1368 'FileDeleteComplete': When a file is deleted.
1369 &$file: reference to the deleted file
1370 &$oldimage: in case of the deletion of an old image, the name of the old file
1371 &$article: in case all revisions of the file are deleted a reference to the
1372 WikiFilePage associated with the file.
1373 &$user: user who performed the deletion
1376 'FileTransformed': When a file is transformed and moved into storage.
1377 $file: reference to the File object
1378 $thumb: the MediaTransformOutput object
1379 $tmpThumbPath: The temporary file system path of the transformed file
1380 $thumbPath: The permanent storage path of the transformed file
1382 'FileUndeleteComplete': When a file is undeleted
1383 $title: title object to the file
1384 $fileVersions: array of undeleted versions. Empty if all versions were restored
1385 $user: user who performed the undeletion
1388 'FileUpload': When a file upload occurs.
1389 $file: Image object representing the file that was uploaded
1390 $reupload: Boolean indicating if there was a previously another image there or
1392 $hasDescription: Boolean indicating that there was already a description page
1393 and a new one from the comment wasn't created (since 1.17)
1395 'FormatAutocomments': When an autocomment is formatted by the Linker.
1396 &$comment: Reference to the accumulated comment. Initially null, when set the
1397 default code will be skipped.
1398 $pre: Boolean, true if there is text before this autocomment
1399 $auto: The extracted part of the parsed comment before the call to the hook.
1400 $post: Boolean, true if there is text after this autocomment
1401 $title: An optional title object used to links to sections. Can be null.
1402 $local: Boolean indicating whether section links should refer to local page.
1403 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1404 autocomment originated; null for the local wiki. Added in 1.26, should default
1405 to null in handler functions, for backwards compatibility.
1407 'GalleryGetModes': Get list of classes that can render different modes of a
1409 &$modeArray: An associative array mapping mode names to classes that implement
1410 that mode. It is expected all registered classes are a subclass of
1413 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1415 $user: user to promote.
1416 &$promote: groups that will be added.
1418 'GetBlockedStatus': after loading blocking status of an user from the database
1419 &$user: user (object) being checked
1421 'GetCacheVaryCookies': Get cookies that should vary cache options.
1422 $out: OutputPage object
1423 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1424 that have to vary cache options
1426 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1428 &$title: Title object of page
1429 &$url: string value as output (out parameter, can modify)
1430 $query: query options passed to Title::getCanonicalURL()
1432 'GetDefaultSortkey': Override the default sortkey for a page.
1433 $title: Title object that we need to get a sortkey for
1434 &$sortkey: Sortkey to use.
1436 'GetDifferenceEngine': Called when getting a new difference engine interface
1437 object Return false for valid object in $differenceEngine or true for the
1438 default difference engine.
1439 $context: IContextSource context to be used for diff
1440 $old: Revision ID to show and diff with
1441 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1442 $refreshCache: If set, refreshes the diff cache
1443 $unhide: If set, allow viewing deleted revs
1444 &$differenceEngine: output parameter, difference engine object to be used for
1447 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1448 underscore) magic words. Called by MagicWord.
1449 &$doubleUnderscoreIDs: array of strings
1451 'GetExtendedMetadata': Get extended file metadata for the API
1452 &$combinedMeta: Array of the form:
1453 'MetadataPropName' => array(
1454 value' => prop value,
1455 'source' => 'name of hook'
1457 $file: File object of file in question
1458 $context: RequestContext (including language to use)
1459 $single: Only extract the current language; if false, the prop value should
1460 be in the metadata multi-language array format:
1461 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1462 &$maxCacheTime: how long the results can be cached
1464 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1465 &$title: Title object of page
1466 &$url: string value as output (out parameter, can modify)
1467 $query: query options passed to Title::getFullURL()
1469 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1470 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1472 &$output: string for the output timestamp
1473 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1474 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1475 $user: User whose preferences are being used to make timestamp
1476 $lang: Language that will be used to render the timestamp
1478 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1479 &$title: Title object of page
1480 &$url: string value as output (out parameter, can modify)
1481 $query: query options passed to Title::getInternalURL()
1483 'GetIP': modify the ip of the current user (called only once).
1484 &$ip: string holding the ip as determined so far
1486 'GetLinkColours': modify the CSS class of an array of page links.
1487 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1489 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1491 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1492 working with internal urls (non-interwiki) then it may be preferable to work
1493 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1494 be buggy for internal urls on render if you do not re-implement the horrible
1495 hack that Title::getLocalURL uses in your own extension.
1496 &$title: Title object of page
1497 &$url: string value as output (out parameter, can modify)
1498 $query: query options passed to Title::getLocalURL()
1500 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1501 without any fancy queries or variants.
1502 &$title: Title object of page
1503 &$url: string value as output (out parameter, can modify)
1505 'GetLocalURL::Internal': Modify local URLs to internal pages.
1506 &$title: Title object of page
1507 &$url: string value as output (out parameter, can modify)
1508 $query: query options passed to Title::getLocalURL()
1510 'GetLogTypesOnUser': Add log types where the target is a userpage
1511 &$types: Array of log types
1513 'GetMetadataVersion': Modify the image metadata version currently in use. This
1514 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1515 that need to have versioned metadata should add an element to the end of the
1516 version array of the form 'handler_name=version'. Most media handlers won't need
1517 to do this unless they broke backwards compatibility with a previous version of
1518 the media handler metadata output.
1519 &$version: Array of version strings
1521 'GetNewMessagesAlert': Disable or modify the new messages alert
1522 &$newMessagesAlert: An empty string by default. If the user has new talk page
1523 messages, this should be populated with an alert message to that effect
1524 $newtalks: An empty array if the user has no new messages or an array
1525 containing links and revisions if there are new messages (See
1526 User::getNewMessageLinks)
1527 $user: The user object of the user who is loading the page
1528 $out: OutputPage object (to check what type of page the user is on)
1530 'GetPreferences': Modify user preferences.
1531 $user: User whose preferences are being modified.
1532 &$preferences: Preferences description array, to be fed to an HTMLForm object
1534 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1535 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1537 &$output: string for the output timestamp
1538 &$diff: DateInterval representing the difference between the timestamps
1539 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1540 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1541 $user: User whose preferences are being used to make timestamp
1542 $lang: Language that will be used to render the timestamp
1544 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1545 checked for. Use instead of userCan for most cases. Return false if the user
1546 can't do it, and populate $result with the reason in the form of
1547 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1548 might want to use ApiMessage to provide machine-readable details for the API).
1549 For consistency, error messages
1550 should be plain text with no special coloring, bolding, etc. to show that
1551 they're errors; presenting them properly to the user as errors is done by the
1553 &$title: Title object being checked against
1554 &$user: Current user object
1555 $action: Action being checked
1556 &$result: User permissions error to add. If none, return true.
1558 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1559 called only if expensive checks are enabled. Add a permissions error when
1560 permissions errors are checked for. Return false if the user can't do it, and
1561 populate $result with the reason in the form of array( messagename, param1,
1562 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1563 to provide machine-readable details for the API). For consistency, error
1564 messages should be plain text with no
1565 special coloring, bolding, etc. to show that they're errors; presenting them
1566 properly to the user as errors is done by the caller.
1567 &$title: Title object being checked against
1568 &$user: Current user object
1569 $action: Action being checked
1570 &$result: User permissions error to add. If none, return true.
1572 'GitViewers': Called when generating the list of git viewers for
1573 Special:Version, use this to change the list.
1574 &$extTypes: associative array of repo URLS to viewer URLs.
1576 'HistoryRevisionTools': Override or extend the revision tools available from the
1577 page history view, i.e. undo, rollback, etc.
1578 $rev: Revision object
1579 &$links: Array of HTML links
1580 $prevRev: Revision object, next in line in page history, or null
1581 $user: Current user object
1583 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1585 $context: An IContextSource object with information about the request being
1588 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1589 image insertion. You can skip the default logic entirely by returning false, or
1590 just modify a few things using call-by-reference.
1592 &$title: Title object of the image
1593 &$file: File object, or false if it doesn't exist
1594 &$frameParams: Various parameters with special meanings; see documentation in
1595 includes/Linker.php for Linker::makeImageLink
1596 &$handlerParams: Various parameters with special meanings; see documentation in
1597 includes/Linker.php for Linker::makeImageLink
1598 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1599 &$res: Final HTML output, used if you return false
1601 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1602 the image on an image page.
1603 &$imagePage: ImagePage object ($this)
1606 'ImagePageAfterImageLinks': Called after the image links section on an image
1608 $imagePage: ImagePage object ($this)
1609 &$html: HTML for the hook to add
1611 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1612 $imagePage: ImagePage object ($this)
1614 &$line: the HTML of the history line
1615 &$css: the line CSS class
1617 'ImagePageFindFile': Called when fetching the file associated with an image
1619 $page: ImagePage object
1621 &$displayFile: displayed File object
1623 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1624 $page: ImagePage object
1625 &$toc: Array of <li> strings
1627 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1629 &$title: the Title object of the file as it would appear for the upload page
1630 &$path: the original file and path name when img_auth was invoked by the web
1632 &$name: the name only component of the file
1633 &$result: The location to pass back results of the hook routine (only used if
1635 $result[0]=The index of the header message
1636 $result[1]=The index of the body text message
1637 $result[2 through n]=Parameters passed to body text message. Please note the
1638 header message cannot receive/use parameters.
1640 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1641 Return false to stop further processing of the tag
1642 $reader: XMLReader object
1643 $logInfo: Array of information
1645 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1646 Return false to stop further processing of the tag
1647 $reader: XMLReader object
1648 &$pageInfo: Array of information
1650 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1651 Return false to stop further processing of the tag
1652 $reader: XMLReader object
1653 $pageInfo: Array of page information
1654 $revisionInfo: Array of revision information
1656 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1657 Return false to stop further processing of the tag
1658 $reader: XMLReader object
1660 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1661 Return false to stop further processing of the tag
1662 $reader: XMLReader object
1663 $revisionInfo: Array of information
1665 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1666 and edit summaries for transwiki imports.
1667 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1668 &$pageTitle: String that contains page title.
1670 'ImportSources': Called when reading from the $wgImportSources configuration
1671 variable. Can be used to lazy-load the import sources list.
1672 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1673 comment in DefaultSettings.php for the detail of how to structure this array.
1675 'InfoAction': When building information to display on the action=info page.
1676 $context: IContextSource object
1677 &$pageInfo: Array of information
1679 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1680 &$title: Title object for the current page
1681 &$request: WebRequest
1682 &$ignoreRedirect: boolean to skip redirect check
1683 &$target: Title/string of redirect target
1684 &$article: Article object
1686 'InternalParseBeforeLinks': during Parser's internalParse method before links
1687 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1688 &$parser: Parser object
1689 &$text: string containing partially parsed text
1690 &$stripState: Parser's internal StripState object
1692 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1693 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1694 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1695 template/parser function execution which respect nowiki and HTML-comments.
1696 &$parser: Parser object
1697 &$text: string containing partially parsed text
1698 &$stripState: Parser's internal StripState object
1700 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1701 Return true without providing an interwiki to continue interwiki search.
1702 $prefix: interwiki prefix we are looking for.
1703 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1704 iw_trans and optionally iw_api and iw_wikiid.
1706 'InvalidateEmailComplete': Called after a user's email has been invalidated
1708 $user: user (object) whose email is being invalidated
1710 'IRCLineURL': When constructing the URL to use in an IRC notification.
1711 Callee may modify $url and $query, URL will be constructed as $url . $query
1712 &$url: URL to index.php
1713 &$query: Query string
1714 $rc: RecentChange object that triggered url generation
1716 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1717 &$article: article (object) being checked
1719 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1720 &$ip: IP being check
1721 &$result: Change this value to override the result of IP::isTrustedProxy()
1723 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1724 $url: URL used to upload from
1725 &$allowed: Boolean indicating if uploading is allowed for given URL
1727 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1728 instance to return false if the domain name doesn't match your organization.
1729 $addr: The e-mail address entered by the user
1730 &$result: Set this and return false to override the internal checks
1732 'isValidPassword': Override the result of User::isValidPassword()
1733 $password: The password entered by the user
1734 &$result: Set this and return false to override the internal checks
1735 $user: User the password is being validated for
1737 'Language::getMessagesFileName':
1738 $code: The language code or the language we're looking for a messages file for
1739 &$file: The messages file path, you can override this to change the location.
1741 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1742 $wgExtensionMessagesFiles instead.
1743 Use this to define synonyms of magic words depending of the language
1744 &$magicExtensions: associative array of magic words synonyms
1745 $lang: language code (string)
1747 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1748 remove namespaces. Do not use this hook to add namespaces. Use
1749 CanonicalNamespaces for that.
1750 &$namespaces: Array of namespaces indexed by their numbers
1752 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1753 listed in $wgExtensionMessagesFiles instead.
1754 Use to define aliases of special pages names depending of the language
1755 &$specialPageAliases: associative array of magic words synonyms
1756 $lang: language code (string)
1758 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1759 &$names: array of language code => language name
1760 $code: language of the preferred translations
1762 'LanguageLinks': Manipulate a page's language links. This is called
1763 in various places to allow extensions to define the effective language
1765 $title: The page's Title.
1766 &$links: Associative array mapping language codes to prefixed links of the
1767 form "language:title".
1768 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1769 Currently unused, but planned to provide support for marking individual
1770 language links in the UI, e.g. for featured articles.
1772 'LanguageSelector': Hook to change the language selector available on a page.
1773 $out: The output page.
1774 $cssClassName: CSS class name of the language selector.
1776 'LinkBegin': Used when generating internal and interwiki links in
1777 Linker::link(), before processing starts. Return false to skip default
1778 processing and return $ret. See documentation for Linker::link() for details on
1779 the expected meanings of parameters.
1780 $skin: the Skin object
1781 $target: the Title that the link is pointing to
1782 &$html: the contents that the <a> tag should have (raw HTML); null means
1784 &$customAttribs: the HTML attributes that the <a> tag should have, in
1785 associative array form, with keys and values unescaped. Should be merged
1786 with default values, with a value of false meaning to suppress the
1788 &$query: the query string to add to the generated URL (the bit after the "?"),
1789 in associative array form, with keys and values unescaped.
1790 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1791 &$ret: the value to return if your hook returns false.
1793 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1794 just before the function returns a value. If you return true, an <a> element
1795 with HTML attributes $attribs and contents $html will be returned. If you
1796 return false, $ret will be returned.
1797 $skin: the Skin object
1798 $target: the Title object that the link is pointing to
1799 $options: the options. Will always include either 'known' or 'broken', and may
1800 include 'noclasses'.
1801 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1802 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1803 associative array form.
1804 &$ret: the value to return if your hook returns false.
1806 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1808 &$url: the image url
1809 &$alt: the image's alt text
1810 &$img: the new image HTML (if returning false)
1812 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1815 &$text: the link text
1816 &$link: the new link HTML (if returning false)
1817 &$attribs: the attributes to be applied.
1818 $linkType: The external link type
1820 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1822 $title: the Title object that the link is pointing to
1823 $file: the File object or false if broken link
1824 &$html: the link text
1825 &$attribs: the attributes to be applied
1826 &$ret: the value to return if your hook returns false
1828 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1830 &$linksUpdate: the LinksUpdate object
1832 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1833 each link table insert. For example, pagelinks, imagelinks, externallinks.
1834 $linksUpdate: LinksUpdate object
1835 $table: the table to insert links to
1836 $insertions: an array of links to insert
1838 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1839 including delete and insert, has completed for all link tables
1840 &$linksUpdate: the LinksUpdate object
1842 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1843 &$linksUpdate: the LinksUpdate object
1845 'ListDefinedTags': When trying to find all defined tags.
1846 &$tags: The list of tags.
1848 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1849 $updater: A DatabaseUpdater subclass
1851 'LocalFile::getHistory': Called before file history query performed.
1852 &$file: the File object
1854 &$fields: select fields
1856 &$opts: query options
1857 &$join_conds: JOIN conditions
1859 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1860 $file: the File object
1861 $archiveName: name of an old file version or false if it's the current one
1863 'LocalisationCacheRecache': Called when loading the localisation data into
1865 $cache: The LocalisationCache object
1866 $code: language code
1867 &$alldata: The localisation data from core and extensions
1868 &$purgeBlobs: whether to purge/update the message blobs via
1869 MessageBlobStore::clear()
1871 'LocalisationCacheRecacheFallback': Called for each language when merging
1872 fallback data into the cache.
1873 $cache: The LocalisationCache object
1874 $code: language code
1875 &$alldata: The localisation data from core and extensions. Note some keys may
1876 be omitted if they won't be merged into the final result.
1878 'LocalisationChecksBlacklist': When fetching the blacklist of
1879 localisation checks.
1880 &$blacklist: array of checks to blacklist. See the bottom of
1881 maintenance/language/checkLanguage.inc for the format of this variable.
1883 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1884 optional localisation messages
1885 &$ignored: Array of ignored message keys
1886 &$optional: Array of optional message keys
1888 'LocalUserCreated': Called when a local user has been created
1889 $user: User object for the created user
1890 $autocreated: Boolean, whether this was an auto-creation
1892 'LogEventsListGetExtraInputs': When getting extra inputs to display on
1893 Special:Log for a specific log type
1894 $type: String of log type being displayed
1895 $logEventsList: LogEventsList object for context and access to the WebRequest
1896 &$input: string HTML of an input element
1898 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1899 Returning false will prevent the string from being added to the OutputPage.
1900 &$s: html string to show for the log extract
1901 $types: String or Array Log types to show
1902 $page: String or Title The page title to show log entries for
1903 $user: String The user who made the log entries
1904 $param: Associative Array with the following additional options:
1905 - lim Integer Limit of items to show, default is 50
1906 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1907 - showIfEmpty boolean Set to false if you don't want any output in case the
1908 loglist is empty if set to true (default), "No matching items in log" is
1909 displayed if loglist is empty
1910 - msgKey Array If you want a nice box with a message, set this to the key of
1911 the message. First element is the message key, additional optional elements
1912 are parameters for the key that are processed with
1913 wfMessage()->params()->parseAsBlock()
1914 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1916 - wrap String Wrap the message in html (usually something like
1917 "<div ...>$1</div>").
1918 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1920 'LogException': Called before an exception (or PHP error) is logged. This is
1921 meant for integration with external error aggregation services; returning false
1922 will NOT prevent logging.
1923 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
1924 $suppressed: true if the error was suppressed via
1925 error_reporting()/wfSuppressWarnings()
1927 'LoginAuthenticateAudit': A login attempt for a valid user account either
1928 succeeded or failed. No return data is accepted; this hook is for auditing only.
1929 $user: the User object being authenticated against
1930 $password: the password being submitted and found wanting
1931 $retval: a LoginForm class constant with authenticateUserData() return
1932 value (SUCCESS, WRONG_PASS, etc.).
1934 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
1935 error messages. Allows to add additional error messages (except messages already
1936 in LoginForm::$validErrorMessages).
1937 &$messages: Already added messages (inclusive messages from
1938 LoginForm::$validErrorMessages)
1940 'LoginPasswordResetMessage': User is being requested to reset their password on
1941 login. Use this hook to change the Message that will be output on
1942 Special:ChangePassword.
1943 &$msg: Message object that will be shown to the user
1944 $username: Username of the user who's password was expired.
1946 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
1947 Called during login to allow extensions the opportunity to inform a user that
1948 their username doesn't exist for a specific reason, instead of letting the
1949 login form give the generic error message that the account does not exist. For
1950 example, when the account has been renamed or deleted.
1951 $user: the User object being authenticated against.
1952 &$msg: the message identifier for abort reason, or an array to pass a message
1955 'LogLine': Processes a single log entry on Special:Log.
1956 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1957 logging.log_type database field.
1958 $log_action: string for the type of log action (e.g. 'delete', 'block',
1959 'create2'). Corresponds to logging.log_action database field.
1960 $title: Title object that corresponds to logging.log_namespace and
1961 logging.log_title database fields.
1962 $paramArray: Array of parameters that corresponds to logging.log_params field.
1963 Note that only $paramArray[0] appears to contain anything.
1964 &$comment: string that corresponds to logging.log_comment database field, and
1965 which is displayed in the UI.
1966 &$revert: string that is displayed in the UI, similar to $comment.
1967 $time: timestamp of the log entry (added in 1.12)
1969 'LonelyPagesQuery': Allow extensions to modify the query used by
1970 Special:LonelyPages.
1971 &$tables: tables to join in the query
1972 &$conds: conditions for the query
1973 &$joinConds: join conditions for the query
1975 'MagicWordwgVariableIDs': When defining new magic words IDs.
1976 &$variableIDs: array of strings
1978 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1980 $refreshLinks: RefreshLinks object
1982 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1983 Ideally, this hook should only be used to add variables that depend on
1984 the current page/request; static configuration should be added through
1985 ResourceLoaderGetConfigVars instead.
1986 &$vars: variable (or multiple variables) to be added into the output of
1987 Skin::makeVariablesScript
1988 $out: The OutputPage which called the hook, can be used to get the real title.
1990 'MarkPatrolled': Before an edit is marked patrolled.
1991 $rcid: ID of the revision to be marked patrolled
1992 &$user: the user (object) marking the revision as patrolled
1993 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1994 sysop in order to mark an edit patrolled.
1995 $auto: true if the edit is being marked as patrolled automatically
1997 'MarkPatrolledComplete': After an edit is marked patrolled.
1998 $rcid: ID of the revision marked as patrolled
1999 &$user: user (object) who marked the edit patrolled
2000 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2001 sysop to patrol the edit.
2002 $auto: true if the edit is being marked as patrolled automatically
2004 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2005 something completely different, after the basic globals have been set up, but
2006 before ordinary actions take place.
2008 $article: Article on which the action will be performed
2009 $title: Title on which the action will be performed
2011 $request: $wgRequest
2012 $mediaWiki: The $mediawiki object
2014 'MediaWikiServices': Called when a global MediaWikiServices instance is
2015 initialized. Extensions may use this to define, replace, or wrap services.
2016 However, the preferred way to define a new service is
2017 the $wgServiceWiringFiles array.
2018 $services: MediaWikiServices
2020 'MessageCache::get': When fetching a message. Can be used to override the key
2021 for customisations. Given and returned message key must be in special format:
2022 1) first letter must be in lower case according to the content language.
2023 2) spaces must be replaced with underscores
2024 &$key: message key (string)
2026 'MessageCacheReplace': When a message page is changed. Useful for updating
2028 $title: name of the page changed.
2029 $text: new contents of the page.
2031 'MessagesPreLoad': When loading a message from the database.
2032 $title: title of the message (string)
2033 &$message: value (string), change it to the message you want to define
2035 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2036 $mimeMagic: Instance of MimeMagic.
2037 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2038 &$tail: More or equal than last 65558 bytes of the file in a string
2039 (in - Do not alter!).
2041 &$mime: MIME type (out).
2043 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2044 MIME type detected by considering the file extension.
2045 $mimeMagic: Instance of MimeMagic.
2046 $ext: File extension.
2047 &$mime: MIME type (in/out).
2049 'MimeMagicInit': Before processing the list mapping MIME types to media types
2050 and the list mapping MIME types to file extensions.
2051 As an extension author, you are encouraged to submit patches to MediaWiki's
2052 core to add new MIME types to mime.types.
2053 $mimeMagic: Instance of MimeMagic.
2054 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2055 for adding new MIME info to the list.
2056 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2057 for adding new MIME types to the list.
2059 'ModifyExportQuery': Modify the query used by the exporter.
2060 $db: The database object to be queried.
2061 &$tables: Tables in the query.
2062 &$conds: Conditions in the query.
2063 &$opts: Options for the query.
2064 &$join_conds: Join conditions for the query.
2066 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2068 $oldTitle: Title object of the current (old) location
2069 $newTitle: Title object of the new location
2070 $user: User making the move
2071 $reason: string of the reason provided by the user
2072 $status: Status object to pass error messages to
2074 'MovePageIsValidMove': Specify whether a page can be moved for technical
2076 $oldTitle: Title object of the current (old) location
2077 $newTitle: Title object of the new location
2078 $status: Status object to pass error messages to
2080 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2082 $index: Integer; the index of the namespace being checked.
2083 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2084 namespace are movable. Hooks may change this value to override the return
2085 value of MWNamespace::isMovable().
2087 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2088 $title: the diff page title (nullable)
2089 &$oldId: the actual old Id to use in the diff
2090 &$newId: the actual new Id to use in the diff (0 means current)
2091 $old: the ?old= param value from the url
2092 $new: the ?new= param value from the url
2094 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2096 $wikiPage: the WikiPage edited
2097 $rev: the new revision
2098 $baseID: the revision ID this was based off, if any
2099 $user: the editing user
2101 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2102 return false to omit the line from RecentChanges and Watchlist special pages.
2103 &$changeslist: The OldChangesList instance.
2104 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2105 $rc: The RecentChange object.
2106 &$classes: array of css classes for the <li> element
2108 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2109 can alter or append to the array of URLs for search & suggestion formats.
2110 &$urls: array of associative arrays with Url element attributes
2112 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2113 when a page view triggers a re-rendering of the page. This may happen
2114 particularly if the parser cache is split by user language, and no cached
2115 rendering of the page exists in the user's language. The hook is called
2116 before checking whether page_links_updated indicates that the links are up
2117 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2118 without triggering any updates.
2119 $page: the Page that was rendered.
2120 $title: the Title of the rendered page.
2121 $parserOutput: ParserOutput resulting from rendering the page.
2123 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2124 users and/or IP addresses too.
2125 &$otherBlockLink: An array with links to other block logs
2126 $ip: The requested IP address or username
2128 'OutputPageBeforeHTML': A page has been processed by the parser and the
2129 resulting HTML is about to be displayed.
2130 &$parserOutput: the parserOutput (object) that corresponds to the page
2131 &$text: the text that will be displayed, in HTML (string)
2133 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2134 body tag to allow for extensions to add attributes to the body of the page they
2135 might need. Or to allow building extensions to add body classes that aren't of
2136 high enough demand to be included in core.
2137 $out: The OutputPage which called the hook, can be used to get the real title
2138 $sk: The Skin that called OutputPage::headElement
2139 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2141 'OutputPageCheckLastModified': when checking if the page has been modified
2142 since the last visit.
2143 &$modifiedTimes: array of timestamps.
2144 The following keys are set: page, user, epoch
2145 $out: OutputPage object (since 1.28)
2147 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2148 categories. Implementations should return false if they generate the category
2149 links, so the default link generation is skipped.
2150 &$out: OutputPage instance (object)
2151 $categories: associative array, keys are category names, values are category
2152 types ("normal" or "hidden")
2153 &$links: array, intended to hold the result. Must be an associative array with
2154 category types as keys and arrays of HTML links as values.
2156 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2157 &$out: OutputPage instance (object)
2158 $parserOutput: parserOutput instance being added in $out
2160 'PageContentInsertComplete': After a new article is created.
2161 $wikiPage: WikiPage created
2162 $user: User creating the article
2163 $content: New content as a Content object
2164 $summary: Edit summary/comment
2165 $isMinor: Whether or not the edit was marked as minor
2166 $isWatch: (No longer used)
2167 $section: (No longer used)
2168 $flags: Flags passed to WikiPage::doEditContent()
2169 $revision: New Revision of the article
2171 'PageContentLanguage': Allows changing the language in which the content of a
2172 page is written. Defaults to the wiki content language ($wgContLang).
2173 $title: Title object
2174 &$pageLang: the page content language (either an object or a language code)
2175 $wgLang: the user language
2177 'PageContentSave': Before an article is saved.
2178 $wikiPage: the WikiPage (object) being saved
2179 $user: the user (object) saving the article
2180 $content: the new article content, as a Content object
2181 $summary: the article summary (comment)
2182 $isminor: minor flag
2183 $iswatch: watch flag
2186 'PageContentSaveComplete': After an article has been updated.
2187 $wikiPage: WikiPage modified
2188 $user: User performing the modification
2189 $content: New content, as a Content object
2190 $summary: Edit summary/comment
2191 $isMinor: Whether or not the edit was marked as minor
2192 $isWatch: (No longer used)
2193 $section: (No longer used)
2194 $flags: Flags passed to WikiPage::doEditContent()
2195 $revision: New Revision of the article (can be null for edits that change
2197 $status: Status object about to be returned by doEditContent()
2198 $baseRevId: the rev ID (or false) this edit was based on
2200 'PageHistoryBeforeList': When a history page list is about to be constructed.
2201 &$article: the article that the history is loading for
2202 $context: RequestContext object
2204 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2205 $historyAction: the action object
2206 &$row: the revision row for this line
2207 &$s: the string representing this parsed line
2208 &$classes: array containing the <li> element classes
2210 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2211 any output is generated, to allow batch lookups for prefetching information
2212 needed for display. If the hook handler returns false, the regular behavior of
2213 doBatchLookups() is skipped.
2214 $pager: the PageHistoryPager
2215 $result: a ResultWrapper representing the query result
2217 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2220 &$queryInfo: the query parameters
2222 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2223 which depends on user options should install this hook and append its values to
2225 &$confstr: reference to a hash key string which can be modified
2226 $user: User (object) requesting the page
2227 &$forOptions: array of options the hash is for
2229 'PageViewUpdates': Allow database (or other) changes to be made after a
2230 page view is seen by MediaWiki. Note this does not capture views made
2231 via external caches such as Squid.
2232 $wikipage: WikiPage (object) for the page being viewed.
2233 $user: User (object) for the user who is viewing.
2235 'ParserAfterParse': Called from Parser::parse() just after the call to
2236 Parser::internalParse() returns.
2237 &$parser: parser object
2238 &$text: text being parsed
2239 &$stripState: stripState used (object)
2241 'ParserAfterStrip': Called at end of parsing time.
2242 TODO: No more strip, deprecated ?
2243 &$parser: parser object
2244 &$text: text being parsed
2245 &$stripState: stripState used (object)
2247 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2248 &$parser: Parser object being used
2249 &$text: text that will be returned
2251 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2252 Parser::internalParseHalfParsed()
2253 &$parser: Parser object being used
2254 &$text: text that will be returned
2256 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2257 &$parser: Parser object
2258 &$text: text to parse
2259 &$stripState: StripState instance being used
2261 'ParserBeforeStrip': Called at start of parsing time.
2262 TODO: No more strip, deprecated ?
2263 &$parser: parser object
2264 &$text: text being parsed
2265 &$stripState: stripState used (object)
2267 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2268 &$parser: Parser object being used
2271 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2273 $parserCache: ParserCache object $parserOutput was stored in
2274 $parserOutput: ParserOutput object that was stored
2275 $title: Title of the page that was parsed to generate $parserOutput
2276 $popts: ParserOptions used for generating $parserOutput
2277 $revId: ID of the revision that was parsed to create $parserOutput
2279 'ParserClearState': Called at the end of Parser::clearState().
2280 &$parser: Parser object being cleared
2282 'ParserCloned': Called when the parser is cloned.
2283 $parser: Newly-cloned Parser object
2285 'ParserFirstCallInit': Called when the parser initialises for the first time.
2286 &$parser: Parser object being cleared
2288 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2290 &$parser: Parser object
2291 &$varCache: array to store the value in case of multiples calls of the
2293 &$index: index (string) of the magic
2294 &$ret: value of the magic word (the hook should set it)
2295 &$frame: PPFrame object to use for expanding any template variables
2297 'ParserGetVariableValueTs': Use this to change the value of the time for the
2298 {{LOCAL...}} magic word.
2299 &$parser: Parser object
2300 &$time: actual time (timestamp)
2302 'ParserGetVariableValueVarCache': use this to change the value of the variable
2303 cache or return false to not use it.
2304 &$parser: Parser object
2305 &$varCache: variable cache (array)
2307 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2308 ParserLimitReportFormat instead.
2309 Called at the end of Parser:parse() when the parser will
2310 include comments about size of the text parsed.
2311 $parser: Parser object
2312 &$limitReport: text that will be included (without comment tags)
2314 'ParserLimitReportFormat': Called for each row in the parser limit report that
2315 needs formatting. If nothing handles this hook, the default is to use "$key" to
2316 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2318 $key: Key for the limit report item (string)
2319 &$value: Value of the limit report item
2320 &$report: String onto which to append the data
2321 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2322 text intended for display in a monospaced font.
2323 $localize: If false, $report should be output in English.
2325 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2326 will include comments about size of the text parsed. Hooks should use
2327 $output->setLimitReportData() to populate data. Functions for this hook should
2328 not use $wgLang; do that in ParserLimitReportFormat instead.
2329 $parser: Parser object
2330 $output: ParserOutput object
2332 'ParserMakeImageParams': Called before the parser make an image link, use this
2333 to modify the parameters of the image.
2334 $title: title object representing the file
2335 $file: file object that will be used to create the image
2336 &$params: 2-D array of parameters
2337 $parser: Parser object that called the hook
2339 'ParserSectionCreate': Called each time the parser creates a document section
2340 from wikitext. Use this to apply per-section modifications to HTML (like
2341 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2342 can begin in one section and end in another. Make sure your code can handle
2343 that case gracefully. See the EditSectionClearerLink extension for an example.
2344 $parser: the calling Parser instance
2345 $section: the section number, zero-based, but section 0 is usually empty
2346 &$sectionContent: ref to the content of the section. modify this.
2347 $showEditLinks: boolean describing whether this section has an edit link
2349 'ParserTestGlobals': Allows to define globals for parser tests.
2350 &$globals: Array with all the globals which should be set for parser tests.
2351 The arrays keys serve as the globals names, its values are the globals values.
2353 'ParserTestParser': Called when creating a new instance of Parser in
2354 tests/parser/parserTest.inc.
2355 &$parser: Parser object created
2357 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2358 run. Use when page save hooks require the presence of custom tables to ensure
2359 that tests continue to run properly.
2360 &$tables: array of table names
2362 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2363 $page: the WikiPage of the candidate edit
2364 $content: the Content object of the candidate edit
2365 $output: the ParserOutput result of the candidate edit
2367 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2368 $user: User object whose policy you are modifying
2369 &$effectivePolicy: Array of policy statements that apply to this user
2370 $purpose: string indicating purpose of the check, one of 'login', 'create',
2373 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2375 $block: Block object (which is set to be autoblocking)
2376 &$blockIds: Array of block IDs of the autoblock
2378 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2379 my talk page, my contributions" etc).
2380 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2381 &$title: Title object representing the current page
2382 $skin: SkinTemplate object providing context (e.g. to check if the user is
2385 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2386 &$user: User performing the action
2387 $action: Action being performed
2388 &$result: Whether or not the action should be prevented
2389 Change $result and return false to give a definitive answer, otherwise
2390 the built-in rate limiting checks are used, if enabled.
2391 $incrBy: Amount to increment counter by
2393 'PlaceNewSection': Override placement of new sections. Return false and put the
2394 merged text into $text to override the default behavior.
2395 $wikipage: WikiPage object
2396 $oldtext: the text of the article before editing
2397 $subject: subject of the new section
2398 &$text: text of the new section
2400 'PostLoginRedirect': Modify the post login redirect behavior.
2401 Occurs after signing up or logging in, allows for interception of redirect.
2402 &$returnTo: The page name to return to, as a string
2403 &$returnToQuery: array of url parameters, mapping parameter names to values
2404 &$type: type of login redirect as string;
2405 error: display a return to link ignoring $wgRedirectOnLogin
2406 signup: display a return to link using $wgRedirectOnLogin if needed
2407 success: display a return to link using $wgRedirectOnLogin if needed
2408 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2410 'PreferencesFormPreSave': Override preferences being saved
2411 $formData: array of user submitted data
2412 $form: PreferencesForm object, also a ContextSource
2413 $user: User object with preferences to be saved set
2414 &$result: boolean indicating success
2416 'PreferencesGetLegend': Override the text used for the <legend> of a
2417 preferences section.
2418 $form: the PreferencesForm object. This is a ContextSource as well
2419 $key: the section name
2420 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2423 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2424 Override the title prefix search used for OpenSearch and
2425 AJAX search suggestions. Put results into &$results outparam and return false.
2426 $ns: array of int namespace keys to search in
2427 $search: search term (not guaranteed to be conveniently normalized)
2428 $limit: maximum number of results to return
2429 &$results: out param: array of page names (strings)
2430 $offset: number of results to offset from the beginning
2432 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2433 namespace from the search string so that extensions can attempt it.
2434 &$namespaces: array of int namespace keys to search in (change this if you can
2436 &$search: search term (replace this with term without the namespace if you can
2439 'PrefsEmailAudit': Called when user changes their email address.
2440 $user: User (object) changing his email address
2441 $oldaddr: old email address (string)
2442 $newaddr: new email address (string)
2444 'PrefsPasswordAudit': Called when user changes his password.
2445 $user: User (object) changing his password
2446 $newPass: new password
2447 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2449 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2451 $article: the title being (un)protected
2452 &$output: a string of the form HTML so far
2454 'ProtectionForm::save': Called when a protection form is submitted.
2455 $article: the Page being (un)protected
2456 &$errorMsg: an html message string of an error or an array of message name and
2458 $reasonstr: a string describing the reason page protection level is altered
2460 'ProtectionForm::showLogExtract': Called after the protection log extract is
2462 $article: the page the form is shown for
2463 $out: OutputPage object
2465 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2467 &$tables: Database tables to be used in the query
2468 &$conds: Conditions to be applied in the query
2469 &$joinConds: Join conditions to be applied in the query
2471 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2472 &$obj: RawAction object
2473 &$text: The text that's going to be the output
2475 'RecentChange_save': Called at the end of RecentChange::save().
2476 &$recentChange: RecentChange object
2478 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2479 names such as "oldid" that are preserved when using redirecting special pages
2480 such as Special:MyPage and Special:MyTalk.
2481 &$redirectParams: An array of parameters preserved by redirecting special pages.
2483 'RejectParserCacheValue': Return false to reject an otherwise usable
2484 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2485 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2487 $parserOutput: ParserOutput value.
2488 $wikiPage: WikiPage object.
2489 $parserOptions: ParserOptions object.
2491 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2492 instance. Can be used by an extension override what skin is used in certain
2494 $context: (IContextSource) The RequestContext the skin is being created for.
2495 &$skin: A variable reference you may set a Skin instance or string key on to
2496 override the skin that will be used for the context.
2498 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2499 $user: The user having their password expiration reset
2500 &$newExpire: The new expiration date
2502 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2503 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2504 to override its behavior. See the module docs for more information.
2505 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2507 $context: ResourceLoaderContext|null
2509 'ResourceLoaderGetConfigVars': Called at the end of
2510 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2511 configuration variables to JavaScript. Things that depend on the current page
2512 or request state must be added through MakeGlobalVariablesScript instead.
2513 &$vars: array( variable name => value )
2515 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2516 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2517 context-based variables.
2518 &$lessVars: array of variables already added
2520 'ResourceLoaderRegisterModules': Right before modules information is required,
2521 such as when responding to a resource
2522 loader request or generating HTML output.
2523 &$resourceLoader: ResourceLoader object
2525 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2526 called after the addition of 'qunit' and MediaWiki testing resources.
2527 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2528 included in core, is fed using tests/qunit/QUnitTestResources.php.
2529 To add a new qunit module named 'myext.tests':
2530 $testModules['qunit']['myext.tests'] = array(
2531 'script' => 'extension/myext/tests.js',
2532 'dependencies' => <any module dependency you might have>
2534 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2535 added to any module.
2536 &$ResourceLoader: object
2538 'RevisionInsertComplete': Called after a revision is inserted into the database.
2539 &$revision: the Revision
2540 $data: the data stored in old_text. The meaning depends on $flags: if external
2541 is set, it's the URL of the revision text in external storage; otherwise,
2542 it's the revision text itself. In either case, if gzip is set, the revision
2544 $flags: a comma-delimited list of strings representing the options used. May
2545 include: utf8 (this will always be set for new revisions); gzip; external.
2547 'SearchableNamespaces': An option to modify which namespaces are searchable.
2548 &$arr: Array of namespaces ($nsId => $name) which will be used.
2550 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2551 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2553 $term: Search term string
2554 &$title: Outparam; set to $title object and return false for a match
2556 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2557 if nothing was found.
2558 $term: Search term string
2559 &$title: Outparam; set to $title object and return false for a match
2561 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2562 the normal operations.
2563 $allSearchTerms: Array of the search terms in all content languages
2564 &$titleResult: Outparam; the value to return. A Title object or null.
2566 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2568 $term: Search term string
2569 &$title: Current Title object that is being returned (null if none found).
2571 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2573 $title: Current Title object being displayed in search results.
2574 &$id: Revision ID (default is false, for latest)
2576 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2577 perform when page content is modified. Currently called by
2578 AbstractContent::getSecondaryDataUpdates.
2579 $title: Title of the page that is being edited.
2580 $oldContent: Content object representing the page's content before the edit.
2581 $recursive: bool indicating whether DataUpdates should trigger recursive
2582 updates (relevant mostly for LinksUpdate).
2583 $parserOutput: ParserOutput representing the rendered version of the page
2585 &$updates: a list of DataUpdate objects, to be modified or replaced by
2588 'SecuritySensitiveOperationStatus': Affect the return value from
2589 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2590 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2591 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2592 authentication isn't possible for the current session type.
2593 $operation: (string) The operation being checked.
2594 $session: (MediaWiki\Session\Session) The current session. The
2595 currently-authenticated user may be retrieved as $session->getUser().
2596 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2597 the time of last auth is unknown, or -1 if authentication is not possible.
2599 'SelfLinkBegin': Called before a link to the current article is displayed to
2600 allow the display of the link to be customized.
2601 $nt: the Title object
2602 &$html: html to display for the link
2603 &$trail: optional text to display before $html
2604 &$prefix: optional text to display after $html
2605 &$ret: the value to return if your hook returns false
2607 'SendWatchlistEmailNotification': Return true to send watchlist email
2609 $targetUser: the user whom to send watchlist email notification
2610 $title: the page title
2611 $enotif: EmailNotification object
2613 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2614 loaded from storage. Return false to prevent it from being used.
2615 &$reason: String rejection reason to be logged
2616 $info: MediaWiki\Session\SessionInfo being validated
2617 $request: WebRequest being loaded from
2618 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2619 $data: Array|false Data array for the MediaWiki\Session\Session
2621 'SessionMetadata': Add metadata to a session being saved.
2622 $backend: MediaWiki\Session\SessionBackend being saved.
2623 &$metadata: Array Metadata to be stored. Add new keys here.
2624 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2625 request and 0+ FauxRequests.
2627 'SetupAfterCache': Called in Setup.php, after cache objects are set
2629 'ShortPagesQuery': Allow extensions to modify the query used by
2631 &$tables: tables to join in the query
2632 &$conds: conditions for the query
2633 &$joinConds: join conditions for the query
2634 &$options: options for the query
2636 'ShowMissingArticle': Called when generating the output for a non-existent page.
2637 $article: The article object corresponding to the page
2639 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2640 Customise the output of raw CSS and JavaScript in page views.
2641 $text: Text being shown
2642 $title: Title of the custom script/stylesheet page
2643 $output: Current OutputPage object
2645 'ShowSearchHit': Customize display of search hit.
2646 $searchPage: The SpecialSearch instance.
2647 $result: The SearchResult to show
2648 $terms: Search terms, for highlighting
2649 &$link: HTML of link to the matching page. May be modified.
2650 &$redirect: HTML of redirect info. May be modified.
2651 &$section: HTML of matching section. May be modified.
2652 &$extract: HTML of content extract. May be modified.
2653 &$score: HTML of score. May be modified.
2654 &$size: HTML of page size. May be modified.
2655 &$date: HTML of of page modification date. May be modified.
2656 &$related: HTML of additional info for the matching page. May be modified.
2657 &$html: May be set to the full HTML that should be used to represent the search
2658 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2659 function returned false.
2661 'ShowSearchHitTitle': Customise display of search hit title/link.
2662 &$title: Title to link to
2663 &$text: Text to use for the link
2664 $result: The search result
2665 $terms: The search terms entered
2666 $page: The SpecialSearch object
2667 &$query: Query string to be appended to the link
2669 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2670 Warning: This hook is run on each display. You should consider to use
2671 'SkinBuildSidebar' that is aggressively cached.
2673 &$bar: Sidebar content
2674 Modify $bar to add or modify sidebar portlets.
2676 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2677 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2678 the sitenotice/anonnotice.
2681 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2682 allow the normal method of notice selection/rendering to work, or change the
2683 value of $siteNotice and return false to alter it.
2684 &$siteNotice: HTML returned as the sitenotice
2687 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2689 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2690 the stock bottom scripts.
2692 'SkinAfterContent': Allows extensions to add text after the page content and
2693 article metadata. This hook should work in all skins. Set the &$data variable to
2694 the text you're going to add.
2695 &$data: (string) Text to be printed out directly (without parsing)
2698 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2700 &$bar: Sidebar contents
2701 Modify $bar to add or modify sidebar portlets.
2703 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2705 $title: displayed page title
2706 $type: 'normal' or 'history' for old/diff views
2707 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2708 message must be in HTML format, not wikitext!
2709 &$link: overridable HTML link to be passed into the message as $1
2710 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2713 'SkinEditSectionLinks': Modify the section edit links
2714 $skin: Skin object rendering the UI
2715 $title: Title object for the title being linked to (may not be the same as
2716 the page title, if the section is included from a template)
2717 $section: The designation of the section being pointed to, to be included in
2718 the link, like "§ion=$section"
2719 $tooltip: The default tooltip. Escape before using.
2720 By default, this is wrapped in the 'editsectionhint' message.
2721 &$result: Array containing all link detail arrays. Each link detail array should
2722 contain the following keys:
2723 - targetTitle - Target Title object
2724 - text - String for the text
2725 - attribs - Array of attributes
2726 - query - Array of query parameters to add to the URL
2727 - options - Array of options for Linker::link
2728 $lang: The language code to use for the link in the wfMessage function
2730 'SkinGetPoweredBy': TODO
2731 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2732 the MediaWiki icon but plain text instead.
2735 'SkinPreloadExistence': Supply titles that should be added to link existence
2736 cache before the page is rendered.
2737 &$titles: Array of Title objects
2740 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2741 If false is returned $subpages will be used instead of the HTML
2742 subPageSubtitle() generates.
2743 If true is returned, $subpages will be ignored and the rest of
2744 subPageSubtitle() will run.
2745 &$subpages: Subpage links HTML
2747 $out: OutputPage object
2749 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2751 &$sktemplate: SkinTemplate object
2752 &$nav_urls: array of tabs
2753 &$revid: The revision id of the permanent link
2754 &$revid2: The revision id of the permanent link, second time
2756 'SkinTemplateGetLanguageLink': After building the data for a language link from
2757 which the actual html is constructed.
2758 &$languageLink: array containing data about the link. The following keys can be
2759 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2760 $languageLinkTitle: Title object belonging to the external language link.
2761 $title: Title object of the page the link belongs to.
2762 $outputPage: The OutputPage object the links are built from.
2764 'SkinTemplateNavigation': Called on content pages after the tabs have been
2765 added, but before variants have been added.
2766 &$sktemplate: SkinTemplate object
2767 &$links: Structured navigation links. This is used to alter the navigation for
2768 skins which use buildNavigationUrls such as Vector.
2770 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2771 tab is added but before variants have been added.
2772 &$sktemplate: SkinTemplate object
2773 &$links: Structured navigation links. This is used to alter the navigation for
2774 skins which use buildNavigationUrls such as Vector.
2776 'SkinTemplateNavigation::Universal': Called on both content and special pages
2777 after variants have been added.
2778 &$sktemplate: SkinTemplate object
2779 &$links: Structured navigation links. This is used to alter the navigation for
2780 skins which use buildNavigationUrls such as Vector.
2782 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2784 &$sktemplate: SkinTemplate object
2785 &$tpl: QuickTemplate engine object
2787 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2788 &$sktemplate: SkinTemplate object
2789 &$res: set to true to prevent active tabs
2791 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2792 You can either create your own array, or alter the parameters for
2794 &$sktemplate: The SkinTemplate instance.
2795 $title: Title instance for the page.
2796 $message: Visible label of tab.
2797 $selected: Whether this is a selected tab.
2798 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2799 &$classes: Array of CSS classes to apply.
2800 &$query: Query string to add to link.
2802 &$result: Complete assoc. array if you want to return true.
2804 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2805 been rendered (useful for adding more).
2806 &$sk: The QuickTemplate based skin template running the hook.
2807 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2808 extensions that add support for BaseTemplateToolbox should watch for this
2809 dummy parameter with "$dummy=false" in their code and return without echoing
2810 any HTML to avoid creating duplicate toolbox items.
2812 'SoftwareInfo': Called by Special:Version for returning information about the
2814 &$software: The array of software in format 'name' => 'version'. See
2815 SpecialVersion::softwareInformation().
2817 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2818 $sp: SpecialPage object, for context
2819 &$fields: Current HTMLForm fields
2821 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2822 $id: User id number, only provided for backwards-compatibility
2823 $user: User object representing user contributions are being fetched for
2824 $sp: SpecialPage instance, providing context
2826 'SpecialContributions::getForm::filters': Called with a list of filters to render
2827 on Special:Contributions.
2828 $sp: SpecialContributions object, for context
2829 &$filters: List of filters rendered as HTML
2831 'SpecialListusersDefaultQuery': Called right before the end of
2832 UsersPager::getDefaultQuery().
2833 $pager: The UsersPager instance
2834 &$query: The query array to be returned
2836 'SpecialListusersFormatRow': Called right before the end of
2837 UsersPager::formatRow().
2838 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2839 $row: Database row object
2841 'SpecialListusersHeader': Called before closing the <fieldset> in
2842 UsersPager::getPageHeader().
2843 $pager: The UsersPager instance
2844 &$out: The header HTML
2846 'SpecialListusersHeaderForm': Called before adding the submit button in
2847 UsersPager::getPageHeader().
2848 $pager: The UsersPager instance
2849 &$out: The header HTML
2851 'SpecialListusersQueryInfo': Called right before the end of.
2852 UsersPager::getQueryInfo()
2853 $pager: The UsersPager instance
2854 &$query: The query array to be returned
2856 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2857 $type: String of the log type
2858 $request: WebRequest object for getting the value provided by the current user
2859 &$qc: Array for query conditions to add
2861 'SpecialMovepageAfterMove': Called after moving a page.
2862 &$movePage: MovePageForm object
2863 &$oldTitle: old title (object)
2864 &$newTitle: new title (object)
2866 'SpecialNewpagesConditions': Called when building sql query for
2868 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2869 $opts: FormOptions object containing special page options
2870 &$conds: array of WHERE conditionals for query
2871 &$tables: array of tables to be queried
2872 &$fields: array of columns to select
2873 &$join_conds: join conditions for the tables
2875 'SpecialNewPagesFilters': Called after building form options at NewPages.
2876 $special: the special page object
2877 &$filters: associative array of filter definitions. The keys are the HTML
2878 name/URL parameters. Each key maps to an associative array with a 'msg'
2879 (message key) and a 'default' value.
2881 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
2882 this hook to remove a core special page or conditionally register special pages.
2883 &$list: list (array) of core special pages
2885 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2886 $special: the SpecialPage object
2887 $subPage: the subpage string or null if no subpage was specified
2889 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2890 Return false to prevent execution.
2891 $special: the SpecialPage object
2892 $subPage: the subpage string or null if no subpage was specified
2894 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2895 $name: name of the special page
2896 &$form: HTMLForm object
2898 'SpecialPasswordResetOnSubmit': When executing a form submission on
2899 Special:PasswordReset.
2900 &$users: array of User objects.
2901 $data: array of data submitted by the user
2902 &$error: string, error code (message key) used to describe to error (out
2903 parameter). The hook needs to return false when setting this, otherwise it
2904 will have no effect.
2906 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2907 use this to change some selection criteria or substitute a different title.
2908 &$randstr: The random number from wfRandom()
2909 &$isRedir: Boolean, whether to select a redirect or non-redirect
2910 &$namespaces: An array of namespace indexes to get the title from
2911 &$extra: An array of extra SQL statements
2912 &$title: If the hook returns false, a Title object to use instead of the
2913 result from the normal query
2915 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2917 Called after building form options at RecentChanges.
2918 $special: the special page object
2919 &$filters: associative array of filter definitions. The keys are the HTML
2920 name/URL parameters. Each key maps to an associative array with a 'msg'
2921 (message key) and a 'default' value.
2923 'SpecialRecentChangesPanel': Called when building form options in
2924 SpecialRecentChanges.
2925 &$extraOpts: array of added items, to which can be added
2926 $opts: FormOptions for this request
2928 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
2930 Called when building SQL query for SpecialRecentChanges and
2931 SpecialRecentChangesLinked.
2932 &$conds: array of WHERE conditionals for query
2933 &$tables: array of tables to be queried
2934 &$join_conds: join conditions for the tables
2935 $opts: FormOptions for this request
2936 &$query_options: array of options for the database request
2937 &$select: Array of columns to select
2939 'SpecialResetTokensTokens': Called when building token list for
2941 &$tokens: array of token information arrays in the format of
2943 'preference' => '<preference-name>',
2944 'label-message' => '<message-key>',
2947 'SpecialSearchCreateLink': Called when making the message to create a page or
2948 go to the existing page.
2949 $t: title object searched for
2950 &$params: an array of the default message name and page title (as parameter)
2952 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
2953 canceled and a normal search will be performed. Returning true without setting
2954 $url does a standard redirect to $title. Setting $url redirects to the
2956 $term - The string the user searched for
2957 $title - The title the 'go' feature has decided to forward the user to
2958 &$url - Initially null, hook subscribers can set this to specify the final url to redirect to
2960 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2961 target doesn't exist.
2962 &$title: title object generated from the text entered by the user
2964 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2965 the advanced form, a.k.a. power search box.
2966 &$showSections: an array to add values with more options to
2967 $term: the search term (not a title object)
2968 $opts: an array of hidden options (containing 'redirs' and 'profile')
2970 'SpecialSearchProfileForm': Allows modification of search profile forms.
2971 $search: special page object
2972 &$form: String: form html
2973 $profile: String: current search profile
2974 $term: String: search term
2975 $opts: Array: key => value of hidden options for inclusion in custom forms
2977 'SpecialSearchProfiles': Allows modification of search profiles.
2978 &$profiles: profiles, which can be modified.
2980 'SpecialSearchResults': Called before search result display
2981 $term: string of search term
2982 &$titleMatches: empty or SearchResultSet object
2983 &$textMatches: empty or SearchResultSet object
2985 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2986 on the search results page. Useful for including an external search
2987 provider. To disable the output of MediaWiki search output, return
2989 $specialSearch: SpecialSearch object ($this)
2991 $term: Search term specified by the user
2993 'SpecialSearchResultsAppend': Called immediately before returning HTML
2994 on the search results page. Useful for including a feedback link.
2995 $specialSearch: SpecialSearch object ($this)
2997 $term: Search term specified by the user
2999 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3000 $search: SpecialSearch special page object
3001 $profile: String: current search profile
3002 $engine: the search engine
3004 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3005 &$extraStats: Array to save the new stats
3006 $extraStats['<name of statistic>'] => <value>;
3007 <value> can be an array with the keys "name" and "number":
3008 "name" is the HTML to be displayed in the name column
3009 "number" is the number to be displayed.
3010 or, <value> can be the number to be displayed and <name> is the
3011 message key to use in the name column,
3012 $context: IContextSource object
3014 'SpecialUploadComplete': Called after successfully uploading a file from
3016 &$form: The SpecialUpload object
3018 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3019 $wgVersion: Current $wgVersion for you to use
3020 &$versionUrl: Raw url to link to (eg: release notes)
3022 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3024 Called after building form options at Watchlist.
3025 $special: the special page object
3026 &$filters: associative array of filter definitions. The keys are the HTML
3027 name/URL parameters. Each key maps to an associative array with a 'msg'
3028 (message key) and a 'default' value.
3030 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3031 SpecialWatchlist. Allows extensions to register custom values they have
3032 inserted to rc_type so they can be returned as part of the watchlist.
3033 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3035 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3036 Called when building sql query for SpecialWatchlist.
3037 &$conds: array of WHERE conditionals for query
3038 &$tables: array of tables to be queried
3039 &$join_conds: join conditions for the tables
3040 &$fields: array of query fields
3041 $opts: A FormOptions object with watchlist options for the current request
3043 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3044 URL for a title when we have no other parameters on the URL. Gives a chance for
3045 extensions that alter page view behavior radically to abort that redirect or
3047 $request: WebRequest
3048 $title: Title of the currently found title obj
3049 $output: OutputPage object
3051 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3052 rendered (by ThumbnailImage:toHtml method).
3053 $thumbnail: the ThumbnailImage object
3054 &$attribs: image attribute array
3055 &$linkAttribs: image link attribute array
3057 'TitleArrayFromResult': Called when creating an TitleArray object from a
3059 &$titleArray: set this to an object to override the default object returned
3060 $res: database result used to create the object
3062 'TitleExists': Called when determining whether a page exists at a given title.
3063 $title: The title being tested.
3064 &$exists: Whether the title exists.
3066 'TitleGetEditNotices': Allows extensions to add edit notices
3067 $title: The Title object for the page the edit notices are for
3068 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3069 &$notices: Array of notices. Keys are i18n message keys, values are
3070 parseAsBlock()ed messages.
3072 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3073 that can be applied.
3074 $title: The title in question.
3075 &$types: The types of protection available.
3077 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3078 overriding default behavior for determining if a page exists. If $isKnown is
3079 kept as null, regular checks happen. If it's a boolean, this value is returned
3080 by the isKnown method.
3081 $title: Title object that is being checked
3082 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3084 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3085 Called when determining if a page is a CSS or JS page.
3086 $title: Title object that is being checked
3087 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3088 Hooks may change this value to override the return value of
3089 Title::isCssOrJsPage().
3091 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3092 that this hook is not called for interwiki pages or pages in immovable
3093 namespaces: for these, isMovable() always returns false.
3094 $title: Title object that is being checked
3095 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3096 Hooks may change this value to override the return value of
3099 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3100 Called when determining if a page is a wikitext or should
3101 be handled by separate handler (via ArticleViewCustom).
3102 $title: Title object that is being checked
3103 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3104 Hooks may change this value to override the return value of
3105 Title::isWikitextPage()
3107 'TitleMove': Before moving an article (title).
3110 $user: user who does the move
3112 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3115 $user: user who does the move
3117 'TitleMoveComplete': After moving an article (title), post-commit.
3120 &$user: user who did the move
3121 $pageid: database ID of the page that's been moved
3122 $redirid: database ID of the created redirect
3123 $reason: reason for the move
3124 $revision: the Revision created by the move
3126 'TitleMoveCompleting': After moving an article (title), pre-commit.
3129 $user: user who did the move
3130 $pageid: database ID of the page that's been moved
3131 $redirid: database ID of the created redirect
3132 $reason: reason for the move
3133 $revision: the Revision created by the move
3135 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3136 or override the quick permissions check.
3137 $title: The Title object being accessed
3138 $user: The User performing the action
3139 $action: Action being performed
3140 &$errors: Array of errors
3141 $doExpensiveQueries: Whether to do expensive DB queries
3142 $short: Whether to return immediately on first error
3144 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3145 adding the default error message if nothing allows the user to read the page. If
3146 a handler wants a title to *not* be whitelisted, it should also return false.
3147 $title: Title object being checked against
3148 $user: Current user object
3149 &$whitelisted: Boolean value of whether this title is whitelisted
3151 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3152 $title: Title object to purge
3153 &$urls: An array of URLs to purge from the caches, to be manipulated.
3155 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3156 PageArchive object has been created but before any further processing is done.
3157 &$archive: PageArchive object
3158 $title: Title object of the page that we're viewing
3160 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3161 PageArchive object has been created but before any further processing is done.
3162 &$archive: PageArchive object
3163 $title: Title object of the page that we're viewing
3165 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3166 the site is not in read-only mode, that the Title object is not null and after
3167 a PageArchive object has been constructed but before performing any further
3169 &$archive: PageArchive object
3170 $title: Title object of the page that we're about to undelete
3172 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3173 $title: title object related to the revision
3174 $rev: revision (object) that will be viewed
3176 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3177 Since 1.24: Paths pointing to a directory will be recursively scanned for
3178 test case files matching the suffix "Test.php".
3179 &$paths: list of test cases and directories to search.
3181 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3183 $action: action name
3184 $article: article "acted on"
3186 'UnwatchArticle': Before a watch is removed from an article.
3187 &$user: user watching
3188 &$page: WikiPage object to be removed
3189 &$status: Status object to be returned if the hook returns false
3191 'UnwatchArticleComplete': After a watch is removed from an article.
3192 $user: user that watched
3193 &$page: WikiPage object that was watched
3195 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3196 &$formattedPageStatus: list of valid page states
3198 'UploadComplete': Upon completion of a file upload.
3199 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3200 $uploadBase->getLocalFile().
3202 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3203 $type: (string) the requested upload type
3204 &$className: the class name of the Upload instance to be created
3206 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3207 poke at member variables like $mUploadDescription before the file is saved. Do
3208 not use this hook to break upload processing. This will return the user to a
3209 blank form with no error message; use UploadVerification and UploadVerifyFile
3211 &$form: UploadForm object
3213 'UploadForm:initial': Before the upload form is generated. You might set the
3214 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3215 text (HTML) either before or after the editform.
3216 &$form: UploadForm object
3218 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3220 &$descriptor: (array) the HTMLForm descriptor
3222 'UploadFormSourceDescriptors': after the standard source inputs have been
3223 added to the descriptor
3224 &$descriptor: (array) the HTMLForm descriptor
3225 &$radio: Boolean, if source type should be shown as radio button
3226 $selectedSourceType: The selected source type
3228 'UploadVerification': Additional chances to reject an uploaded file. Consider
3229 using UploadVerifyFile instead.
3230 $saveName: (string) destination file name
3231 $tempName: (string) filesystem path to the temporary file for checks
3232 &$error: (string) output: message key for message to show if upload canceled by
3233 returning false. May also be an array, where the first element is the message
3234 key and the remaining elements are used as parameters to the message.
3236 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3237 in most cases over UploadVerification.
3238 $upload: (object) an instance of UploadBase, with all info about the upload
3239 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3240 Handlers will typically only apply for specific MIME types.
3241 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3242 representing the problem with the file, where the first element is the message
3243 key and the remaining elements are used as parameters to the message.
3245 'UserIsBot': when determining whether a user is a bot account
3247 &$isBot: whether this is user a bot or not (boolean)
3249 'User::mailPasswordInternal': before creation and mailing of a user's new
3251 &$user: the user who sent the message out
3252 &$ip: IP of the user who sent the message out
3253 &$u: the account whose new password will be set
3255 'UserAddGroup': Called when adding a group; return false to override
3256 stock group addition.
3257 $user: the user object that is to have a group added
3258 &$group: the group to add, can be modified
3260 'UserArrayFromResult': Called when creating an UserArray object from a database
3262 &$userArray: set this to an object to override the default object returned
3263 $res: database result used to create the object
3265 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3266 want to display an error message, try getUserPermissionsErrors.
3267 &$title: Title object being checked against
3268 &$user: Current user object
3269 $action: Action being checked
3270 &$result: Pointer to result returned if hook returns false. If null is returned,
3271 userCan checks are continued by internal code.
3273 'UserCanSendEmail': To override User::canSendEmail() permission check.
3274 &$user: User (object) whose permission is being checked
3275 &$canSend: bool set on input, can override on output
3277 'UserClearNewTalkNotification': Called when clearing the "You have new
3278 messages!" message, return false to not delete it.
3279 &$user: User (object) that will clear the message
3280 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3282 'UserCreateForm': change to manipulate the login form
3283 &$template: SimpleTemplate instance for the form
3285 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3286 &$user: User to get groups for
3287 &$groups: Current effective groups
3289 'UserGetAllRights': After calculating a list of all available rights.
3290 &$rights: Array of rights, which may be added to.
3292 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3293 before returning the options to the caller. Warning: This hook is called for
3294 every call to User::getDefaultOptions(), which means it's potentially called
3295 dozens or hundreds of times. You may want to cache the results of non-trivial
3296 operations in your hook function for this reason.
3297 &$defaultOptions: Array of preference keys and their default values.
3299 'UserGetEmail': Called when getting an user email address.
3301 &$email: email, change this to override local email
3303 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3304 email authentication.
3306 &$timestamp: timestamp, change this to override local email authentication
3309 'UserGetImplicitGroups': DEPRECATED!
3310 Called in User::getImplicitGroups().
3311 &$groups: List of implicit (automatically-assigned) groups
3313 'UserGetLanguageObject': Called when getting user's interface language object.
3315 &$code: Language code that will be used to create the object
3316 $context: IContextSource object
3318 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3319 &$reservedUsernames: $wgReservedUsernames
3321 'UserGetRights': Called in User::getRights().
3322 $user: User to get rights for
3323 &$rights: Current rights
3325 'UserGroupsChanged': Called after user groups are changed.
3326 $user: User whose groups changed
3327 $added: Groups added
3328 $removed: Groups removed
3329 $performer: User who performed the change, false if via autopromotion
3330 $reason: The reason, if any, given by the user performing the change,
3331 false if via autopromotion.
3333 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3334 specific block exemptions).
3335 $user: User in question
3336 $title: Title of the page in question
3337 &$blocked: Out-param, whether or not the user is blocked from that page.
3338 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3339 to edit their own user talk pages.
3341 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3343 $ip: User's IP address
3344 &$blocked: Whether the user is blocked, to be modified by the hook
3346 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3347 false if a UserGetRights hook might remove the named right.
3348 $right: The user right being checked
3350 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3351 $user: User in question.
3352 &$hidden: Set true if the user's name should be hidden.
3354 'UserIsLocked': Check if the user is locked. See User::isLocked().
3355 $user: User in question.
3356 &$locked: Set true if the user should be locked.
3358 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3359 environmental means; occurs after session is loaded.
3360 $user: user object being loaded
3362 'UserLoadDefaults': Called when loading a default user.
3366 'UserLoadFromDatabase': Called when loading a user from the database.
3368 &$s: database query object
3370 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3371 Called to authenticate users on external/environmental means; occurs before
3373 $user: user object being loaded
3374 &$result: set this to a boolean value to abort the normal authentication
3377 'UserLoadOptions': When user options/preferences are being loaded from the
3380 &$options: Options, can be modified.
3382 'UserLoggedIn': Called after a user is logged in
3383 $user: User object for the logged-in user
3385 'UserLoginComplete': After a user has logged in.
3386 &$user: the user object that was created on login
3387 &$inject_html: Any HTML to inject after the "logged in" message.
3389 'UserLoginForm': change to manipulate the login form
3390 &$template: SimpleTemplate instance for the form
3392 'UserLogout': Before a user logs out.
3393 &$user: the user object that is about to be logged out
3395 'UserLogoutComplete': After a user has logged out.
3396 &$user: the user object _after_ logout (won't have name, ID, etc.)
3397 &$inject_html: Any HTML to inject after the "logged out" message.
3398 $oldName: name of the user before logout (string)
3400 'UserMailerChangeReturnPath': Called to generate a VERP return address
3401 when UserMailer sends an email, with a bounce handling extension.
3402 $to: Array of MailAddress objects for the recipients
3403 &$returnPath: The return address string
3405 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3406 to split up an email with multiple the To: field into separate emails.
3407 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3409 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3410 Extensions can block sending the email by returning false and setting $error.
3411 $to: array of MailAdresses of the targets
3412 $from: MailAddress of the sender
3413 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3414 &$error: should be set to an error message string
3416 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3417 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3418 $to: array of MailAdresses of the targets
3419 $from: MailAddress of the sender
3420 &$subject: email subject (not MIME encoded)
3421 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3422 &$body: email body (in MIME format) as a string
3423 &$error: should be set to an error message string
3425 'UserRemoveGroup': Called when removing a group; return false to override stock
3427 $user: the user object that is to have a group removed
3428 &$group: the group to be removed, can be modified
3430 'UserRequiresHTTPS': Called to determine whether a user needs
3431 to be switched to HTTPS.
3432 $user: User in question.
3433 &$https: Boolean whether $user should be switched to HTTPS.
3435 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3436 have been requested to be reset. This hook can be used to exclude certain
3437 options from being reset even when the user has requested all prefs to be reset,
3438 because certain options might be stored in the user_properties database table
3439 despite not being visible and editable via Special:Preferences.
3440 $user: the User (object) whose preferences are being reset
3441 &$newOptions: array of new (site default) preferences
3442 $options: array of the user's old preferences
3443 $resetKinds: array containing the kinds of preferences to reset
3445 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3447 &$user: user retrieving new talks messages
3448 &$talks: array of new talks page(s)
3450 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3451 After a user's group memberships are changed.
3452 &$user: User object that was changed
3453 $add: Array of strings corresponding to groups added
3454 $remove: Array of strings corresponding to groups removed
3456 'UserSaveOptions': Called just before saving user preferences/options.
3458 &$options: Options, modifiable
3460 'UserSaveSettings': Called when saving user settings.
3463 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3464 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3465 instead. Otherwise, you can no longer count on user data being saved to cookies
3466 versus some other mechanism.
3467 Called when setting user cookies.
3469 &$session: session array, will be added to the session
3470 &$cookies: cookies array mapping cookie name to its value
3472 'UserSetEmail': Called when changing user email address.
3474 &$email: new email, change this to override new email address
3476 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3477 email authentication.
3479 &$timestamp: new timestamp, change this to override local email
3480 authentication timestamp
3482 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3483 "Foobar (Talk | Contribs | Block)".
3484 $userId: User id of the current user
3485 $userText: User name of the current user
3486 &$items: Array of user tool links as HTML fragments
3488 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3489 FormatMetadata::getExtendedMeta (return false means cache will be
3490 invalidated and GetExtendedMetadata hook called again).
3491 $timestamp: The timestamp metadata was generated
3492 $file: The file the metadata is for
3494 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3495 used to alter the SQL query which gets the list of wanted pages.
3496 &$wantedPages: WantedPagesPage object
3497 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3499 'WatchArticle': Before a watch is added to an article.
3500 &$user: user that will watch
3501 &$page: WikiPage object to be watched
3502 &$status: Status object to be returned if the hook returns false
3504 'WatchArticleComplete': After a watch is added to an article.
3505 &$user: user that watched
3506 &$page: WikiPage object watched
3508 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3509 form, used to manipulate the list of pages or preload data based on that list.
3510 &$watchlistInfo: array of watchlisted pages in
3511 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3513 'WatchlistEditorBuildRemoveLine': when building remove lines in
3514 Special:Watchlist/edit.
3515 &$tools: array of extra links
3516 $title: Title object
3517 $redirect: whether the page is a redirect
3519 &$link: HTML link to title
3521 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3523 $router: The PathRouter instance
3525 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3526 Return false to prevent setting of the cookie.
3527 &$name: Cookie name passed to WebResponse::setcookie()
3528 &$value: Cookie value passed to WebResponse::setcookie()
3529 &$expire: Cookie expiration, as for PHP's setcookie()
3530 &$options: Options passed to WebResponse::setcookie()
3532 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3533 run a MediaWiki cli script.
3534 &$script: MediaWiki cli script path
3535 &$parameters: Array of arguments and options to the script
3536 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3539 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3540 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3541 &$qp: The list of QueryPages
3543 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3544 $row: The DB row of the entry.
3545 $title: The Title of the page where the link comes FROM
3546 $target: The Title of the page where the link goes TO
3547 &$props: Array of HTML strings to display after the title.
3549 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3550 dumps. One, and only one hook should set this, and return false.
3551 &$tables: Database tables to use in the SELECT query
3552 &$opts: Options to use for the query
3553 &$join: Join conditions
3555 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3556 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3557 specific to a content model should be provided by the respective Content's
3558 getDeletionUpdates() method.
3560 $content: the Content to generate updates for
3561 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3563 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3564 extra metadata to be added.
3565 $obj: The XmlDumpWriter object.
3566 &$out: The output string.
3567 $row: The database row for the page.
3568 $title: The title of the page.
3570 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3572 &$obj: The XmlDumpWriter object.
3573 &$out: The text being output.
3574 $row: The database row for the revision.
3575 $text: The revision text.
3577 More hooks might be available but undocumented, you can execute
3578 "php maintenance/findHooks.php" to find hidden ones.