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 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
193 function ldapLogin( $username, $password ) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the Hooks::run() function to run the hooks
208 related to a particular event, like so:
214 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
215 # protect the article
216 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
221 Hooks::run() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Hooks::run() was added in MediaWiki 1.18, before that the global function
227 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
229 Note that hook parameters are passed in an array; this is a necessary
230 inconvenience to make it possible to pass reference values (that can be changed)
231 into the hook code. Also note that earlier versions of wfRunHooks took a
232 variable number of arguments; the array() calling protocol came about after
235 ==Events and parameters==
237 This is a list of known events and parameters; please add to it if you're going
238 to add events to the MediaWiki code.
240 'AbortAutoAccount': Return false to cancel automated local account creation,
241 where normally authentication against an external auth plugin would be creating
243 $user: the User object about to be created (read-only, incomplete)
244 &$abortMsg: out parameter: name of error message to be displayed to user
246 'AbortAutoblock': Return false to cancel an autoblock.
247 $autoblockip: The IP going to be autoblocked.
248 &$block: The block from which the autoblock is coming.
250 'AbortChangePassword': Return false to cancel password change.
251 $user: the User object to which the password change is occuring
252 $mOldpass: the old password provided by the user
253 $newpass: the new password provided by the user
254 &$abortMsg: the message identifier for abort reason
256 'AbortDiffCache': Can be used to cancel the caching of a diff.
257 &$diffEngine: DifferenceEngine object
259 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
260 $editor: The User who made the change.
261 $title: The Title of the page that was edited.
262 $rc: The current RecentChange object.
264 'AbortLogin': Return false to cancel account login.
265 $user: the User object being authenticated against
266 $password: the password being submitted, not yet checked for validity
267 &$retval: a LoginForm class constant to return from authenticateUserData();
268 default is LoginForm::ABORTED. Note that the client may be using a machine
269 API rather than the HTML user interface.
270 &$msg: the message identifier for abort reason (new in 1.18, not available
273 'AbortNewAccount': Return false to cancel explicit account creation.
274 $user: the User object about to be created (read-only, incomplete)
275 &$msg: out parameter: HTML to display on abort
276 &$status: out parameter: Status object to return, replaces the older $msg param
278 Create the object with Status::newFatal() to ensure proper API error
279 messages are returned when creating account through API clients.
281 'AbortTalkPageEmailNotification': Return false to cancel talk page email
283 $targetUser: the user whom to send talk page email notification
284 $title: the page title
286 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
287 $name: name of the action
288 &$form: HTMLForm object
289 $article: Article object
291 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
292 Allows to change the fields on the form that will be generated.
293 $name: name of the action
294 &$fields: HTMLForm descriptor array
295 $article: Article object
297 'AddNewAccount': After a user account is created.
298 $user: the User object that was created. (Parameter added in 1.7)
299 $byEmail: true when account was created "by email" (added in 1.12)
301 'AddNewAccountApiForm': Allow modifying internal login form when creating an
303 $apiModule: the ApiCreateAccount module calling
304 $loginForm: the LoginForm used
306 'AddNewAccountApiResult': Modify API output when creating a new account via API.
307 $apiModule: the ApiCreateAccount module calling
308 $loginForm: the LoginForm used
309 &$result: associative array for API result data
311 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
312 before OutputPage::sendCacheControl() and final ob_end_flush() which
313 will send the buffered output to the client. This allows for last-minute
314 modification of the output within the buffer by using ob_get_clean().
315 $output: The OutputPage object where output() was called
317 'AfterImportPage': When a page import is completed.
318 $title: Title under which the revisions were imported
319 $foreignTitle: ForeignTitle object based on data provided by the XML file
320 $revCount: Number of revisions in the XML file
321 $sRevCount: Number of successfully imported revisions
322 $pageInfo: associative array of page information
324 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
325 just before adding its HTML to parser output.
326 $parser: Parser object that called the hook
327 $ig: Gallery, an object of one of the gallery classes (inheriting from
329 &$html: HTML generated by the gallery
331 'AlternateEdit': Before checking if a user can edit a page and before showing
332 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
333 $editPage: the EditPage object
335 'AlternateEditPreview': Before generating the preview of the page when editing
336 ( EditPage::getPreviewText() ).
337 Return false and set $previewHTML and $parserOutput to output custom page
339 $editPage: the EditPage object
340 &$content: the Content object for the text field from the edit page
341 &$previewHTML: Text to be placed into the page for the preview
342 &$parserOutput: the ParserOutput object for the preview
344 'AlternateUserMailer': Called before mail is sent so that mail could be logged
345 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
346 the regular method of sending mail. Return a string to return a php-mail-error
347 message containing the error. Returning true will continue with sending email
349 $headers: Associative array of headers for the email
350 $to: MailAddress object or array
352 $subject: Subject of the email
353 $body: Body of the message
355 'APIAfterExecute': After calling the execute() method of an API module. Use
356 this to extend core API modules.
357 &$module: Module object
359 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
360 &$main: ApiMain object
362 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
363 authenticate and authorize API clients before executing the module. Return
364 false and set a message to cancel the request.
365 $module: Module object
367 &$message: API usage message to die with, as a message key or array
368 as accepted by ApiBase::dieUsageMsg.
370 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
371 processing request parameters. Return false to let the request fail, returning
372 an error message or an <edit result="Failure"> tag if $resultArr was filled.
373 $editPage: the EditPage object
374 $text: the new text of the article (has yet to be saved)
375 &$resultArr: data in this array will be added to the API result
377 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
378 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
379 this hook may cancel the hook to signal that the item is not viewable in the
381 $row: A row of data from ContribsPager. The set of data returned by
382 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
384 $context: An IContextSource implementation.
385 &$feedItem: Set this to a FeedItem instance if the callback can handle the
386 provided row. This is provided to the hook as a null, if it is non null then
387 another callback has already handled the hook.
389 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
390 highlighting, add output to $context->getOutput() and return false.
391 $context: An IContextSource.
392 $text: Text to be highlighted.
393 $mime: MIME type of $text.
394 $format: API format code for $text.
396 'APIGetAllowedParams': Use this hook to modify a module's parameters.
397 &$module: ApiBase Module object
398 &$params: Array of parameters
399 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
401 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
402 Use this hook to modify a module's description.
403 &$module: ApiBase Module object
404 &$desc: String description, or array of description strings
406 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
407 $module: ApiBase Module object
408 &$msg: Array of Message objects
410 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
412 Use this hook to modify a module's parameter descriptions.
413 &$module: ApiBase Module object
414 &$desc: Array of parameter descriptions
416 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
418 $module: ApiBase Module object
419 &$msg: Array of arrays of Message objects
421 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
422 $module: ApiBase Module object
423 &$help: Array of HTML strings to be joined for the output.
424 $options: Array Options passed to ApiHelp::getHelp
425 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
426 the page and values as for Linker::generateTOC().
428 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
429 module manager. Can be used to conditionally register API modules.
430 $moduleManager: ApiModuleManager Module manager instance
432 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
433 an exception is thrown during API action execution.
434 $apiMain: Calling ApiMain instance.
435 $e: Exception object.
437 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
438 can alter or append to the array.
439 &$results: array with integer keys to associative arrays. Keys in associative
441 - title: Title object.
442 - redirect from: Title or null.
443 - extract: Description for this result.
444 - extract trimmed: If truthy, the extract will not be trimmed to
445 $wgOpenSearchDescriptionLength.
446 - image: Thumbnail for this result. Value is an array with subkeys 'source'
447 (url), 'width', 'height', 'alt', 'align'.
448 - url: Url for the given title.
450 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
451 module manager. Can be used to conditionally register API query modules.
452 $moduleManager: ApiModuleManager Module manager instance
454 'APIQueryAfterExecute': After calling the execute() method of an
455 action=query submodule. Use this to extend core API modules.
456 &$module: Module object
458 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
459 an action=query submodule. Use this to extend core API modules.
460 &$module: Module object
461 &$resultPageSet: ApiPageSet object
463 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
464 Use this hook to add custom tokens to prop=info. Every token has an action,
465 which will be used in the intoken parameter and in the output
466 (actiontoken="..."), and a callback function which should return the token, or
467 false if the user isn't allowed to obtain it. The prototype of the callback
468 function is func($pageid, $title), where $pageid is the page ID of the page the
469 token is requested for and $title is the associated Title object. In the hook,
470 just add your callback to the $tokenFunctions array and return true (returning
471 false makes no sense).
472 &$tokenFunctions: array(action => callback)
474 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
476 Use this hook to add custom tokens to list=recentchanges. Every token has an
477 action, which will be used in the rctoken parameter and in the output
478 (actiontoken="..."), and a callback function which should return the token, or
479 false if the user isn't allowed to obtain it. The prototype of the callback
480 function is func($pageid, $title, $rc), where $pageid is the page ID of the
481 page associated to the revision the token is requested for, $title the
482 associated Title object and $rc the associated RecentChange object. In the
483 hook, just add your callback to the $tokenFunctions array and return true
484 (returning false makes no sense).
485 &$tokenFunctions: array(action => callback)
487 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
488 Use this hook to add custom tokens to prop=revisions. Every token has an
489 action, which will be used in the rvtoken parameter and in the output
490 (actiontoken="..."), and a callback function which should return the token, or
491 false if the user isn't allowed to obtain it. The prototype of the callback
492 function is func($pageid, $title, $rev), where $pageid is the page ID of the
493 page associated to the revision the token is requested for, $title the
494 associated Title object and $rev the associated Revision object. In the hook,
495 just add your callback to the $tokenFunctions array and return true (returning
496 false makes no sense).
497 &$tokenFunctions: array(action => callback)
499 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
500 sites general information.
501 $module: the current ApiQuerySiteInfo module
502 &$results: array of results, add things here
504 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
505 sites statistics information.
506 &$results: array of results, add things here
508 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
509 action=query&meta=tokens. Note that most modules will probably be able to use
510 the 'csrf' token instead of creating their own token types.
511 &$salts: array( type => salt to pass to User::getEditToken() )
513 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
514 Use this hook to add custom token to list=users. Every token has an action,
515 which will be used in the ustoken parameter and in the output
516 (actiontoken="..."), and a callback function which should return the token, or
517 false if the user isn't allowed to obtain it. The prototype of the callback
518 function is func($user) where $user is the User object. In the hook, just add
519 your callback to the $tokenFunctions array and return true (returning false
521 &$tokenFunctions: array(action => callback)
523 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
524 should have its own entry in the $apis array and have a unique name, passed as
525 key for the array that represents the service data. In this data array, the
526 key-value-pair identified by the apiLink key is required.
527 &$apis: array of services
529 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
530 Use this hook to extend action=tokens with new token types.
531 &$tokenTypes: supported token types in format 'type' => callback function
532 used to retrieve this type of tokens.
534 'Article::MissingArticleConditions': Before fetching deletion & move log entries
535 to display a message of a non-existing page being deleted/moved, give extensions
536 a chance to hide their (unrelated) log entries.
537 &$conds: Array of query conditions (all of which have to be met; conditions will
538 AND in the final query)
539 $logTypes: Array of log types being queried
541 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
543 After fetching content of an article from the database.
544 &$article: the article (object) being loaded from the database
545 &$content: the content (string) of the article
547 'ArticleAfterFetchContentObject': After fetching content of an article from the
549 &$article: the article (object) being loaded from the database
550 &$content: the content of the article, as a Content object
552 'ArticleConfirmDelete': Before writing the confirmation form for article
554 $article: the article (object) being deleted
555 $output: the OutputPage object
556 &$reason: the reason (string) the article is being deleted
558 'ArticleContentOnDiff': Before showing the article content below a diff. Use
559 this to change the content in this area or how it is loaded.
560 $diffEngine: the DifferenceEngine
561 $output: the OutputPage object
563 'ArticleContentViewCustom': Allows to output the text of the article in a
564 different format than wikitext. Note that it is preferable to implement proper
565 handing for a custom data type using the ContentHandler facility.
566 $content: content of the page, as a Content object
567 $title: title of the page
568 $output: reference to $wgOut
570 'ArticleDelete': Before an article is deleted.
571 &$wikiPage: the WikiPage (object) being deleted
572 &$user: the user (object) deleting the article
573 &$reason: the reason (string) the article is being deleted
574 &$error: if the deletion was prohibited, the (raw HTML) error message to display
576 &$status: Status object, modify this to throw an error. Overridden by $error
578 $suppress: Whether this is a suppression deletion or not (added in 1.27)
580 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
581 $title: Title of the article that has been deleted.
582 $outputPage: OutputPage that can be used to append the output.
584 'ArticleDeleteComplete': After an article is deleted.
585 &$wikiPage: the WikiPage that was deleted
586 &$user: the user that deleted the article
587 $reason: the reason the article was deleted
588 $id: id of the article that was deleted
589 $content: the Content of the deleted page
590 $logEntry: the ManualLogEntry used to record the deletion
592 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
594 &$wikiPage: WikiPage (object) of the user talk page
595 $recipient: User (object) who's talk page was edited
597 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
598 article has been changed.
599 &$wikiPage: the WikiPage (object)
600 &$editInfo: data holder that includes the parser output ($editInfo->output) for
601 that page after the change
602 $changed: bool for if the page was changed
604 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
605 recentchanges table, return false to not delete old entries.
606 &$wikiPage: WikiPage (object) being modified
608 'ArticleFromTitle': when creating an article object from a title object using
609 Wiki::articleFromTitle().
610 &$title: Title (object) used to create the article object
611 &$article: Article (object) that will be returned
612 $context: IContextSource (object)
614 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
615 After a new article is created.
616 $wikiPage: WikiPage created
617 $user: User creating the article
619 $summary: Edit summary/comment
620 $isMinor: Whether or not the edit was marked as minor
621 $isWatch: (No longer used)
622 $section: (No longer used)
623 $flags: Flags passed to WikiPage::doEditContent()
624 $revision: New Revision of the article
626 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
627 $targetTitle: target title (object)
628 $destTitle: destination title (object)
630 'ArticlePageDataAfter': After loading data of an article from the database.
631 &$wikiPage: WikiPage (object) whose data were loaded
632 &$row: row (object) returned from the database server
634 'ArticlePageDataBefore': Before loading data of an article from the database.
635 &$wikiPage: WikiPage (object) that data will be loaded
636 &$fields: fields (array) to load from the database
638 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
639 $wikiPage: the WikiPage being saved
640 $popts: parser options to be used for pre-save transformation
642 'ArticleProtect': Before an article is protected.
643 &$wikiPage: the WikiPage being protected
644 &$user: the user doing the protection
645 $protect: Set of restriction keys
646 $reason: Reason for protect
648 'ArticleProtectComplete': After an article is protected.
649 &$wikiPage: the WikiPage that was protected
650 &$user: the user who did the protection
651 $protect: Set of restriction keys
652 $reason: Reason for protect
654 'ArticlePurge': Before executing "&action=purge".
655 &$wikiPage: WikiPage (object) to purge
657 'ArticleRevisionUndeleted': After an article revision is restored.
658 &$title: the article title
659 $revision: the revision
660 $oldPageID: the page ID of the revision when archived (may be null)
662 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
663 revisions of an article.
664 $title: Title object of the article
665 $ids: Ids to set the visibility for
667 'ArticleRollbackComplete': After an article rollback is completed.
668 $wikiPage: the WikiPage that was edited
669 $user: the user who did the rollback
670 $revision: the revision the page was reverted back to
671 $current: the reverted revision
673 'ArticleSave': DEPRECATED! Use PageContentSave instead.
674 Before an article is saved.
675 $wikiPage: the WikiPage (object) being saved
676 $user: the user (object) saving the article
677 $text: the new article text
678 $summary: the article summary (comment)
683 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
684 After an article has been updated.
685 $wikiPage: WikiPage modified
686 $user: User performing the modification
688 $summary: Edit summary/comment
689 $isMinor: Whether or not the edit was marked as minor
690 $isWatch: (No longer used)
691 $section: (No longer used)
692 $flags: Flags passed to WikiPage::doEditContent()
693 $revision: New Revision of the article
694 $status: Status object about to be returned by doEditContent()
695 $baseRevId: the rev ID (or false) this edit was based on
697 'ArticleUndelete': When one or more revisions of an article are restored.
698 &$title: Title corresponding to the article restored
699 $create: Whether or not the restoration caused the page to be created (i.e. it
700 didn't exist before).
701 $comment: The comment associated with the undeletion.
702 $oldPageId: ID of page previously deleted (from archive table)
704 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
705 $pageArchive: the PageArchive object
706 &$logEntry: ManualLogEntry object
707 $user: User who is performing the log action
709 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
710 the user is redirected back to the page.
711 $article: the article
712 &$sectionanchor: The section anchor link (e.g. "#overview" )
713 &$extraq: Extra query parameters which can be added via hooked functions
715 'ArticleViewCustom': DEPRECATED! Use ArticleContentViewCustom instead.
716 Allows to output the text of the article in a different format than wikitext.
717 Note that it is preferable to implement proper handing for a custom data type
718 using the ContentHandler facility.
719 $text: text of the page
720 $title: title of the page
721 $output: reference to $wgOut
723 'ArticleViewFooter': After showing the footer section of an ordinary page view
724 $article: Article object
725 $patrolFooterShown: boolean whether patrol footer is shown
727 'ArticleViewHeader': Before the parser cache is about to be tried for article
729 &$article: the article
730 &$pcache: whether to try the parser cache or not
731 &$outputDone: whether the output for this page finished or not. Set to
732 a ParserOutput object to both indicate that the output is done and what
733 parser output was used.
735 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
736 redirect was followed.
737 &$article: target article (object)
739 'AuthPluginAutoCreate': Called when creating a local account for an user logged
740 in from an external authentication method.
741 $user: User object created locally
743 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
744 Gives a chance for an extension to set it programmatically to a variable class.
745 &$auth: the $wgAuth object, probably a stub
747 'AutopromoteCondition': Check autopromote condition for user.
748 $type: condition type
751 &$result: result of checking autopromote condition
753 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
754 certain title are fetched.
756 $title: title of the page to which backlinks are sought
757 &$conds: query conditions
759 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
763 'BadImage': When checking against the bad image list. Change $bad and return
764 false to override. If an image is "bad", it is not rendered inline in wiki
765 pages or galleries in category pages.
766 $name: Image name being checked
767 &$bad: Whether or not the image is "bad"
769 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
770 custom HTML after the section. Any uses of the hook need to handle escaping.
771 $template: BaseTemplate
772 $portlet: string portlet name
775 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
776 and returning it for the skin to output. You can add items to the toolbox while
777 still letting the skin make final decisions on skin-specific markup conventions
779 &$sk: The BaseTemplate base skin template
780 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
781 BaseTemplate::makeListItem for details on the format of individual items
782 inside of this array.
784 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
785 "noarticletext-nopermission" at Article::showMissingArticle().
786 $article: article object
788 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
789 override how the redirect is output by modifying, or by returning false, and
790 letting standard HTTP rendering take place.
791 ATTENTION: This hook is likely to be removed soon due to overall design of the
793 $context: IContextSource object
794 &$redirect: string URL, modifiable
796 'BeforeInitialize': Before anything is initialized in
797 MediaWiki::performRequest().
798 &$title: Title being used for request
800 &$output: OutputPage object
802 $request: WebRequest object
803 $mediaWiki: Mediawiki object
805 'BeforePageDisplay': Prior to outputting a page.
806 &$out: OutputPage object
809 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
810 override how the redirect is output by modifying, or by returning false and
811 taking over the output.
812 $out: OutputPage object
813 &$redirect: URL, modifiable
814 &$code: HTTP code (eg '301' or '302'), modifiable
816 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
817 $parser: Parser object
819 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
820 as a key then the file will appear as a broken thumbnail.
821 &$descQuery: query string to add to thumbnail URL
823 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
824 $parser: Parser object
825 $title: title of the template
826 &$skip: skip this template and link it?
827 &$id: the id of the revision being parsed
829 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
830 &$parser: Parser object
831 &$ig: ImageGallery object
833 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
835 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
836 to a newly created user account.
837 &$injected_html: Any HTML to inject after the "logged in" message of a newly
840 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
841 normalizations have been performed, except for the $wgMaxImageArea check.
843 &$params: Array of parameters
844 &$checkImageAreaHookResult: null, set to true or false to override the
845 $wgMaxImageArea check result.
847 'BitmapHandlerTransform': before a file is transformed, gives extension the
848 possibility to transform it themselves
849 $handler: BitmapHandler
851 &$scalerParams: Array with scaler parameters
852 &$mto: null, set to a MediaTransformOutput
854 'BlockIp': Before an IP address or user is blocked.
855 &$block: the Block object about to be saved
856 &$user: the user _doing_ the block (not the one being blocked)
857 &$reason: if the hook is aborted, the error message to be returned in an array
859 'BlockIpComplete': After an IP address or user is blocked.
860 $block: the Block object that was saved
861 $user: the user who did the block (not the one being blocked)
863 'BookInformation': Before information output on Special:Booksources.
864 $isbn: ISBN to show information for
865 $output: OutputPage object in use
867 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
868 to be able to access the wiki via HTTPS.
869 $ip: The IP address in human-readable form
870 &$canDo: This reference should be set to false if the client may not be able
873 'CanonicalNamespaces': For extensions adding their own namespaces or altering
875 Note that if you need to specify namespace protection or content model for
876 a namespace that is added in a CanonicalNamespaces hook handler, you
877 should do so by altering $wgNamespaceProtection and
878 $wgNamespaceContentModels outside the handler, in top-level scope. The
879 point at which the CanonicalNamespaces hook fires is too late for altering
880 these variables. This applies even if the namespace addition is
881 conditional; it is permissible to declare a content model and protection
882 for a namespace and then decline to actually register it.
883 &$namespaces: Array of namespace numbers with corresponding canonical names
885 'CategoryAfterPageAdded': After a page is added to a category.
886 $category: Category that page was added to
887 $wikiPage: WikiPage that was added
889 'CategoryAfterPageRemoved': After a page is removed from a category.
890 $category: Category that page was removed from
891 $wikiPage: WikiPage that was removed
893 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
894 &$catpage: CategoryPage instance
896 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
897 in a Category page. Gives extensions the opportunity to batch load any
898 related data about the pages.
899 $type: The category type. Either 'page', 'file' or 'subcat'
900 $res: Query result from DatabaseBase::select()
902 'CategoryViewer::generateLink': Before generating an output link allow
903 extensions opportunity to generate a more specific or relevant link.
904 $type: The category type. Either 'page', 'img' or 'subcat'
905 $title: Title object for the categorized page
906 $html: Requested html content of anchor
907 &$link: Returned value. When set to a non-null value by a hook subscriber
908 this value will be used as the anchor instead of Linker::link
910 'ChangePasswordForm': For extensions that need to add a field to the
911 ChangePassword form via the Preferences form.
912 &$extraFields: An array of arrays that hold fields like would be passed to the
915 'ChangesListInitRows': Batch process change list rows prior to rendering.
916 $changesList: ChangesList instance
917 $rows: The data that will be rendered. May be a ResultWrapper instance or
920 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
921 &$changesList: ChangesList instance.
922 &$articlelink: HTML of link to article (already filled-in).
923 &$s: HTML of row that is being constructed.
924 &$rc: RecentChange instance.
925 $unpatrolled: Whether or not we are showing unpatrolled changes.
926 $watched: Whether or not the change is watched by the user.
928 'ChangesListSpecialPageFilters': Called after building form options on pages
929 inheriting from ChangesListSpecialPage (in core: RecentChanges,
930 RecentChangesLinked and Watchlist).
931 $special: ChangesListSpecialPage instance
932 &$filters: associative array of filter definitions. The keys are the HTML
933 name/URL parameters. Each key maps to an associative array with a 'msg'
934 (message key) and a 'default' value.
936 'ChangesListSpecialPageQuery': Called when building SQL query on pages
937 inheriting from ChangesListSpecialPage (in core: RecentChanges,
938 RecentChangesLinked and Watchlist).
939 $name: name of the special page, e.g. 'Watchlist'
940 &$tables: array of tables to be queried
941 &$fields: array of columns to select
942 &$conds: array of WHERE conditionals for query
943 &$query_options: array of options for the database request
944 &$join_conds: join conditions for the tables
945 $opts: FormOptions for this request
947 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
948 removed from all revisions and log entries to which it was applied). This gives
949 extensions a chance to take it off their books.
950 $tag: name of the tag
951 &$status: Status object. Add warnings to this as required. There is no point
952 setting errors, as the deletion has already been partly carried out by this
955 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
956 from the UI (Special:Tags) or via the API. You could use this hook if you want
957 to reserve a specific "namespace" of tags, or something similar.
958 $tag: name of the tag
959 $user: user initiating the action
960 &$status: Status object. Add your errors using `$status->fatal()` or warnings
961 using `$status->warning()`. Errors and warnings will be relayed to the user.
962 If you set an error, the user will be unable to create the tag.
964 'ChangeTagCanDelete': Tell whether a change tag should be able to be
965 deleted from the UI (Special:Tags) or via the API. The default is that tags
966 defined using the ListDefinedTags hook are not allowed to be deleted unless
967 specifically allowed. If you wish to allow deletion of the tag, set
968 `$status = Status::newGood()` to allow deletion, and then `return false` from
969 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
970 out custom deletion actions.
971 $tag: name of the tag
972 $user: user initiating the action
973 &$status: Status object. See above.
975 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
976 uses are in active use.
977 &$tags: list of all active tags. Append to this array.
979 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
980 $collationName: Name of the collation in question
981 &$collationObject: Null. Replace with a subclass of the Collation class that
982 implements the collation given in $collationName.
984 'ConfirmEmailComplete': Called after a user's email has been confirmed
986 $user: user (object) whose email is being confirmed
988 'ContentAlterParserOutput': Modify parser output for a given content object.
989 Called by Content::getParserOutput after parsing has finished. Can be used
990 for changes that depend on the result of the parsing but have to be done
991 before LinksUpdate is called (such as adding tracking categories based on
993 $content: The Content to render
994 $title: Title of the page, as context
995 $parserOutput: ParserOutput to manipulate
997 'ContentGetParserOutput': Customize parser output for a given content object,
998 called by AbstractContent::getParserOutput. May be used to override the normal
999 model-specific rendering of page content.
1000 $content: The Content to render
1001 $title: Title of the page, as context
1002 $revId: The revision ID, as context
1003 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1004 the output can only depend on parameters provided to this hook function, not
1006 $generateHtml: boolean, indicating whether full HTML should be generated. If
1007 false, generation of HTML may be skipped, but other information should still
1008 be present in the ParserOutput object.
1009 &$output: ParserOutput, to manipulate or replace
1011 'ContentHandlerDefaultModelFor': Called when the default content model is
1012 determined for a given title. May be used to assign a different model for that
1014 $title: the Title in question
1015 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1017 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1018 a given content model name, but no entry for that model exists in
1020 $modeName: the requested content model name
1021 &$handler: set this to a ContentHandler object, if desired.
1023 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1024 be used on a given page. This is especially useful to prevent some content
1025 models to be used in some special location.
1026 $contentModel: ID of the content model in question
1027 $title: the Title in question.
1028 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1029 Handler functions that modify $ok should generally return false to prevent
1030 further hooks from further modifying $ok.
1032 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1033 &$pager: Pager object for contributions
1034 &$queryInfo: The query for the contribs Pager
1036 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1038 &$data: an array of results of all contribs queries
1039 $pager: The ContribsPager object hooked into
1040 $offset: Index offset, inclusive
1041 $limit: Exact query limit
1042 $descending: Query direction, false for ascending, true for descending
1044 'ContributionsLineEnding': Called before a contributions HTML line is finished
1045 $page: SpecialPage object for contributions
1046 &$ret: the HTML line
1047 $row: the DB row for this line
1048 &$classes: the classes to add to the surrounding <li>
1050 'ContributionsToolLinks': Change tool links above Special:Contributions
1051 $id: User identifier
1052 $title: User page title
1053 &$tools: Array of tool links
1055 'ConvertContent': Called by AbstractContent::convert when a conversion to
1056 another content model is requested.
1057 Handler functions that modify $result should generally return false to disable
1058 further attempts at conversion.
1059 $content: The Content object to be converted.
1060 $toModel: The ID of the content model to convert to.
1061 $lossy: boolean indicating whether lossy conversion is allowed.
1062 &$result: Output parameter, in case the handler function wants to provide a
1063 converted Content object. Note that $result->getContentModel() must return
1066 'CustomEditor': When invoking the page editor
1067 Return true to allow the normal editor to be used, or false if implementing
1068 a custom editor, e.g. for a special namespace, etc.
1069 $article: Article being edited
1070 $user: User performing the edit
1072 'DatabaseOraclePostInit': Called after initialising an Oracle database
1073 $db: the DatabaseOracle object
1075 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1076 for Special:DeletedContributions
1077 Similar to ContribsPager::reallyDoQuery
1078 &$data: an array of results of all contribs queries
1079 $pager: The DeletedContribsPager object hooked into
1080 $offset: Index offset, inclusive
1081 $limit: Exact query limit
1082 $descending: Query direction, false for ascending, true for descending
1084 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1086 Similar to ContributionsLineEnding
1087 $page: SpecialPage object for DeletedContributions
1088 &$ret: the HTML line
1089 $row: the DB row for this line
1090 &$classes: the classes to add to the surrounding <li>
1092 'DiffRevisionTools': Override or extend the revision tools available from the
1093 diff view, i.e. undo, etc.
1094 $newRev: Revision object of the "new" revision
1095 &$links: Array of HTML links
1096 $oldRev: Revision object of the "old" revision (may be null)
1098 'DiffViewHeader': Called before diff display
1099 $diff: DifferenceEngine object that's calling
1100 $oldRev: Revision object of the "old" revision (may be null/invalid)
1101 $newRev: Revision object of the "new" revision
1103 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1105 &$article: article (object) being viewed
1106 &$oldid: oldid (int) being viewed
1108 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1109 Override the HTML generated for section edit links
1110 $skin: Skin object rendering the UI
1111 $title: Title object for the title being linked to (may not be the same as
1112 the page title, if the section is included from a template)
1113 $section: The designation of the section being pointed to, to be included in
1114 the link, like "§ion=$section"
1115 $tooltip: The default tooltip. Escape before using.
1116 By default, this is wrapped in the 'editsectionhint' message.
1117 &$result: The HTML to return, prefilled with the default plus whatever other
1118 changes earlier hooks have made
1119 $lang: The language code to use for the link in the wfMessage function
1121 'EditFilter': Perform checks on an edit
1122 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1123 $text: Contents of the edit box
1124 $section: Section being edited
1125 &$error: Error message to return
1126 $summary: Edit summary for page
1128 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1129 Post-section-merge edit filter.
1130 $editor: EditPage instance (object)
1131 $text: content of the edit box
1132 &$error: error message to return
1133 $summary: Edit summary for page
1135 'EditFilterMergedContent': Post-section-merge edit filter.
1136 This may be triggered by the EditPage or any other facility that modifies page
1137 content. Use the $status object to indicate whether the edit should be allowed,
1138 and to provide a reason for disallowing it. Return false to abort the edit, and
1139 true to continue. Returning true if $status->isOK() returns false means "don't
1140 save but continue user interaction", e.g. show the edit form.
1141 $status->apiHookResult can be set to an array to be returned by api.php
1142 action=edit. This is used to deliver captchas.
1143 $context: object implementing the IContextSource interface.
1144 $content: content of the edit box, as a Content object.
1145 $status: Status object to represent errors, etc.
1146 $summary: Edit summary for page
1147 $user: the User object representing the user whois performing the edit.
1148 $minoredit: whether the edit was marked as minor by the user.
1150 'EditFormInitialText': Allows modifying the edit form when editing existing
1152 $editPage: EditPage object
1154 'EditFormPreloadText': Allows population of the edit form when creating
1156 &$text: Text to preload with
1157 &$title: Title object representing the page being created
1159 'EditPage::attemptSave': Called before an article is
1160 saved, that is before WikiPage::doEditContent() is called
1161 $editpage_Obj: the current EditPage object
1163 'EditPage::attemptSave:after': Called after an article save attempt
1164 $editpage_Obj: the current EditPage object
1165 $status: the resulting Status object
1166 $resultDetails: Result details array
1168 'EditPage::importFormData': allow extensions to read additional data
1170 $editpage: EditPage instance
1171 $request: Webrequest
1172 return value is ignored (should always return true)
1174 'EditPage::showEditForm:fields': allows injection of form field into edit form
1175 Return value is ignored (should always return true)
1176 &$editor: the EditPage instance for reference
1177 &$out: an OutputPage instance to write to
1179 'EditPage::showEditForm:initial': before showing the edit form
1180 Return false to halt editing; you'll need to handle error messages, etc.
1181 yourself. Alternatively, modifying $error and returning true will cause the
1182 contents of $error to be echoed at the top of the edit form as wikitext.
1183 Return true without altering $error to allow the edit to proceed.
1184 &$editor: EditPage instance (object)
1185 &$out: an OutputPage instance to write to
1187 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1188 but for the read-only 'view source' variant of the edit form.
1189 Return value is ignored (should always return true)
1190 $editor: EditPage instance (object)
1191 &$out: an OutputPage instance to write to
1193 'EditPage::showStandardInputs:options': allows injection of form fields into
1194 the editOptions area
1195 Return value is ignored (should always be true)
1196 $editor: EditPage instance (object)
1197 $out: an OutputPage instance to write to
1198 &$tabindex: HTML tabindex of the last edit check/button
1200 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1201 when there's an edit conflict. Return false to halt normal diff output; in
1202 this case you're responsible for computing and outputting the entire "conflict"
1203 part, i.e., the "difference between revisions" and "your text" headers and
1205 &$editor: EditPage instance
1206 &$out: OutputPage instance
1208 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1209 textarea in the edit form.
1210 &$editpage: The current EditPage object
1211 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1212 &$tabindex: HTML tabindex of the last edit check/button
1214 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1216 &$editpage: The current EditPage object
1217 &$checks: Array of edit checks like "watch this page"/"minor edit"
1218 &$tabindex: HTML tabindex of the last edit check/button
1220 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1221 textarea in the edit form.
1222 &$toolbar: The toolbar HTMl
1224 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1225 contribution/copyright notice.
1226 $title: title of page being edited
1227 &$msg: localization message name, overridable. Default is either
1228 'copyrightwarning' or 'copyrightwarning2'.
1230 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1231 "Show changes". Note that it is preferable to implement diff handling for
1232 different data types using the ContentHandler facility.
1233 $editPage: EditPage object
1234 &$newtext: wikitext that will be used as "your version"
1236 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1237 Allow modifying the wikitext that will be used in "Show changes". Note that it
1238 is preferable to implement diff handling for different data types using the
1239 ContentHandler facility.
1240 $editPage: EditPage object
1241 &$newtext: wikitext that will be used as "your version"
1243 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1244 previewed. Note that it is preferable to implement previews for different data
1245 types using the ContentHandler facility.
1246 $editPage: EditPage object
1247 &$content: Content object to be previewed (may be replaced by hook function)
1249 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1250 Allow modifying the wikitext that will be previewed. Note that it is preferable
1251 to implement previews for different data types using the ContentHandler
1253 $editPage: EditPage object
1254 &$toparse: wikitext that will be parsed
1256 'EditPageNoSuchSection': When a section edit request is given for an
1257 non-existent section
1258 &$editpage: The current EditPage object
1259 &$res: the HTML of the error text
1261 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1262 of terms of service summary link that might exist separately from the copyright
1264 $title: title of page being edited
1265 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1267 'EmailConfirmed': When checking that the user's email address is "confirmed".
1268 This runs before the other checks, such as anonymity and the real check; return
1269 true to allow those checks to occur, and false if checking is done.
1270 &$user: User being checked
1271 &$confirmed: Whether or not the email address is confirmed
1273 'EmailUser': Before sending email from one user to another.
1274 &$to: MailAddress object of receiving user
1275 &$from: MailAddress object of sending user
1276 &$subject: subject of the mail
1277 &$text: text of the mail
1278 &$error: Out-param for an error
1280 'EmailUserCC': Before sending the copy of the email to the author.
1281 &$to: MailAddress object of receiving user
1282 &$from: MailAddress object of sending user
1283 &$subject: subject of the mail
1284 &$text: text of the mail
1286 'EmailUserComplete': After sending email from one user to another.
1287 $to: MailAddress object of receiving user
1288 $from: MailAddress object of sending user
1289 $subject: subject of the mail
1290 $text: text of the mail
1292 'EmailUserForm': After building the email user form object.
1293 &$form: HTMLForm object
1295 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1297 $user: The user who is trying to email another user.
1298 $editToken: The user's edit token.
1299 &$hookErr: Out-param for the error. Passed as the parameters to
1300 OutputPage::showErrorPage.
1302 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1303 group of changes in EnhancedChangesList.
1304 Hook subscribers can return false to omit this line from recentchanges.
1305 $changesList: EnhancedChangesList object
1306 &$links: The links that were generated by EnhancedChangesList
1307 $block: The RecentChanges objects in that block
1309 'EnhancedChangesListModifyLineData': to alter data used to build
1310 a grouped recent change inner line in EnhancedChangesList.
1311 Hook subscribers can return false to omit this line from recentchanges.
1312 $changesList: EnhancedChangesList object
1313 &$data: An array with all the components that will be joined in order to create the line
1314 $block: An array of RecentChange objects in that block
1315 $rc: The RecentChange object for this line
1317 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1318 a non-grouped recent change line in EnhancedChangesList.
1319 $changesList: EnhancedChangesList object
1320 &$data: An array with all the components that will be joined in order to create the line
1321 $rc: The RecentChange object for this line
1323 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1325 $ip: The ip address of the user
1327 'ExtensionTypes': Called when generating the extensions credits, use this to
1328 change the tables headers.
1329 &$extTypes: associative array of extensions types
1331 'ExtractThumbParameters': DEPRECATED! Media handler should override
1332 MediaHandler::parseParamString instead.
1333 Called when extracting thumbnail parameters from a thumbnail file name.
1334 $thumbname: the base name of the thumbnail file
1335 &$params: the currently extracted params (has source name, temp or archived
1338 'FetchChangesList': When fetching the ChangesList derivative for a particular
1340 $user: User the list is being fetched for
1341 &$skin: Skin object to be used with the list
1342 &$list: List object (defaults to NULL, change it to an object instance and
1343 return false override the list derivative used)
1345 'FileDeleteComplete': When a file is deleted.
1346 &$file: reference to the deleted file
1347 &$oldimage: in case of the deletion of an old image, the name of the old file
1348 &$article: in case all revisions of the file are deleted a reference to the
1349 WikiFilePage associated with the file.
1350 &$user: user who performed the deletion
1353 'FileTransformed': When a file is transformed and moved into storage.
1354 $file: reference to the File object
1355 $thumb: the MediaTransformOutput object
1356 $tmpThumbPath: The temporary file system path of the transformed file
1357 $thumbPath: The permanent storage path of the transformed file
1359 'FileUndeleteComplete': When a file is undeleted
1360 $title: title object to the file
1361 $fileVersions: array of undeleted versions. Empty if all versions were restored
1362 $user: user who performed the undeletion
1365 'FileUpload': When a file upload occurs.
1366 $file: Image object representing the file that was uploaded
1367 $reupload: Boolean indicating if there was a previously another image there or
1369 $hasDescription: Boolean indicating that there was already a description page
1370 and a new one from the comment wasn't created (since 1.17)
1372 'FormatAutocomments': When an autocomment is formatted by the Linker.
1373 &$comment: Reference to the accumulated comment. Initially null, when set the
1374 default code will be skipped.
1375 $pre: Boolean, true if there is text before this autocomment
1376 $auto: The extracted part of the parsed comment before the call to the hook.
1377 $post: Boolean, true if there is text after this autocomment
1378 $title: An optional title object used to links to sections. Can be null.
1379 $local: Boolean indicating whether section links should refer to local page.
1380 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1381 autocomment originated; null for the local wiki. Added in 1.26, should default
1382 to null in handler functions, for backwards compatibility.
1384 'GalleryGetModes': Get list of classes that can render different modes of a
1386 &$modeArray: An associative array mapping mode names to classes that implement
1387 that mode. It is expected all registered classes are a subclass of
1390 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1392 $user: user to promote.
1393 &$promote: groups that will be added.
1395 'GetBlockedStatus': after loading blocking status of an user from the database
1396 &$user: user (object) being checked
1398 'GetCacheVaryCookies': Get cookies that should vary cache options.
1399 $out: OutputPage object
1400 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1401 that have to vary cache options
1403 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1405 &$title: Title object of page
1406 &$url: string value as output (out parameter, can modify)
1407 $query: query options passed to Title::getCanonicalURL()
1409 'GetDefaultSortkey': Override the default sortkey for a page.
1410 $title: Title object that we need to get a sortkey for
1411 &$sortkey: Sortkey to use.
1413 'GetDifferenceEngine': Called when getting a new difference engine interface
1414 object Return false for valid object in $differenceEngine or true for the
1415 default difference engine.
1416 $context: IContextSource context to be used for diff
1417 $old: Revision ID to show and diff with
1418 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1419 $refreshCache: If set, refreshes the diff cache
1420 $unhide: If set, allow viewing deleted revs
1421 &$differenceEngine: output parameter, difference engine object to be used for
1424 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1425 underscore) magic words. Called by MagicWord.
1426 &$doubleUnderscoreIDs: array of strings
1428 'GetExtendedMetadata': Get extended file metadata for the API
1429 &$combinedMeta: Array of the form:
1430 'MetadataPropName' => array(
1431 value' => prop value,
1432 'source' => 'name of hook'
1434 $file: File object of file in question
1435 $context: RequestContext (including language to use)
1436 $single: Only extract the current language; if false, the prop value should
1437 be in the metadata multi-language array format:
1438 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1439 &$maxCacheTime: how long the results can be cached
1441 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1442 &$title: Title object of page
1443 &$url: string value as output (out parameter, can modify)
1444 $query: query options passed to Title::getFullURL()
1446 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1447 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1449 &$output: string for the output timestamp
1450 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1451 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1452 $user: User whose preferences are being used to make timestamp
1453 $lang: Language that will be used to render the timestamp
1455 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1456 &$title: Title object of page
1457 &$url: string value as output (out parameter, can modify)
1458 $query: query options passed to Title::getInternalURL()
1460 'GetIP': modify the ip of the current user (called only once).
1461 &$ip: string holding the ip as determined so far
1463 'GetLinkColours': modify the CSS class of an array of page links.
1464 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1466 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1468 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1469 working with internal urls (non-interwiki) then it may be preferable to work
1470 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1471 be buggy for internal urls on render if you do not re-implement the horrible
1472 hack that Title::getLocalURL uses in your own extension.
1473 &$title: Title object of page
1474 &$url: string value as output (out parameter, can modify)
1475 $query: query options passed to Title::getLocalURL()
1477 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1478 without any fancy queries or variants.
1479 &$title: Title object of page
1480 &$url: string value as output (out parameter, can modify)
1482 'GetLocalURL::Internal': Modify local URLs to internal pages.
1483 &$title: Title object of page
1484 &$url: string value as output (out parameter, can modify)
1485 $query: query options passed to Title::getLocalURL()
1487 'GetLogTypesOnUser': Add log types where the target is a userpage
1488 &$types: Array of log types
1490 'GetMetadataVersion': Modify the image metadata version currently in use. This
1491 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1492 that need to have versioned metadata should add an element to the end of the
1493 version array of the form 'handler_name=version'. Most media handlers won't need
1494 to do this unless they broke backwards compatibility with a previous version of
1495 the media handler metadata output.
1496 &$version: Array of version strings
1498 'GetNewMessagesAlert': Disable or modify the new messages alert
1499 &$newMessagesAlert: An empty string by default. If the user has new talk page
1500 messages, this should be populated with an alert message to that effect
1501 $newtalks: An empty array if the user has no new messages or an array
1502 containing links and revisions if there are new messages (See
1503 User::getNewMessageLinks)
1504 $user: The user object of the user who is loading the page
1505 $out: OutputPage object (to check what type of page the user is on)
1507 'GetPreferences': Modify user preferences.
1508 $user: User whose preferences are being modified.
1509 &$preferences: Preferences description array, to be fed to an HTMLForm object
1511 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1512 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1514 &$output: string for the output timestamp
1515 &$diff: DateInterval representing the difference between the timestamps
1516 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1517 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1518 $user: User whose preferences are being used to make timestamp
1519 $lang: Language that will be used to render the timestamp
1521 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1522 checked for. Use instead of userCan for most cases. Return false if the user
1523 can't do it, and populate $result with the reason in the form of
1524 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1525 might want to use ApiMessage to provide machine-readable details for the API).
1526 For consistency, error messages
1527 should be plain text with no special coloring, bolding, etc. to show that
1528 they're errors; presenting them properly to the user as errors is done by the
1530 &$title: Title object being checked against
1531 &$user: Current user object
1532 $action: Action being checked
1533 &$result: User permissions error to add. If none, return true.
1535 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1536 called only if expensive checks are enabled. Add a permissions error when
1537 permissions errors are checked for. Return false if the user can't do it, and
1538 populate $result with the reason in the form of array( messagename, param1,
1539 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1540 to provide machine-readable details for the API). For consistency, error
1541 messages should be plain text with no
1542 special coloring, bolding, etc. to show that they're errors; presenting them
1543 properly to the user as errors is done by the caller.
1544 &$title: Title object being checked against
1545 &$user: Current user object
1546 $action: Action being checked
1547 &$result: User permissions error to add. If none, return true.
1549 'GitViewers': Called when generating the list of git viewers for
1550 Special:Version, use this to change the list.
1551 &$extTypes: associative array of repo URLS to viewer URLs.
1553 'HistoryRevisionTools': Override or extend the revision tools available from the
1554 page history view, i.e. undo, rollback, etc.
1555 $rev: Revision object
1556 &$links: Array of HTML links
1558 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1560 $context: An IContextSource object with information about the request being
1563 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1564 image insertion. You can skip the default logic entirely by returning false, or
1565 just modify a few things using call-by-reference.
1567 &$title: Title object of the image
1568 &$file: File object, or false if it doesn't exist
1569 &$frameParams: Various parameters with special meanings; see documentation in
1570 includes/Linker.php for Linker::makeImageLink
1571 &$handlerParams: Various parameters with special meanings; see documentation in
1572 includes/Linker.php for Linker::makeImageLink
1573 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1574 &$res: Final HTML output, used if you return false
1576 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1577 the image on an image page.
1578 &$imagePage: ImagePage object ($this)
1581 'ImagePageAfterImageLinks': Called after the image links section on an image
1583 $imagePage: ImagePage object ($this)
1584 &$html: HTML for the hook to add
1586 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1587 $imagePage: ImagePage object ($this)
1589 &$line: the HTML of the history line
1590 &$css: the line CSS class
1592 'ImagePageFindFile': Called when fetching the file associated with an image
1594 $page: ImagePage object
1596 &$displayFile: displayed File object
1598 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1599 $page: ImagePage object
1600 &$toc: Array of <li> strings
1602 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1604 &$title: the Title object of the file as it would appear for the upload page
1605 &$path: the original file and path name when img_auth was invoked by the web
1607 &$name: the name only component of the file
1608 &$result: The location to pass back results of the hook routine (only used if
1610 $result[0]=The index of the header message
1611 $result[1]=The index of the body text message
1612 $result[2 through n]=Parameters passed to body text message. Please note the
1613 header message cannot receive/use parameters.
1615 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1616 Return false to stop further processing of the tag
1617 $reader: XMLReader object
1618 $logInfo: Array of information
1620 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1621 Return false to stop further processing of the tag
1622 $reader: XMLReader object
1623 &$pageInfo: Array of information
1625 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1626 Return false to stop further processing of the tag
1627 $reader: XMLReader object
1628 $pageInfo: Array of page information
1629 $revisionInfo: Array of revision information
1631 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1632 Return false to stop further processing of the tag
1633 $reader: XMLReader object
1635 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1636 Return false to stop further processing of the tag
1637 $reader: XMLReader object
1638 $revisionInfo: Array of information
1640 'ImportSources': Called when reading from the $wgImportSources configuration
1641 variable. Can be used to lazy-load the import sources list.
1642 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1643 comment in DefaultSettings.php for the detail of how to structure this array.
1645 'InfoAction': When building information to display on the action=info page.
1646 $context: IContextSource object
1647 &$pageInfo: Array of information
1649 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1650 &$title: Title object for the current page
1651 &$request: WebRequest
1652 &$ignoreRedirect: boolean to skip redirect check
1653 &$target: Title/string of redirect target
1654 &$article: Article object
1656 'InternalParseBeforeLinks': during Parser's internalParse method before links
1657 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1658 &$parser: Parser object
1659 &$text: string containing partially parsed text
1660 &$stripState: Parser's internal StripState object
1662 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1663 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1664 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1665 template/parser function execution which respect nowiki and HTML-comments.
1666 &$parser: Parser object
1667 &$text: string containing partially parsed text
1668 &$stripState: Parser's internal StripState object
1670 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1671 Return true without providing an interwiki to continue interwiki search.
1672 $prefix: interwiki prefix we are looking for.
1673 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1674 iw_trans and optionally iw_api and iw_wikiid.
1676 'InvalidateEmailComplete': Called after a user's email has been invalidated
1678 $user: user (object) whose email is being invalidated
1680 'IRCLineURL': When constructing the URL to use in an IRC notification.
1681 Callee may modify $url and $query, URL will be constructed as $url . $query
1682 &$url: URL to index.php
1683 &$query: Query string
1684 $rc: RecentChange object that triggered url generation
1686 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1687 &$article: article (object) being checked
1689 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1690 &$ip: IP being check
1691 &$result: Change this value to override the result of wfIsTrustedProxy()
1693 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1694 $url: URL used to upload from
1695 &$allowed: Boolean indicating if uploading is allowed for given URL
1697 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1698 instance to return false if the domain name doesn't match your organization.
1699 $addr: The e-mail address entered by the user
1700 &$result: Set this and return false to override the internal checks
1702 'isValidPassword': Override the result of User::isValidPassword()
1703 $password: The password entered by the user
1704 &$result: Set this and return false to override the internal checks
1705 $user: User the password is being validated for
1707 'Language::getMessagesFileName':
1708 $code: The language code or the language we're looking for a messages file for
1709 &$file: The messages file path, you can override this to change the location.
1711 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1712 $wgExtensionMessagesFiles instead.
1713 Use this to define synonyms of magic words depending of the language
1714 &$magicExtensions: associative array of magic words synonyms
1715 $lang: language code (string)
1717 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1718 remove namespaces. Do not use this hook to add namespaces. Use
1719 CanonicalNamespaces for that.
1720 &$namespaces: Array of namespaces indexed by their numbers
1722 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1723 listed in $wgExtensionMessagesFiles instead.
1724 Use to define aliases of special pages names depending of the language
1725 &$specialPageAliases: associative array of magic words synonyms
1726 $lang: language code (string)
1728 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1729 &$names: array of language code => language name
1730 $code: language of the preferred translations
1732 'LanguageLinks': Manipulate a page's language links. This is called
1733 in various places to allow extensions to define the effective language
1735 $title: The page's Title.
1736 &$links: Associative array mapping language codes to prefixed links of the
1737 form "language:title".
1738 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1739 Currently unused, but planned to provide support for marking individual
1740 language links in the UI, e.g. for featured articles.
1742 'LanguageSelector': Hook to change the language selector available on a page.
1743 $out: The output page.
1744 $cssClassName: CSS class name of the language selector.
1746 'LinkBegin': Used when generating internal and interwiki links in
1747 Linker::link(), before processing starts. Return false to skip default
1748 processing and return $ret. See documentation for Linker::link() for details on
1749 the expected meanings of parameters.
1750 $skin: the Skin object
1751 $target: the Title that the link is pointing to
1752 &$html: the contents that the <a> tag should have (raw HTML); null means
1754 &$customAttribs: the HTML attributes that the <a> tag should have, in
1755 associative array form, with keys and values unescaped. Should be merged
1756 with default values, with a value of false meaning to suppress the
1758 &$query: the query string to add to the generated URL (the bit after the "?"),
1759 in associative array form, with keys and values unescaped.
1760 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1761 &$ret: the value to return if your hook returns false.
1763 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1764 just before the function returns a value. If you return true, an <a> element
1765 with HTML attributes $attribs and contents $html will be returned. If you
1766 return false, $ret will be returned.
1767 $skin: the Skin object
1768 $target: the Title object that the link is pointing to
1769 $options: the options. Will always include either 'known' or 'broken', and may
1770 include 'noclasses'.
1771 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1772 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1773 associative array form.
1774 &$ret: the value to return if your hook returns false.
1776 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1778 &$url: the image url
1779 &$alt: the image's alt text
1780 &$img: the new image HTML (if returning false)
1782 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1785 &$text: the link text
1786 &$link: the new link HTML (if returning false)
1787 &$attribs: the attributes to be applied.
1788 $linkType: The external link type
1790 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1792 $title: the Title object that the link is pointing to
1793 $file: the File object or false if broken link
1794 &$html: the link text
1795 &$attribs: the attributes to be applied
1796 &$ret: the value to return if your hook returns false
1798 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1800 &$linksUpdate: the LinksUpdate object
1802 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1803 each link table insert. For example, pagelinks, imagelinks, externallinks.
1804 $linksUpdate: LinksUpdate object
1805 $table: the table to insert links to
1806 $insertions: an array of links to insert
1808 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1809 including delete and insert, has completed for all link tables
1810 &$linksUpdate: the LinksUpdate object
1812 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1813 &$linksUpdate: the LinksUpdate object
1815 'ListDefinedTags': When trying to find all defined tags.
1816 &$tags: The list of tags.
1818 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1819 $updater: A DatabaseUpdater subclass
1821 'LocalFile::getHistory': Called before file history query performed.
1822 &$file: the File object
1824 &$fields: select fields
1826 &$opts: query options
1827 &$join_conds: JOIN conditions
1829 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1830 $file: the File object
1831 $archiveName: name of an old file version or false if it's the current one
1833 'LocalisationCacheRecache': Called when loading the localisation data into
1835 $cache: The LocalisationCache object
1836 $code: language code
1837 &$alldata: The localisation data from core and extensions
1838 &$purgeBlobs: whether to purge/update the message blobs via
1839 MessageBlobStore::clear()
1841 'LocalisationCacheRecacheFallback': Called for each language when merging
1842 fallback data into the cache.
1843 $cache: The LocalisationCache object
1844 $code: language code
1845 &$alldata: The localisation data from core and extensions. Note some keys may
1846 be omitted if they won't be merged into the final result.
1848 'LocalisationChecksBlacklist': When fetching the blacklist of
1849 localisation checks.
1850 &$blacklist: array of checks to blacklist. See the bottom of
1851 maintenance/language/checkLanguage.inc for the format of this variable.
1853 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1854 optional localisation messages
1855 &$ignored: Array of ignored message keys
1856 &$optional: Array of optional message keys
1858 'LocalUserCreated': Called when a local user has been created
1859 $user: User object for the created user
1860 $autocreated: Boolean, whether this was an auto-creation
1862 'LogEventsListGetExtraInputs': When getting extra inputs to display on
1863 Special:Log for a specific log type
1864 $type: String of log type being displayed
1865 $logEventsList: LogEventsList object for context and access to the WebRequest
1866 &$input: string HTML of an input element
1868 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1869 Returning false will prevent the string from being added to the OutputPage.
1870 &$s: html string to show for the log extract
1871 $types: String or Array Log types to show
1872 $page: String or Title The page title to show log entries for
1873 $user: String The user who made the log entries
1874 $param: Associative Array with the following additional options:
1875 - lim Integer Limit of items to show, default is 50
1876 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1877 - showIfEmpty boolean Set to false if you don't want any output in case the
1878 loglist is empty if set to true (default), "No matching items in log" is
1879 displayed if loglist is empty
1880 - msgKey Array If you want a nice box with a message, set this to the key of
1881 the message. First element is the message key, additional optional elements
1882 are parameters for the key that are processed with
1883 wfMessage()->params()->parseAsBlock()
1884 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1886 - wrap String Wrap the message in html (usually something like
1887 "<div ...>$1</div>").
1888 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1890 'LogException': Called before an exception (or PHP error) is logged. This is
1891 meant for integration with external error aggregation services; returning false
1892 will NOT prevent logging.
1893 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
1894 $suppressed: true if the error was suppressed via
1895 error_reporting()/wfSuppressWarnings()
1897 'LoginAuthenticateAudit': A login attempt for a valid user account either
1898 succeeded or failed. No return data is accepted; this hook is for auditing only.
1899 $user: the User object being authenticated against
1900 $password: the password being submitted and found wanting
1901 $retval: a LoginForm class constant with authenticateUserData() return
1902 value (SUCCESS, WRONG_PASS, etc.).
1904 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
1905 error messages. Allows to add additional error messages (except messages already
1906 in LoginForm::$validErrorMessages).
1907 &$messages: Already added messages (inclusive messages from
1908 LoginForm::$validErrorMessages)
1910 'LoginPasswordResetMessage': User is being requested to reset their password on
1911 login. Use this hook to change the Message that will be output on
1912 Special:ChangePassword.
1913 &$msg: Message object that will be shown to the user
1914 $username: Username of the user who's password was expired.
1916 'LoginUserMigrated': Called during login to allow extensions the opportunity to
1917 inform a user that their username doesn't exist for a specific reason, instead
1918 of letting the login form give the generic error message that the account does
1919 not exist. For example, when the account has been renamed or deleted.
1920 $user: the User object being authenticated against.
1921 &$msg: the message identifier for abort reason, or an array to pass a message
1924 'LogLine': Processes a single log entry on Special:Log.
1925 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1926 logging.log_type database field.
1927 $log_action: string for the type of log action (e.g. 'delete', 'block',
1928 'create2'). Corresponds to logging.log_action database field.
1929 $title: Title object that corresponds to logging.log_namespace and
1930 logging.log_title database fields.
1931 $paramArray: Array of parameters that corresponds to logging.log_params field.
1932 Note that only $paramArray[0] appears to contain anything.
1933 &$comment: string that corresponds to logging.log_comment database field, and
1934 which is displayed in the UI.
1935 &$revert: string that is displayed in the UI, similar to $comment.
1936 $time: timestamp of the log entry (added in 1.12)
1938 'LonelyPagesQuery': Allow extensions to modify the query used by
1939 Special:LonelyPages.
1940 &$tables: tables to join in the query
1941 &$conds: conditions for the query
1942 &$joinConds: join conditions for the query
1944 'MagicWordwgVariableIDs': When defining new magic words IDs.
1945 &$variableIDs: array of strings
1947 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1949 $refreshLinks: RefreshLinks object
1951 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1952 Ideally, this hook should only be used to add variables that depend on
1953 the current page/request; static configuration should be added through
1954 ResourceLoaderGetConfigVars instead.
1955 &$vars: variable (or multiple variables) to be added into the output of
1956 Skin::makeVariablesScript
1957 $out: The OutputPage which called the hook, can be used to get the real title.
1959 'MarkPatrolled': Before an edit is marked patrolled.
1960 $rcid: ID of the revision to be marked patrolled
1961 &$user: the user (object) marking the revision as patrolled
1962 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1963 sysop in order to mark an edit patrolled.
1964 $auto: true if the edit is being marked as patrolled automatically
1966 'MarkPatrolledComplete': After an edit is marked patrolled.
1967 $rcid: ID of the revision marked as patrolled
1968 &$user: user (object) who marked the edit patrolled
1969 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1970 sysop to patrol the edit.
1971 $auto: true if the edit is being marked as patrolled automatically
1973 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1974 something completely different, after the basic globals have been set up, but
1975 before ordinary actions take place.
1977 $article: Article on which the action will be performed
1978 $title: Title on which the action will be performed
1980 $request: $wgRequest
1981 $mediaWiki: The $mediawiki object
1983 'MessageCache::get': When fetching a message. Can be used to override the key
1984 for customisations. Given and returned message key must be in special format:
1985 1) first letter must be in lower case according to the content language.
1986 2) spaces must be replaced with underscores
1987 &$key: message key (string)
1989 'MessageCacheReplace': When a message page is changed. Useful for updating
1991 $title: name of the page changed.
1992 $text: new contents of the page.
1994 'MessagesPreLoad': When loading a message from the database.
1995 $title: title of the message (string)
1996 &$message: value (string), change it to the message you want to define
1998 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1999 $mimeMagic: Instance of MimeMagic.
2000 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2001 &$tail: More or equal than last 65558 bytes of the file in a string
2002 (in - Do not alter!).
2004 &$mime: MIME type (out).
2006 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2007 MIME type detected by considering the file extension.
2008 $mimeMagic: Instance of MimeMagic.
2009 $ext: File extension.
2010 &$mime: MIME type (in/out).
2012 'MimeMagicInit': Before processing the list mapping MIME types to media types
2013 and the list mapping MIME types to file extensions.
2014 As an extension author, you are encouraged to submit patches to MediaWiki's
2015 core to add new MIME types to mime.types.
2016 $mimeMagic: Instance of MimeMagic.
2017 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2018 for adding new MIME info to the list.
2019 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2020 for adding new MIME types to the list.
2022 'ModifyExportQuery': Modify the query used by the exporter.
2023 $db: The database object to be queried.
2024 &$tables: Tables in the query.
2025 &$conds: Conditions in the query.
2026 &$opts: Options for the query.
2027 &$join_conds: Join conditions for the query.
2029 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2031 $oldTitle: Title object of the current (old) location
2032 $newTitle: Title object of the new location
2033 $user: User making the move
2034 $reason: string of the reason provided by the user
2035 $status: Status object to pass error messages to
2037 'MovePageIsValidMove': Specify whether a page can be moved for technical
2039 $oldTitle: Title object of the current (old) location
2040 $newTitle: Title object of the new location
2041 $status: Status object to pass error messages to
2043 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2045 $index: Integer; the index of the namespace being checked.
2046 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2047 namespace are movable. Hooks may change this value to override the return
2048 value of MWNamespace::isMovable().
2050 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2051 $title: the diff page title (nullable)
2052 &$oldId: the actual old Id to use in the diff
2053 &$newId: the actual new Id to use in the diff (0 means current)
2054 $old: the ?old= param value from the url
2055 $new: the ?new= param value from the url
2057 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2059 $wikiPage: the WikiPage edited
2060 $rev: the new revision
2061 $baseID: the revision ID this was based off, if any
2062 $user: the editing user
2064 'NormalizeMessageKey': Called before the software gets the text of a message
2065 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
2067 &$key: the message being looked up. Change this to something else to change
2068 what message gets displayed (string)
2069 &$useDB: whether or not to look up the message in the database (bool)
2070 &$langCode: the language code to get the message for (string) - or -
2071 whether to use the content language (true) or site language (false) (bool)
2072 &$transform: whether or not to expand variables and templates
2073 in the message (bool)
2075 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2076 return false to omit the line from RecentChanges and Watchlist special pages.
2077 &$changeslist: The OldChangesList instance.
2078 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2079 $rc: The RecentChange object.
2080 &$classes: array of css classes for the <li> element
2082 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2083 can alter or append to the array of URLs for search & suggestion formats.
2084 &$urls: array of associative arrays with Url element attributes
2086 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2087 when a page view triggers a re-rendering of the page. This may happen
2088 particularly if the parser cache is split by user language, and no cached
2089 rendering of the page exists in the user's language. The hook is called
2090 before checking whether page_links_updated indicates that the links are up
2091 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2092 without triggering any updates.
2093 $page: the Page that was rendered.
2094 $title: the Title of the rendered page.
2095 $parserOutput: ParserOutput resulting from rendering the page.
2097 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2098 users and/or IP addresses too.
2099 &$otherBlockLink: An array with links to other block logs
2100 $ip: The requested IP address or username
2102 'OutputPageBeforeHTML': A page has been processed by the parser and the
2103 resulting HTML is about to be displayed.
2104 &$parserOutput: the parserOutput (object) that corresponds to the page
2105 &$text: the text that will be displayed, in HTML (string)
2107 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2108 body tag to allow for extensions to add attributes to the body of the page they
2109 might need. Or to allow building extensions to add body classes that aren't of
2110 high enough demand to be included in core.
2111 $out: The OutputPage which called the hook, can be used to get the real title
2112 $sk: The Skin that called OutputPage::headElement
2113 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2115 'OutputPageCheckLastModified': when checking if the page has been modified
2116 since the last visit.
2117 &$modifiedTimes: array of timestamps.
2118 The following keys are set: page, user, epoch
2120 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2121 categories. Implementations should return false if they generate the category
2122 links, so the default link generation is skipped.
2123 &$out: OutputPage instance (object)
2124 $categories: associative array, keys are category names, values are category
2125 types ("normal" or "hidden")
2126 &$links: array, intended to hold the result. Must be an associative array with
2127 category types as keys and arrays of HTML links as values.
2129 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2130 &$out: OutputPage instance (object)
2131 $parserOutput: parserOutput instance being added in $out
2133 'PageContentInsertComplete': After a new article is created.
2134 $wikiPage: WikiPage created
2135 $user: User creating the article
2136 $content: New content as a Content object
2137 $summary: Edit summary/comment
2138 $isMinor: Whether or not the edit was marked as minor
2139 $isWatch: (No longer used)
2140 $section: (No longer used)
2141 $flags: Flags passed to WikiPage::doEditContent()
2142 $revision: New Revision of the article
2144 'PageContentLanguage': Allows changing the language in which the content of a
2145 page is written. Defaults to the wiki content language ($wgContLang).
2146 $title: Title object
2147 &$pageLang: the page content language (either an object or a language code)
2148 $wgLang: the user language
2150 'PageContentSave': Before an article is saved.
2151 $wikiPage: the WikiPage (object) being saved
2152 $user: the user (object) saving the article
2153 $content: the new article content, as a Content object
2154 $summary: the article summary (comment)
2155 $isminor: minor flag
2156 $iswatch: watch flag
2159 'PageContentSaveComplete': After an article has been updated.
2160 $wikiPage: WikiPage modified
2161 $user: User performing the modification
2162 $content: New content, as a Content object
2163 $summary: Edit summary/comment
2164 $isMinor: Whether or not the edit was marked as minor
2165 $isWatch: (No longer used)
2166 $section: (No longer used)
2167 $flags: Flags passed to WikiPage::doEditContent()
2168 $revision: New Revision of the article (can be null for edits that change
2170 $status: Status object about to be returned by doEditContent()
2171 $baseRevId: the rev ID (or false) this edit was based on
2173 'PageHistoryBeforeList': When a history page list is about to be constructed.
2174 &$article: the article that the history is loading for
2175 $context: RequestContext object
2177 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2178 $historyAction: the action object
2179 &$row: the revision row for this line
2180 &$s: the string representing this parsed line
2181 &$classes: array containing the <li> element classes
2183 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2184 any output is generated, to allow batch lookups for prefetching information
2185 needed for display. If the hook handler returns false, the regular behavior of
2186 doBatchLookups() is skipped.
2187 $pager: the PageHistoryPager
2188 $result: a ResultWrapper representing the query result
2190 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2193 &$queryInfo: the query parameters
2195 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2196 which depends on user options should install this hook and append its values to
2198 &$confstr: reference to a hash key string which can be modified
2199 $user: User (object) requesting the page
2200 &$forOptions: array of options the hash is for
2202 'PageViewUpdates': Allow database (or other) changes to be made after a
2203 page view is seen by MediaWiki. Note this does not capture views made
2204 via external caches such as Squid.
2205 $wikipage: WikiPage (object) for the page being viewed.
2206 $user: User (object) for the user who is viewing.
2208 'ParserAfterParse': Called from Parser::parse() just after the call to
2209 Parser::internalParse() returns.
2210 &$parser: parser object
2211 &$text: text being parsed
2212 &$stripState: stripState used (object)
2214 'ParserAfterStrip': Called at end of parsing time.
2215 TODO: No more strip, deprecated ?
2216 &$parser: parser object
2217 &$text: text being parsed
2218 &$stripState: stripState used (object)
2220 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2221 &$parser: Parser object being used
2222 &$text: text that will be returned
2224 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2225 Parser::internalParseHalfParsed()
2226 &$parser: Parser object being used
2227 &$text: text that will be returned
2229 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2230 &$parser: Parser object
2231 &$text: text to parse
2232 &$stripState: StripState instance being used
2234 'ParserBeforeStrip': Called at start of parsing time.
2235 TODO: No more strip, deprecated ?
2236 &$parser: parser object
2237 &$text: text being parsed
2238 &$stripState: stripState used (object)
2240 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2241 &$parser: Parser object being used
2244 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2246 $parserCache: ParserCache object $parserOutput was stored in
2247 $parserOutput: ParserOutput object that was stored
2248 $title: Title of the page that was parsed to generate $parserOutput
2249 $popts: ParserOptions used for generating $parserOutput
2250 $revId: ID of the revision that was parsed to create $parserOutput
2252 'ParserClearState': Called at the end of Parser::clearState().
2253 &$parser: Parser object being cleared
2255 'ParserCloned': Called when the parser is cloned.
2256 $parser: Newly-cloned Parser object
2258 'ParserFirstCallInit': Called when the parser initialises for the first time.
2259 &$parser: Parser object being cleared
2261 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2263 &$parser: Parser object
2264 &$varCache: array to store the value in case of multiples calls of the
2266 &$index: index (string) of the magic
2267 &$ret: value of the magic word (the hook should set it)
2268 &$frame: PPFrame object to use for expanding any template variables
2270 'ParserGetVariableValueTs': Use this to change the value of the time for the
2271 {{LOCAL...}} magic word.
2272 &$parser: Parser object
2273 &$time: actual time (timestamp)
2275 'ParserGetVariableValueVarCache': use this to change the value of the variable
2276 cache or return false to not use it.
2277 &$parser: Parser object
2278 &$varCache: variable cache (array)
2280 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2281 ParserLimitReportFormat instead.
2282 Called at the end of Parser:parse() when the parser will
2283 include comments about size of the text parsed.
2284 $parser: Parser object
2285 &$limitReport: text that will be included (without comment tags)
2287 'ParserLimitReportFormat': Called for each row in the parser limit report that
2288 needs formatting. If nothing handles this hook, the default is to use "$key" to
2289 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2291 $key: Key for the limit report item (string)
2292 &$value: Value of the limit report item
2293 &$report: String onto which to append the data
2294 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2295 text intended for display in a monospaced font.
2296 $localize: If false, $report should be output in English.
2298 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2299 will include comments about size of the text parsed. Hooks should use
2300 $output->setLimitReportData() to populate data. Functions for this hook should
2301 not use $wgLang; do that in ParserLimitReportFormat instead.
2302 $parser: Parser object
2303 $output: ParserOutput object
2305 'ParserMakeImageParams': Called before the parser make an image link, use this
2306 to modify the parameters of the image.
2307 $title: title object representing the file
2308 $file: file object that will be used to create the image
2309 &$params: 2-D array of parameters
2310 $parser: Parser object that called the hook
2312 'ParserSectionCreate': Called each time the parser creates a document section
2313 from wikitext. Use this to apply per-section modifications to HTML (like
2314 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2315 can begin in one section and end in another. Make sure your code can handle
2316 that case gracefully. See the EditSectionClearerLink extension for an example.
2317 $parser: the calling Parser instance
2318 $section: the section number, zero-based, but section 0 is usually empty
2319 &$sectionContent: ref to the content of the section. modify this.
2320 $showEditLinks: boolean describing whether this section has an edit link
2322 'ParserTestGlobals': Allows to define globals for parser tests.
2323 &$globals: Array with all the globals which should be set for parser tests.
2324 The arrays keys serve as the globals names, its values are the globals values.
2326 'ParserTestParser': Called when creating a new instance of Parser in
2327 tests/parser/parserTest.inc.
2328 &$parser: Parser object created
2330 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2331 run. Use when page save hooks require the presence of custom tables to ensure
2332 that tests continue to run properly.
2333 &$tables: array of table names
2335 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2336 $user: User object whose policy you are modifying
2337 &$effectivePolicy: Array of policy statements that apply to this user
2338 $purpose: string indicating purpose of the check, one of 'login', 'create',
2341 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2343 $block: Block object (which is set to be autoblocking)
2344 &$blockIds: Array of block IDs of the autoblock
2346 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2347 my talk page, my contributions" etc).
2348 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2349 &$title: Title object representing the current page
2350 $skin: SkinTemplate object providing context (e.g. to check if the user is
2353 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2354 &$user: User performing the action
2355 $action: Action being performed
2356 &$result: Whether or not the action should be prevented
2357 Change $result and return false to give a definitive answer, otherwise
2358 the built-in rate limiting checks are used, if enabled.
2359 $incrBy: Amount to increment counter by
2361 'PlaceNewSection': Override placement of new sections. Return false and put the
2362 merged text into $text to override the default behavior.
2363 $wikipage: WikiPage object
2364 $oldtext: the text of the article before editing
2365 $subject: subject of the new section
2366 &$text: text of the new section
2368 'PostLoginRedirect': Modify the post login redirect behavior.
2369 Occurs after signing up or logging in, allows for interception of redirect.
2370 &$returnTo: The page name to return to, as a string
2371 &$returnToQuery: array of url parameters, mapping parameter names to values
2372 &$type: type of login redirect as string;
2373 error: display a return to link ignoring $wgRedirectOnLogin
2374 signup: display a return to link using $wgRedirectOnLogin if needed
2375 success: display a return to link using $wgRedirectOnLogin if needed
2376 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2378 'PreferencesFormPreSave': Override preferences being saved
2379 $formData: array of user submitted data
2380 $form: PreferencesForm object, also a ContextSource
2381 $user: User object with preferences to be saved set
2382 &$result: boolean indicating success
2384 'PreferencesGetLegend': Override the text used for the <legend> of a
2385 preferences section.
2386 $form: the PreferencesForm object. This is a ContextSource as well
2387 $key: the section name
2388 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2391 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2392 AJAX search suggestions. Put results into &$results outparam and return false.
2393 $ns: array of int namespace keys to search in
2394 $search: search term (not guaranteed to be conveniently normalized)
2395 $limit: maximum number of results to return
2396 &$results: out param: array of page names (strings)
2397 $offset: number of results to offset from the beginning
2399 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2400 namespace from the search string so that extensions can attempt it.
2401 &$namespaces: array of int namespace keys to search in (change this if you can
2403 &$search: search term (replace this with term without the namespace if you can
2406 'PrefsEmailAudit': Called when user changes their email address.
2407 $user: User (object) changing his email address
2408 $oldaddr: old email address (string)
2409 $newaddr: new email address (string)
2411 'PrefsPasswordAudit': Called when user changes his password.
2412 $user: User (object) changing his password
2413 $newPass: new password
2414 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2416 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2418 $article: the title being (un)protected
2419 &$output: a string of the form HTML so far
2421 'ProtectionForm::save': Called when a protection form is submitted.
2422 $article: the Page being (un)protected
2423 &$errorMsg: an html message string of an error or an array of message name and
2425 $reasonstr: a string describing the reason page protection level is altered
2427 'ProtectionForm::showLogExtract': Called after the protection log extract is
2429 $article: the page the form is shown for
2430 $out: OutputPage object
2432 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2434 &$tables: Database tables to be used in the query
2435 &$conds: Conditions to be applied in the query
2436 &$joinConds: Join conditions to be applied in the query
2438 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2439 &$obj: RawAction object
2440 &$text: The text that's going to be the output
2442 'RecentChange_save': Called at the end of RecentChange::save().
2443 &$recentChange: RecentChange object
2445 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2446 names such as "oldid" that are preserved when using redirecting special pages
2447 such as Special:MyPage and Special:MyTalk.
2448 &$redirectParams: An array of parameters preserved by redirecting special pages.
2450 'RejectParserCacheValue': Return false to reject an otherwise usable
2451 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2452 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2454 $parserOutput: ParserOutput value.
2455 $wikiPage: WikiPage object.
2456 $parserOptions: ParserOptions object.
2458 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2459 instance. Can be used by an extension override what skin is used in certain
2461 $context: (IContextSource) The RequestContext the skin is being created for.
2462 &$skin: A variable reference you may set a Skin instance or string key on to
2463 override the skin that will be used for the context.
2465 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2466 $user: The user having their password expiration reset
2467 &$newExpire: The new expiration date
2469 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2470 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2471 to override its behavior. See the module docs for more information.
2472 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2474 $context: ResourceLoaderContext|null
2476 'ResourceLoaderGetConfigVars': Called at the end of
2477 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2478 configuration variables to JavaScript. Things that depend on the current page
2479 or request state must be added through MakeGlobalVariablesScript instead.
2480 &$vars: array( variable name => value )
2482 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2483 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2484 context-based variables.
2485 &$lessVars: array of variables already added
2487 'ResourceLoaderRegisterModules': Right before modules information is required,
2488 such as when responding to a resource
2489 loader request or generating HTML output.
2490 &$resourceLoader: ResourceLoader object
2492 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2493 called after the addition of 'qunit' and MediaWiki testing resources.
2494 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2495 included in core, is fed using tests/qunit/QUnitTestResources.php.
2496 To add a new qunit module named 'myext.tests':
2497 $testModules['qunit']['myext.tests'] = array(
2498 'script' => 'extension/myext/tests.js',
2499 'dependencies' => <any module dependency you might have>
2501 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2502 added to any module.
2503 &$ResourceLoader: object
2505 'RevisionInsertComplete': Called after a revision is inserted into the database.
2506 &$revision: the Revision
2507 $data: the data stored in old_text. The meaning depends on $flags: if external
2508 is set, it's the URL of the revision text in external storage; otherwise,
2509 it's the revision text itself. In either case, if gzip is set, the revision
2511 $flags: a comma-delimited list of strings representing the options used. May
2512 include: utf8 (this will always be set for new revisions); gzip; external.
2514 'SearchableNamespaces': An option to modify which namespaces are searchable.
2515 &$arr: Array of namespaces ($nsId => $name) which will be used.
2517 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2518 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2520 $term: Search term string
2521 &$title: Outparam; set to $title object and return false for a match
2523 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2524 if nothing was found.
2525 $term: Search term string
2526 &$title: Outparam; set to $title object and return false for a match
2528 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2529 the normal operations.
2530 $allSearchTerms: Array of the search terms in all content languages
2531 &$titleResult: Outparam; the value to return. A Title object or null.
2533 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2535 $term: Search term string
2536 &$title: Current Title object that is being returned (null if none found).
2538 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2540 $title: Current Title object being displayed in search results.
2541 &$id: Revision ID (default is false, for latest)
2543 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2544 perform when page content is modified. Currently called by
2545 AbstractContent::getSecondaryDataUpdates.
2546 $title: Title of the page that is being edited.
2547 $oldContent: Content object representing the page's content before the edit.
2548 $recursive: bool indicating whether DataUpdates should trigger recursive
2549 updates (relevant mostly for LinksUpdate).
2550 $parserOutput: ParserOutput representing the rendered version of the page
2552 &$updates: a list of DataUpdate objects, to be modified or replaced by
2555 'SelfLinkBegin': Called before a link to the current article is displayed to
2556 allow the display of the link to be customized.
2557 $nt: the Title object
2558 &$html: html to display for the link
2559 &$trail: optional text to display before $html
2560 &$prefix: optional text to display after $html
2561 &$ret: the value to return if your hook returns false
2563 'SendWatchlistEmailNotification': Return true to send watchlist email
2565 $targetUser: the user whom to send watchlist email notification
2566 $title: the page title
2567 $enotif: EmailNotification object
2569 'SetupAfterCache': Called in Setup.php, after cache objects are set
2571 'ShowMissingArticle': Called when generating the output for a non-existent page.
2572 $article: The article object corresponding to the page
2574 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2575 Customise the output of raw CSS and JavaScript in page views.
2576 $text: Text being shown
2577 $title: Title of the custom script/stylesheet page
2578 $output: Current OutputPage object
2580 'ShowSearchHit': Customize display of search hit.
2581 $searchPage: The SpecialSearch instance.
2582 $result: The SearchResult to show
2583 $terms: Search terms, for highlighting
2584 &$link: HTML of link to the matching page. May be modified.
2585 &$redirect: HTML of redirect info. May be modified.
2586 &$section: HTML of matching section. May be modified.
2587 &$extract: HTML of content extract. May be modified.
2588 &$score: HTML of score. May be modified.
2589 &$size: HTML of page size. May be modified.
2590 &$date: HTML of of page modification date. May be modified.
2591 &$related: HTML of additional info for the matching page. May be modified.
2592 &$html: May be set to the full HTML that should be used to represent the search
2593 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2594 function returned false.
2596 'ShowSearchHitTitle': Customise display of search hit title/link.
2597 &$title: Title to link to
2598 &$text: Text to use for the link
2599 $result: The search result
2600 $terms: The search terms entered
2601 $page: The SpecialSearch object
2602 &$query: Query string to be appended to the link
2604 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2605 Warning: This hook is run on each display. You should consider to use
2606 'SkinBuildSidebar' that is aggressively cached.
2608 &$bar: Sidebar content
2609 Modify $bar to add or modify sidebar portlets.
2611 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2612 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2613 the sitenotice/anonnotice.
2616 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2617 allow the normal method of notice selection/rendering to work, or change the
2618 value of $siteNotice and return false to alter it.
2619 &$siteNotice: HTML returned as the sitenotice
2622 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2624 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2625 the stock bottom scripts.
2627 'SkinAfterContent': Allows extensions to add text after the page content and
2628 article metadata. This hook should work in all skins. Set the &$data variable to
2629 the text you're going to add.
2630 &$data: (string) Text to be printed out directly (without parsing)
2633 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2635 &$bar: Sidebar contents
2636 Modify $bar to add or modify sidebar portlets.
2638 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2640 $title: displayed page title
2641 $type: 'normal' or 'history' for old/diff views
2642 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2643 message must be in HTML format, not wikitext!
2644 &$link: overridable HTML link to be passed into the message as $1
2645 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2648 'SkinEditSectionLinks': Modify the section edit links
2649 $skin: Skin object rendering the UI
2650 $title: Title object for the title being linked to (may not be the same as
2651 the page title, if the section is included from a template)
2652 $section: The designation of the section being pointed to, to be included in
2653 the link, like "§ion=$section"
2654 $tooltip: The default tooltip. Escape before using.
2655 By default, this is wrapped in the 'editsectionhint' message.
2656 &$result: Array containing all link detail arrays. Each link detail array should
2657 contain the following keys:
2658 - targetTitle - Target Title object
2659 - text - String for the text
2660 - attribs - Array of attributes
2661 - query - Array of query parameters to add to the URL
2662 - options - Array of options for Linker::link
2663 $lang: The language code to use for the link in the wfMessage function
2665 'SkinGetPoweredBy': TODO
2666 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2667 the MediaWiki icon but plain text instead.
2670 'SkinPreloadExistence': Supply titles that should be added to link existence
2671 cache before the page is rendered.
2672 &$titles: Array of Title objects
2675 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2676 If false is returned $subpages will be used instead of the HTML
2677 subPageSubtitle() generates.
2678 If true is returned, $subpages will be ignored and the rest of
2679 subPageSubtitle() will run.
2680 &$subpages: Subpage links HTML
2682 $out: OutputPage object
2684 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2686 &$sktemplate: SkinTemplate object
2687 &$nav_urls: array of tabs
2688 &$revid: The revision id of the permanent link
2689 &$revid2: The revision id of the permanent link, second time
2691 'SkinTemplateGetLanguageLink': After building the data for a language link from
2692 which the actual html is constructed.
2693 &$languageLink: array containing data about the link. The following keys can be
2694 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2695 $languageLinkTitle: Title object belonging to the external language link.
2696 $title: Title object of the page the link belongs to.
2697 $outputPage: The OutputPage object the links are built from.
2699 'SkinTemplateNavigation': Called on content pages after the tabs have been
2700 added, but before variants have been added.
2701 &$sktemplate: SkinTemplate object
2702 &$links: Structured navigation links. This is used to alter the navigation for
2703 skins which use buildNavigationUrls such as Vector.
2705 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2706 tab is added but before variants have been added.
2707 &$sktemplate: SkinTemplate object
2708 &$links: Structured navigation links. This is used to alter the navigation for
2709 skins which use buildNavigationUrls such as Vector.
2711 'SkinTemplateNavigation::Universal': Called on both content and special pages
2712 after variants have been added.
2713 &$sktemplate: SkinTemplate object
2714 &$links: Structured navigation links. This is used to alter the navigation for
2715 skins which use buildNavigationUrls such as Vector.
2717 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2719 &$sktemplate: SkinTemplate object
2720 &$tpl: QuickTemplate engine object
2722 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2723 &$sktemplate: SkinTemplate object
2724 &$res: set to true to prevent active tabs
2726 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2727 You can either create your own array, or alter the parameters for
2729 &$sktemplate: The SkinTemplate instance.
2730 $title: Title instance for the page.
2731 $message: Visible label of tab.
2732 $selected: Whether this is a selected tab.
2733 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2734 &$classes: Array of CSS classes to apply.
2735 &$query: Query string to add to link.
2737 &$result: Complete assoc. array if you want to return true.
2739 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2740 been rendered (useful for adding more).
2741 &$sk: The QuickTemplate based skin template running the hook.
2742 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2743 extensions that add support for BaseTemplateToolbox should watch for this
2744 dummy parameter with "$dummy=false" in their code and return without echoing
2745 any HTML to avoid creating duplicate toolbox items.
2747 'SoftwareInfo': Called by Special:Version for returning information about the
2749 &$software: The array of software in format 'name' => 'version'. See
2750 SpecialVersion::softwareInformation().
2752 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2753 $sp: SpecialPage object, for context
2754 &$fields: Current HTMLForm fields
2756 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2757 $id: User id number, only provided for backwards-compatibility
2758 $user: User object representing user contributions are being fetched for
2759 $sp: SpecialPage instance, providing context
2761 'SpecialListusersDefaultQuery': Called right before the end of
2762 UsersPager::getDefaultQuery().
2763 $pager: The UsersPager instance
2764 &$query: The query array to be returned
2766 'SpecialListusersFormatRow': Called right before the end of
2767 UsersPager::formatRow().
2768 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2769 $row: Database row object
2771 'SpecialListusersHeader': Called before closing the <fieldset> in
2772 UsersPager::getPageHeader().
2773 $pager: The UsersPager instance
2774 &$out: The header HTML
2776 'SpecialListusersHeaderForm': Called before adding the submit button in
2777 UsersPager::getPageHeader().
2778 $pager: The UsersPager instance
2779 &$out: The header HTML
2781 'SpecialListusersQueryInfo': Called right before the end of.
2782 UsersPager::getQueryInfo()
2783 $pager: The UsersPager instance
2784 &$query: The query array to be returned
2786 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2787 $type: String of the log type
2788 $request: WebRequest object for getting the value provided by the current user
2789 &$qc: Array for query conditions to add
2791 'SpecialMovepageAfterMove': Called after moving a page.
2792 &$movePage: MovePageForm object
2793 &$oldTitle: old title (object)
2794 &$newTitle: new title (object)
2796 'SpecialNewpagesConditions': Called when building sql query for
2798 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2799 $opts: FormOptions object containing special page options
2800 &$conds: array of WHERE conditionals for query
2801 &$tables: array of tables to be queried
2802 &$fields: array of columns to select
2803 &$join_conds: join conditions for the tables
2805 'SpecialNewPagesFilters': Called after building form options at NewPages.
2806 $special: the special page object
2807 &$filters: associative array of filter definitions. The keys are the HTML
2808 name/URL parameters. Each key maps to an associative array with a 'msg'
2809 (message key) and a 'default' value.
2811 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
2812 this hook to remove a core special page or conditionally register special pages.
2813 &$list: list (array) of core special pages
2815 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2816 $special: the SpecialPage object
2817 $subPage: the subpage string or null if no subpage was specified
2819 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2820 $special: the SpecialPage object
2821 $subPage: the subpage string or null if no subpage was specified
2823 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2824 $name: name of the special page
2825 &$form: HTMLForm object
2827 'SpecialPasswordResetOnSubmit': When executing a form submission on
2828 Special:PasswordReset.
2829 &$users: array of User objects.
2830 $data: array of data submitted by the user
2831 &$error: string, error code (message key) used to describe to error (out
2832 parameter). The hook needs to return false when setting this, otherwise it
2833 will have no effect.
2835 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2836 use this to change some selection criteria or substitute a different title.
2837 &$randstr: The random number from wfRandom()
2838 &$isRedir: Boolean, whether to select a redirect or non-redirect
2839 &$namespaces: An array of namespace indexes to get the title from
2840 &$extra: An array of extra SQL statements
2841 &$title: If the hook returns false, a Title object to use instead of the
2842 result from the normal query
2844 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2846 Called after building form options at RecentChanges.
2847 $special: the special page object
2848 &$filters: associative array of filter definitions. The keys are the HTML
2849 name/URL parameters. Each key maps to an associative array with a 'msg'
2850 (message key) and a 'default' value.
2852 'SpecialRecentChangesPanel': Called when building form options in
2853 SpecialRecentChanges.
2854 &$extraOpts: array of added items, to which can be added
2855 $opts: FormOptions for this request
2857 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
2859 Called when building SQL query for SpecialRecentChanges and
2860 SpecialRecentChangesLinked.
2861 &$conds: array of WHERE conditionals for query
2862 &$tables: array of tables to be queried
2863 &$join_conds: join conditions for the tables
2864 $opts: FormOptions for this request
2865 &$query_options: array of options for the database request
2866 &$select: Array of columns to select
2868 'SpecialResetTokensTokens': Called when building token list for
2870 &$tokens: array of token information arrays in the format of
2872 'preference' => '<preference-name>',
2873 'label-message' => '<message-key>',
2876 'SpecialSearchCreateLink': Called when making the message to create a page or
2877 go to the existing page.
2878 $t: title object searched for
2879 &$params: an array of the default message name and page title (as parameter)
2881 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2882 target doesn't exist.
2883 &$title: title object generated from the text entered by the user
2885 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2886 the advanced form, a.k.a. power search box.
2887 &$showSections: an array to add values with more options to
2888 $term: the search term (not a title object)
2889 $opts: an array of hidden options (containing 'redirs' and 'profile')
2891 'SpecialSearchProfileForm': Allows modification of search profile forms.
2892 $search: special page object
2893 &$form: String: form html
2894 $profile: String: current search profile
2895 $term: String: search term
2896 $opts: Array: key => value of hidden options for inclusion in custom forms
2898 'SpecialSearchProfiles': Allows modification of search profiles.
2899 &$profiles: profiles, which can be modified.
2901 'SpecialSearchResults': Called before search result display
2902 $term: string of search term
2903 &$titleMatches: empty or SearchResultSet object
2904 &$textMatches: empty or SearchResultSet object
2906 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2907 on the search results page. Useful for including an external search
2908 provider. To disable the output of MediaWiki search output, return
2910 $specialSearch: SpecialSearch object ($this)
2912 $term: Search term specified by the user
2914 'SpecialSearchResultsAppend': Called immediately before returning HTML
2915 on the search results page. Useful for including a feedback link.
2916 $specialSearch: SpecialSearch object ($this)
2918 $term: Search term specified by the user
2920 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2921 $search: SpecialSearch special page object
2922 $profile: String: current search profile
2923 $engine: the search engine
2925 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2926 &$extraStats: Array to save the new stats
2927 $extraStats['<name of statistic>'] => <value>;
2928 <value> can be an array with the keys "name" and "number":
2929 "name" is the HTML to be displayed in the name column
2930 "number" is the number to be displayed.
2931 or, <value> can be the number to be displayed and <name> is the
2932 message key to use in the name column,
2933 $context: IContextSource object
2935 'SpecialUploadComplete': Called after successfully uploading a file from
2937 &$form: The SpecialUpload object
2939 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2940 $wgVersion: Current $wgVersion for you to use
2941 &$versionUrl: Raw url to link to (eg: release notes)
2943 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2945 Called after building form options at Watchlist.
2946 $special: the special page object
2947 &$filters: associative array of filter definitions. The keys are the HTML
2948 name/URL parameters. Each key maps to an associative array with a 'msg'
2949 (message key) and a 'default' value.
2951 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2952 SpecialWatchlist. Allows extensions to register custom values they have
2953 inserted to rc_type so they can be returned as part of the watchlist.
2954 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2956 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
2957 Called when building sql query for SpecialWatchlist.
2958 &$conds: array of WHERE conditionals for query
2959 &$tables: array of tables to be queried
2960 &$join_conds: join conditions for the tables
2961 &$fields: array of query fields
2962 $opts: A FormOptions object with watchlist options for the current request
2964 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2965 URL for a title when we have no other parameters on the URL. Gives a chance for
2966 extensions that alter page view behavior radically to abort that redirect or
2968 $request: WebRequest
2969 $title: Title of the currently found title obj
2970 $output: OutputPage object
2972 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2973 rendered (by ThumbnailImage:toHtml method).
2974 $thumbnail: the ThumbnailImage object
2975 &$attribs: image attribute array
2976 &$linkAttribs: image link attribute array
2978 'TitleArrayFromResult': Called when creating an TitleArray object from a
2980 &$titleArray: set this to an object to override the default object returned
2981 $res: database result used to create the object
2983 'TitleExists': Called when determining whether a page exists at a given title.
2984 $title: The title being tested.
2985 &$exists: Whether the title exists.
2987 'TitleGetEditNotices': Allows extensions to add edit notices
2988 $title: The Title object for the page the edit notices are for
2989 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2990 &$notices: Array of notices. Keys are i18n message keys, values are
2991 parseAsBlock()ed messages.
2993 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2994 that can be applied.
2995 $title: The title in question.
2996 &$types: The types of protection available.
2998 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2999 overriding default behavior for determining if a page exists. If $isKnown is
3000 kept as null, regular checks happen. If it's a boolean, this value is returned
3001 by the isKnown method.
3002 $title: Title object that is being checked
3003 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3005 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3006 Called when determining if a page is a CSS or JS page.
3007 $title: Title object that is being checked
3008 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3009 Hooks may change this value to override the return value of
3010 Title::isCssOrJsPage().
3012 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3013 that this hook is not called for interwiki pages or pages in immovable
3014 namespaces: for these, isMovable() always returns false.
3015 $title: Title object that is being checked
3016 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3017 Hooks may change this value to override the return value of
3020 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3021 Called when determining if a page is a wikitext or should
3022 be handled by separate handler (via ArticleViewCustom).
3023 $title: Title object that is being checked
3024 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3025 Hooks may change this value to override the return value of
3026 Title::isWikitextPage()
3028 'TitleMove': Before moving an article (title).
3031 $user: user who does the move
3033 'TitleMoveComplete': After moving an article (title).
3036 &$user: user who did the move
3037 $pageid: database ID of the page that's been moved
3038 $redirid: database ID of the created redirect
3039 $reason: reason for the move
3041 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3042 or override the quick permissions check.
3043 $title: The Title object being accessed
3044 $user: The User performing the action
3045 $action: Action being performed
3046 &$errors: Array of errors
3047 $doExpensiveQueries: Whether to do expensive DB queries
3048 $short: Whether to return immediately on first error
3050 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3051 adding the default error message if nothing allows the user to read the page. If
3052 a handler wants a title to *not* be whitelisted, it should also return false.
3053 $title: Title object being checked against
3054 $user: Current user object
3055 &$whitelisted: Boolean value of whether this title is whitelisted
3057 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3058 $title: Title object to purge
3059 &$urls: An array of URLs to purge from the caches, to be manipulated.
3061 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3062 PageArchive object has been created but before any further processing is done.
3063 &$archive: PageArchive object
3064 $title: Title object of the page that we're viewing
3066 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3067 PageArchive object has been created but before any further processing is done.
3068 &$archive: PageArchive object
3069 $title: Title object of the page that we're viewing
3071 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3072 the site is not in read-only mode, that the Title object is not null and after
3073 a PageArchive object has been constructed but before performing any further
3075 &$archive: PageArchive object
3076 $title: Title object of the page that we're about to undelete
3078 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3079 $title: title object related to the revision
3080 $rev: revision (object) that will be viewed
3082 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3083 Since 1.24: Paths pointing to a directory will be recursively scanned for
3084 test case files matching the suffix "Test.php".
3085 &$paths: list of test cases and directories to search.
3087 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3089 $action: action name
3090 $article: article "acted on"
3092 'UnwatchArticle': Before a watch is removed from an article.
3093 &$user: user watching
3094 &$page: WikiPage object to be removed
3095 &$status: Status object to be returned if the hook returns false
3097 'UnwatchArticleComplete': After a watch is removed from an article.
3098 $user: user that watched
3099 &$page: WikiPage object that was watched
3101 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3102 &$formattedPageStatus: list of valid page states
3104 'UploadComplete': Upon completion of a file upload.
3105 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3106 $uploadBase->getLocalFile().
3108 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3109 $type: (string) the requested upload type
3110 &$className: the class name of the Upload instance to be created
3112 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3113 poke at member variables like $mUploadDescription before the file is saved. Do
3114 not use this hook to break upload processing. This will return the user to a
3115 blank form with no error message; use UploadVerification and UploadVerifyFile
3117 &$form: UploadForm object
3119 'UploadForm:initial': Before the upload form is generated. You might set the
3120 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3121 text (HTML) either before or after the editform.
3122 &$form: UploadForm object
3124 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3126 &$descriptor: (array) the HTMLForm descriptor
3128 'UploadFormSourceDescriptors': after the standard source inputs have been
3129 added to the descriptor
3130 &$descriptor: (array) the HTMLForm descriptor
3131 &$radio: Boolean, if source type should be shown as radio button
3132 $selectedSourceType: The selected source type
3134 'UploadVerification': Additional chances to reject an uploaded file. Consider
3135 using UploadVerifyFile instead.
3136 $saveName: (string) destination file name
3137 $tempName: (string) filesystem path to the temporary file for checks
3138 &$error: (string) output: message key for message to show if upload canceled by
3139 returning false. May also be an array, where the first element is the message
3140 key and the remaining elements are used as parameters to the message.
3142 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3143 in most cases over UploadVerification.
3144 $upload: (object) an instance of UploadBase, with all info about the upload
3145 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3146 Handlers will typically only apply for specific MIME types.
3147 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3148 representing the problem with the file, where the first element is the message
3149 key and the remaining elements are used as parameters to the message.
3151 'User::mailPasswordInternal': before creation and mailing of a user's new
3153 &$user: the user who sent the message out
3154 &$ip: IP of the user who sent the message out
3155 &$u: the account whose new password will be set
3157 'UserAddGroup': Called when adding a group; return false to override
3158 stock group addition.
3159 $user: the user object that is to have a group added
3160 &$group: the group to add, can be modified
3162 'UserArrayFromResult': Called when creating an UserArray object from a database
3164 &$userArray: set this to an object to override the default object returned
3165 $res: database result used to create the object
3167 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3168 want to display an error message, try getUserPermissionsErrors.
3169 &$title: Title object being checked against
3170 &$user: Current user object
3171 $action: Action being checked
3172 &$result: Pointer to result returned if hook returns false. If null is returned,
3173 userCan checks are continued by internal code.
3175 'UserCanSendEmail': To override User::canSendEmail() permission check.
3176 &$user: User (object) whose permission is being checked
3177 &$canSend: bool set on input, can override on output
3179 'UserClearNewTalkNotification': Called when clearing the "You have new
3180 messages!" message, return false to not delete it.
3181 &$user: User (object) that will clear the message
3182 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3184 'UserCreateForm': change to manipulate the login form
3185 &$template: SimpleTemplate instance for the form
3187 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3188 &$user: User to get groups for
3189 &$groups: Current effective groups
3191 'UserGetAllRights': After calculating a list of all available rights.
3192 &$rights: Array of rights, which may be added to.
3194 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3195 before returning the options to the caller. Warning: This hook is called for
3196 every call to User::getDefaultOptions(), which means it's potentially called
3197 dozens or hundreds of times. You may want to cache the results of non-trivial
3198 operations in your hook function for this reason.
3199 &$defaultOptions: Array of preference keys and their default values.
3201 'UserGetEmail': Called when getting an user email address.
3203 &$email: email, change this to override local email
3205 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3206 email authentication.
3208 &$timestamp: timestamp, change this to override local email authentication
3211 'UserGetImplicitGroups': DEPRECATED!
3212 Called in User::getImplicitGroups().
3213 &$groups: List of implicit (automatically-assigned) groups
3215 'UserGetLanguageObject': Called when getting user's interface language object.
3217 &$code: Language code that will be used to create the object
3218 $context: IContextSource object
3220 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3221 &$reservedUsernames: $wgReservedUsernames
3223 'UserGetRights': Called in User::getRights().
3224 $user: User to get rights for
3225 &$rights: Current rights
3227 'UserGroupsChanged': Called after user groups are changed.
3228 $user: User whose groups changed
3229 $added: Groups added
3230 $removed: Groups removed
3231 $performer: User who performed the change, false if via autopromotion
3233 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3234 specific block exemptions).
3235 $user: User in question
3236 $title: Title of the page in question
3237 &$blocked: Out-param, whether or not the user is blocked from that page.
3238 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3239 to edit their own user talk pages.
3241 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3243 $ip: User's IP address
3244 &$blocked: Whether the user is blocked, to be modified by the hook
3246 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3247 false if a UserGetRights hook might remove the named right.
3248 $right: The user right being checked
3250 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3251 $user: User in question.
3252 &$hidden: Set true if the user's name should be hidden.
3254 'UserIsLocked': Check if the user is locked. See User::isLocked().
3255 $user: User in question.
3256 &$locked: Set true if the user should be locked.
3258 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3259 environmental means; occurs after session is loaded.
3260 $user: user object being loaded
3262 'UserLoadDefaults': Called when loading a default user.
3266 'UserLoadFromDatabase': Called when loading a user from the database.
3268 &$s: database query object
3270 'UserLoadFromSession': Called to authenticate users on external/environmental
3271 means; occurs before session is loaded.
3272 $user: user object being loaded
3273 &$result: set this to a boolean value to abort the normal authentication
3276 'UserLoadOptions': When user options/preferences are being loaded from the
3279 &$options: Options, can be modified.
3281 'UserLoggedIn': Called after a user is logged in
3282 $user: User object for the logged-in user
3284 'UserLoginComplete': After a user has logged in.
3285 &$user: the user object that was created on login
3286 &$inject_html: Any HTML to inject after the "logged in" message.
3288 'UserLoginForm': change to manipulate the login form
3289 &$template: SimpleTemplate instance for the form
3291 'UserLogout': Before a user logs out.
3292 &$user: the user object that is about to be logged out
3294 'UserLogoutComplete': After a user has logged out.
3295 &$user: the user object _after_ logout (won't have name, ID, etc.)
3296 &$inject_html: Any HTML to inject after the "logged out" message.
3297 $oldName: name of the user before logout (string)
3299 'UserMailerChangeReturnPath': Called to generate a VERP return address
3300 when UserMailer sends an email, with a bounce handling extension.
3301 $to: Array of MailAddress objects for the recipients
3302 &$returnPath: The return address string
3304 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3305 to split up an email with multiple the To: field into separate emails.
3306 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3308 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3309 Extensions can block sending the email by returning false and setting $error.
3310 $to: array of MailAdresses of the targets
3311 $from: MailAddress of the sender
3312 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3313 &$error: should be set to an error message string
3315 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3316 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3317 $to: array of MailAdresses of the targets
3318 $from: MailAddress of the sender
3319 &$subject: email subject (not MIME encoded)
3320 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3321 &$body: email body (in MIME format) as a string
3322 &$error: should be set to an error message string
3324 'UserRemoveGroup': Called when removing a group; return false to override stock
3326 $user: the user object that is to have a group removed
3327 &$group: the group to be removed, can be modified
3329 'UserRequiresHTTPS': Called to determine whether a user needs
3330 to be switched to HTTPS.
3331 $user: User in question.
3332 &$https: Boolean whether $user should be switched to HTTPS.
3334 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3335 have been requested to be reset. This hook can be used to exclude certain
3336 options from being reset even when the user has requested all prefs to be reset,
3337 because certain options might be stored in the user_properties database table
3338 despite not being visible and editable via Special:Preferences.
3339 $user: the User (object) whose preferences are being reset
3340 &$newOptions: array of new (site default) preferences
3341 $options: array of the user's old preferences
3342 $resetKinds: array containing the kinds of preferences to reset
3344 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3346 &$user: user retrieving new talks messages
3347 &$talks: array of new talks page(s)
3349 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3350 After a user's group memberships are changed.
3351 &$user: User object that was changed
3352 $add: Array of strings corresponding to groups added
3353 $remove: Array of strings corresponding to groups removed
3355 'UserSaveOptions': Called just before saving user preferences/options.
3357 &$options: Options, modifiable
3359 'UserSaveSettings': Called when saving user settings.
3362 'UserSetCookies': Called when setting user cookies.
3364 &$session: session array, will be added to $_SESSION
3365 &$cookies: cookies array mapping cookie name to its value
3367 'UserSetEmail': Called when changing user email address.
3369 &$email: new email, change this to override new email address
3371 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3372 email authentication.
3374 &$timestamp: new timestamp, change this to override local email
3375 authentication timestamp
3377 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3378 "Foobar (Talk | Contribs | Block)".
3379 $userId: User id of the current user
3380 $userText: User name of the current user
3381 &$items: Array of user tool links as HTML fragments
3383 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3384 FormatMetadata::getExtendedMeta (return false means cache will be
3385 invalidated and GetExtendedMetadata hook called again).
3386 $timestamp: The timestamp metadata was generated
3387 $file: The file the metadata is for
3389 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3390 used to alter the SQL query which gets the list of wanted pages.
3391 &$wantedPages: WantedPagesPage object
3392 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3394 'WatchArticle': Before a watch is added to an article.
3395 &$user: user that will watch
3396 &$page: WikiPage object to be watched
3397 &$status: Status object to be returned if the hook returns false
3399 'WatchArticleComplete': After a watch is added to an article.
3400 &$user: user that watched
3401 &$page: WikiPage object watched
3403 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3404 form, used to manipulate the list of pages or preload data based on that list.
3405 &$watchlistInfo: array of watchlisted pages in
3406 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3408 'WatchlistEditorBuildRemoveLine': when building remove lines in
3409 Special:Watchlist/edit.
3410 &$tools: array of extra links
3411 $title: Title object
3412 $redirect: whether the page is a redirect
3414 &$link: HTML link to title
3416 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3418 $router: The PathRouter instance
3420 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3421 Return false to prevent setting of the cookie.
3422 &$name: Cookie name passed to WebResponse::setcookie()
3423 &$value: Cookie value passed to WebResponse::setcookie()
3424 &$expire: Cookie expiration, as for PHP's setcookie()
3425 $options: Options passed to WebResponse::setcookie()
3427 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3428 run a MediaWiki cli script.
3429 &$script: MediaWiki cli script path
3430 &$parameters: Array of arguments and options to the script
3431 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3434 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3435 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3436 &$qp: The list of QueryPages
3438 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3439 $row: The DB row of the entry.
3440 $title: The Title of the page where the link comes FROM
3441 $target: The Title of the page where the link goes TO
3442 &$props: Array of HTML strings to display after the title.
3444 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3445 dumps. One, and only one hook should set this, and return false.
3446 &$tables: Database tables to use in the SELECT query
3447 &$opts: Options to use for the query
3448 &$join: Join conditions
3450 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3451 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3452 specific to a content model should be provided by the respective Content's
3453 getDeletionUpdates() method.
3455 $content: the Content to generate updates for
3456 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3458 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3459 extra metadata to be added.
3460 $obj: The XmlDumpWriter object.
3461 &$out: The output string.
3462 $row: The database row for the page.
3463 $title: The title of the page.
3465 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3467 &$obj: The XmlDumpWriter object.
3468 &$out: The text being output.
3469 $row: The database row for the revision.
3470 $text: The revision text.
3472 More hooks might be available but undocumented, you can execute
3473 "php maintenance/findHooks.php" to find hidden ones.