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