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)
1097 $user: Current user object
1099 'DiffViewHeader': Called before diff display
1100 $diff: DifferenceEngine object that's calling
1101 $oldRev: Revision object of the "old" revision (may be null/invalid)
1102 $newRev: Revision object of the "new" revision
1104 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1106 &$article: article (object) being viewed
1107 &$oldid: oldid (int) being viewed
1109 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1110 Override the HTML generated for section edit links
1111 $skin: Skin object rendering the UI
1112 $title: Title object for the title being linked to (may not be the same as
1113 the page title, if the section is included from a template)
1114 $section: The designation of the section being pointed to, to be included in
1115 the link, like "§ion=$section"
1116 $tooltip: The default tooltip. Escape before using.
1117 By default, this is wrapped in the 'editsectionhint' message.
1118 &$result: The HTML to return, prefilled with the default plus whatever other
1119 changes earlier hooks have made
1120 $lang: The language code to use for the link in the wfMessage function
1122 'EditFilter': Perform checks on an edit
1123 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1124 $text: Contents of the edit box
1125 $section: Section being edited
1126 &$error: Error message to return
1127 $summary: Edit summary for page
1129 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1130 Post-section-merge edit filter.
1131 $editor: EditPage instance (object)
1132 $text: content of the edit box
1133 &$error: error message to return
1134 $summary: Edit summary for page
1136 'EditFilterMergedContent': Post-section-merge edit filter.
1137 This may be triggered by the EditPage or any other facility that modifies page
1138 content. Use the $status object to indicate whether the edit should be allowed,
1139 and to provide a reason for disallowing it. Return false to abort the edit, and
1140 true to continue. Returning true if $status->isOK() returns false means "don't
1141 save but continue user interaction", e.g. show the edit form.
1142 $status->apiHookResult can be set to an array to be returned by api.php
1143 action=edit. This is used to deliver captchas.
1144 $context: object implementing the IContextSource interface.
1145 $content: content of the edit box, as a Content object.
1146 $status: Status object to represent errors, etc.
1147 $summary: Edit summary for page
1148 $user: the User object representing the user whois performing the edit.
1149 $minoredit: whether the edit was marked as minor by the user.
1151 'EditFormInitialText': Allows modifying the edit form when editing existing
1153 $editPage: EditPage object
1155 'EditFormPreloadText': Allows population of the edit form when creating
1157 &$text: Text to preload with
1158 &$title: Title object representing the page being created
1160 'EditPage::attemptSave': Called before an article is
1161 saved, that is before WikiPage::doEditContent() is called
1162 $editpage_Obj: the current EditPage object
1164 'EditPage::attemptSave:after': Called after an article save attempt
1165 $editpage_Obj: the current EditPage object
1166 $status: the resulting Status object
1167 $resultDetails: Result details array
1169 'EditPage::importFormData': allow extensions to read additional data
1171 $editpage: EditPage instance
1172 $request: Webrequest
1173 return value is ignored (should always return true)
1175 'EditPage::showEditForm:fields': allows injection of form field into edit form
1176 Return value is ignored (should always return true)
1177 &$editor: the EditPage instance for reference
1178 &$out: an OutputPage instance to write to
1180 'EditPage::showEditForm:initial': before showing the edit form
1181 Return false to halt editing; you'll need to handle error messages, etc.
1182 yourself. Alternatively, modifying $error and returning true will cause the
1183 contents of $error to be echoed at the top of the edit form as wikitext.
1184 Return true without altering $error to allow the edit to proceed.
1185 &$editor: EditPage instance (object)
1186 &$out: an OutputPage instance to write to
1188 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1189 but for the read-only 'view source' variant of the edit form.
1190 Return value is ignored (should always return true)
1191 $editor: EditPage instance (object)
1192 &$out: an OutputPage instance to write to
1194 'EditPage::showStandardInputs:options': allows injection of form fields into
1195 the editOptions area
1196 Return value is ignored (should always be true)
1197 $editor: EditPage instance (object)
1198 $out: an OutputPage instance to write to
1199 &$tabindex: HTML tabindex of the last edit check/button
1201 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1202 when there's an edit conflict. Return false to halt normal diff output; in
1203 this case you're responsible for computing and outputting the entire "conflict"
1204 part, i.e., the "difference between revisions" and "your text" headers and
1206 &$editor: EditPage instance
1207 &$out: OutputPage instance
1209 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1210 textarea in the edit form.
1211 &$editpage: The current EditPage object
1212 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1213 &$tabindex: HTML tabindex of the last edit check/button
1215 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1217 &$editpage: The current EditPage object
1218 &$checks: Array of edit checks like "watch this page"/"minor edit"
1219 &$tabindex: HTML tabindex of the last edit check/button
1221 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1222 textarea in the edit form.
1223 &$toolbar: The toolbar HTMl
1225 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1226 contribution/copyright notice.
1227 $title: title of page being edited
1228 &$msg: localization message name, overridable. Default is either
1229 'copyrightwarning' or 'copyrightwarning2'.
1231 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1232 "Show changes". Note that it is preferable to implement diff handling for
1233 different data types using the ContentHandler facility.
1234 $editPage: EditPage object
1235 &$newtext: wikitext that will be used as "your version"
1237 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1238 Allow modifying the wikitext that will be used in "Show changes". Note that it
1239 is preferable to implement diff handling for different data types using the
1240 ContentHandler facility.
1241 $editPage: EditPage object
1242 &$newtext: wikitext that will be used as "your version"
1244 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1245 previewed. Note that it is preferable to implement previews for different data
1246 types using the ContentHandler facility.
1247 $editPage: EditPage object
1248 &$content: Content object to be previewed (may be replaced by hook function)
1250 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1251 Allow modifying the wikitext that will be previewed. Note that it is preferable
1252 to implement previews for different data types using the ContentHandler
1254 $editPage: EditPage object
1255 &$toparse: wikitext that will be parsed
1257 'EditPageNoSuchSection': When a section edit request is given for an
1258 non-existent section
1259 &$editpage: The current EditPage object
1260 &$res: the HTML of the error text
1262 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1263 of terms of service summary link that might exist separately from the copyright
1265 $title: title of page being edited
1266 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1268 'EmailConfirmed': When checking that the user's email address is "confirmed".
1269 This runs before the other checks, such as anonymity and the real check; return
1270 true to allow those checks to occur, and false if checking is done.
1271 &$user: User being checked
1272 &$confirmed: Whether or not the email address is confirmed
1274 'EmailUser': Before sending email from one user to another.
1275 &$to: MailAddress object of receiving user
1276 &$from: MailAddress object of sending user
1277 &$subject: subject of the mail
1278 &$text: text of the mail
1279 &$error: Out-param for an error
1281 'EmailUserCC': Before sending the copy of the email to the author.
1282 &$to: MailAddress object of receiving user
1283 &$from: MailAddress object of sending user
1284 &$subject: subject of the mail
1285 &$text: text of the mail
1287 'EmailUserComplete': After sending email from one user to another.
1288 $to: MailAddress object of receiving user
1289 $from: MailAddress object of sending user
1290 $subject: subject of the mail
1291 $text: text of the mail
1293 'EmailUserForm': After building the email user form object.
1294 &$form: HTMLForm object
1296 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1298 $user: The user who is trying to email another user.
1299 $editToken: The user's edit token.
1300 &$hookErr: Out-param for the error. Passed as the parameters to
1301 OutputPage::showErrorPage.
1303 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1304 group of changes in EnhancedChangesList.
1305 Hook subscribers can return false to omit this line from recentchanges.
1306 $changesList: EnhancedChangesList object
1307 &$links: The links that were generated by EnhancedChangesList
1308 $block: The RecentChanges objects in that block
1310 'EnhancedChangesListModifyLineData': to alter data used to build
1311 a grouped recent change inner line in EnhancedChangesList.
1312 Hook subscribers can return false to omit this line from recentchanges.
1313 $changesList: EnhancedChangesList object
1314 &$data: An array with all the components that will be joined in order to create the line
1315 $block: An array of RecentChange objects in that block
1316 $rc: The RecentChange object for this line
1318 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1319 a non-grouped recent change line in EnhancedChangesList.
1320 $changesList: EnhancedChangesList object
1321 &$data: An array with all the components that will be joined in order to create the line
1322 $rc: The RecentChange object for this line
1324 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1326 $ip: The ip address of the user
1328 'ExtensionTypes': Called when generating the extensions credits, use this to
1329 change the tables headers.
1330 &$extTypes: associative array of extensions types
1332 'ExtractThumbParameters': DEPRECATED! Media handler should override
1333 MediaHandler::parseParamString instead.
1334 Called when extracting thumbnail parameters from a thumbnail file name.
1335 $thumbname: the base name of the thumbnail file
1336 &$params: the currently extracted params (has source name, temp or archived
1339 'FetchChangesList': When fetching the ChangesList derivative for a particular
1341 $user: User the list is being fetched for
1342 &$skin: Skin object to be used with the list
1343 &$list: List object (defaults to NULL, change it to an object instance and
1344 return false override the list derivative used)
1346 'FileDeleteComplete': When a file is deleted.
1347 &$file: reference to the deleted file
1348 &$oldimage: in case of the deletion of an old image, the name of the old file
1349 &$article: in case all revisions of the file are deleted a reference to the
1350 WikiFilePage associated with the file.
1351 &$user: user who performed the deletion
1354 'FileTransformed': When a file is transformed and moved into storage.
1355 $file: reference to the File object
1356 $thumb: the MediaTransformOutput object
1357 $tmpThumbPath: The temporary file system path of the transformed file
1358 $thumbPath: The permanent storage path of the transformed file
1360 'FileUndeleteComplete': When a file is undeleted
1361 $title: title object to the file
1362 $fileVersions: array of undeleted versions. Empty if all versions were restored
1363 $user: user who performed the undeletion
1366 'FileUpload': When a file upload occurs.
1367 $file: Image object representing the file that was uploaded
1368 $reupload: Boolean indicating if there was a previously another image there or
1370 $hasDescription: Boolean indicating that there was already a description page
1371 and a new one from the comment wasn't created (since 1.17)
1373 'FormatAutocomments': When an autocomment is formatted by the Linker.
1374 &$comment: Reference to the accumulated comment. Initially null, when set the
1375 default code will be skipped.
1376 $pre: Boolean, true if there is text before this autocomment
1377 $auto: The extracted part of the parsed comment before the call to the hook.
1378 $post: Boolean, true if there is text after this autocomment
1379 $title: An optional title object used to links to sections. Can be null.
1380 $local: Boolean indicating whether section links should refer to local page.
1381 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1382 autocomment originated; null for the local wiki. Added in 1.26, should default
1383 to null in handler functions, for backwards compatibility.
1385 'GalleryGetModes': Get list of classes that can render different modes of a
1387 &$modeArray: An associative array mapping mode names to classes that implement
1388 that mode. It is expected all registered classes are a subclass of
1391 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1393 $user: user to promote.
1394 &$promote: groups that will be added.
1396 'GetBlockedStatus': after loading blocking status of an user from the database
1397 &$user: user (object) being checked
1399 'GetCacheVaryCookies': Get cookies that should vary cache options.
1400 $out: OutputPage object
1401 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1402 that have to vary cache options
1404 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1406 &$title: Title object of page
1407 &$url: string value as output (out parameter, can modify)
1408 $query: query options passed to Title::getCanonicalURL()
1410 'GetDefaultSortkey': Override the default sortkey for a page.
1411 $title: Title object that we need to get a sortkey for
1412 &$sortkey: Sortkey to use.
1414 'GetDifferenceEngine': Called when getting a new difference engine interface
1415 object Return false for valid object in $differenceEngine or true for the
1416 default difference engine.
1417 $context: IContextSource context to be used for diff
1418 $old: Revision ID to show and diff with
1419 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1420 $refreshCache: If set, refreshes the diff cache
1421 $unhide: If set, allow viewing deleted revs
1422 &$differenceEngine: output parameter, difference engine object to be used for
1425 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1426 underscore) magic words. Called by MagicWord.
1427 &$doubleUnderscoreIDs: array of strings
1429 'GetExtendedMetadata': Get extended file metadata for the API
1430 &$combinedMeta: Array of the form:
1431 'MetadataPropName' => array(
1432 value' => prop value,
1433 'source' => 'name of hook'
1435 $file: File object of file in question
1436 $context: RequestContext (including language to use)
1437 $single: Only extract the current language; if false, the prop value should
1438 be in the metadata multi-language array format:
1439 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1440 &$maxCacheTime: how long the results can be cached
1442 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1443 &$title: Title object of page
1444 &$url: string value as output (out parameter, can modify)
1445 $query: query options passed to Title::getFullURL()
1447 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1448 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1450 &$output: string for the output timestamp
1451 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1452 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1453 $user: User whose preferences are being used to make timestamp
1454 $lang: Language that will be used to render the timestamp
1456 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1457 &$title: Title object of page
1458 &$url: string value as output (out parameter, can modify)
1459 $query: query options passed to Title::getInternalURL()
1461 'GetIP': modify the ip of the current user (called only once).
1462 &$ip: string holding the ip as determined so far
1464 'GetLinkColours': modify the CSS class of an array of page links.
1465 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1467 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1469 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1470 working with internal urls (non-interwiki) then it may be preferable to work
1471 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1472 be buggy for internal urls on render if you do not re-implement the horrible
1473 hack that Title::getLocalURL uses in your own extension.
1474 &$title: Title object of page
1475 &$url: string value as output (out parameter, can modify)
1476 $query: query options passed to Title::getLocalURL()
1478 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1479 without any fancy queries or variants.
1480 &$title: Title object of page
1481 &$url: string value as output (out parameter, can modify)
1483 'GetLocalURL::Internal': Modify local URLs to internal pages.
1484 &$title: Title object of page
1485 &$url: string value as output (out parameter, can modify)
1486 $query: query options passed to Title::getLocalURL()
1488 'GetLogTypesOnUser': Add log types where the target is a userpage
1489 &$types: Array of log types
1491 'GetMetadataVersion': Modify the image metadata version currently in use. This
1492 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1493 that need to have versioned metadata should add an element to the end of the
1494 version array of the form 'handler_name=version'. Most media handlers won't need
1495 to do this unless they broke backwards compatibility with a previous version of
1496 the media handler metadata output.
1497 &$version: Array of version strings
1499 'GetNewMessagesAlert': Disable or modify the new messages alert
1500 &$newMessagesAlert: An empty string by default. If the user has new talk page
1501 messages, this should be populated with an alert message to that effect
1502 $newtalks: An empty array if the user has no new messages or an array
1503 containing links and revisions if there are new messages (See
1504 User::getNewMessageLinks)
1505 $user: The user object of the user who is loading the page
1506 $out: OutputPage object (to check what type of page the user is on)
1508 'GetPreferences': Modify user preferences.
1509 $user: User whose preferences are being modified.
1510 &$preferences: Preferences description array, to be fed to an HTMLForm object
1512 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1513 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1515 &$output: string for the output timestamp
1516 &$diff: DateInterval representing the difference between the timestamps
1517 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1518 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1519 $user: User whose preferences are being used to make timestamp
1520 $lang: Language that will be used to render the timestamp
1522 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1523 checked for. Use instead of userCan for most cases. Return false if the user
1524 can't do it, and populate $result with the reason in the form of
1525 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1526 might want to use ApiMessage to provide machine-readable details for the API).
1527 For consistency, error messages
1528 should be plain text with no special coloring, bolding, etc. to show that
1529 they're errors; presenting them properly to the user as errors is done by the
1531 &$title: Title object being checked against
1532 &$user: Current user object
1533 $action: Action being checked
1534 &$result: User permissions error to add. If none, return true.
1536 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1537 called only if expensive checks are enabled. Add a permissions error when
1538 permissions errors are checked for. Return false if the user can't do it, and
1539 populate $result with the reason in the form of array( messagename, param1,
1540 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1541 to provide machine-readable details for the API). For consistency, error
1542 messages should be plain text with no
1543 special coloring, bolding, etc. to show that they're errors; presenting them
1544 properly to the user as errors is done by the caller.
1545 &$title: Title object being checked against
1546 &$user: Current user object
1547 $action: Action being checked
1548 &$result: User permissions error to add. If none, return true.
1550 'GitViewers': Called when generating the list of git viewers for
1551 Special:Version, use this to change the list.
1552 &$extTypes: associative array of repo URLS to viewer URLs.
1554 'HistoryRevisionTools': Override or extend the revision tools available from the
1555 page history view, i.e. undo, rollback, etc.
1556 $rev: Revision object
1557 &$links: Array of HTML links
1558 $prevRev: Revision object, next in line in page history, or null
1559 $user: Current user object
1561 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1563 $context: An IContextSource object with information about the request being
1566 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1567 image insertion. You can skip the default logic entirely by returning false, or
1568 just modify a few things using call-by-reference.
1570 &$title: Title object of the image
1571 &$file: File object, or false if it doesn't exist
1572 &$frameParams: Various parameters with special meanings; see documentation in
1573 includes/Linker.php for Linker::makeImageLink
1574 &$handlerParams: Various parameters with special meanings; see documentation in
1575 includes/Linker.php for Linker::makeImageLink
1576 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1577 &$res: Final HTML output, used if you return false
1579 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1580 the image on an image page.
1581 &$imagePage: ImagePage object ($this)
1584 'ImagePageAfterImageLinks': Called after the image links section on an image
1586 $imagePage: ImagePage object ($this)
1587 &$html: HTML for the hook to add
1589 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1590 $imagePage: ImagePage object ($this)
1592 &$line: the HTML of the history line
1593 &$css: the line CSS class
1595 'ImagePageFindFile': Called when fetching the file associated with an image
1597 $page: ImagePage object
1599 &$displayFile: displayed File object
1601 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1602 $page: ImagePage object
1603 &$toc: Array of <li> strings
1605 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1607 &$title: the Title object of the file as it would appear for the upload page
1608 &$path: the original file and path name when img_auth was invoked by the web
1610 &$name: the name only component of the file
1611 &$result: The location to pass back results of the hook routine (only used if
1613 $result[0]=The index of the header message
1614 $result[1]=The index of the body text message
1615 $result[2 through n]=Parameters passed to body text message. Please note the
1616 header message cannot receive/use parameters.
1618 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1619 Return false to stop further processing of the tag
1620 $reader: XMLReader object
1621 $logInfo: Array of information
1623 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1624 Return false to stop further processing of the tag
1625 $reader: XMLReader object
1626 &$pageInfo: Array of information
1628 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1629 Return false to stop further processing of the tag
1630 $reader: XMLReader object
1631 $pageInfo: Array of page information
1632 $revisionInfo: Array of revision information
1634 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1635 Return false to stop further processing of the tag
1636 $reader: XMLReader object
1638 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1639 Return false to stop further processing of the tag
1640 $reader: XMLReader object
1641 $revisionInfo: Array of information
1643 'ImportSources': Called when reading from the $wgImportSources configuration
1644 variable. Can be used to lazy-load the import sources list.
1645 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1646 comment in DefaultSettings.php for the detail of how to structure this array.
1648 'InfoAction': When building information to display on the action=info page.
1649 $context: IContextSource object
1650 &$pageInfo: Array of information
1652 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1653 &$title: Title object for the current page
1654 &$request: WebRequest
1655 &$ignoreRedirect: boolean to skip redirect check
1656 &$target: Title/string of redirect target
1657 &$article: Article object
1659 'InternalParseBeforeLinks': during Parser's internalParse method before links
1660 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1661 &$parser: Parser object
1662 &$text: string containing partially parsed text
1663 &$stripState: Parser's internal StripState object
1665 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1666 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1667 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1668 template/parser function execution which respect nowiki and HTML-comments.
1669 &$parser: Parser object
1670 &$text: string containing partially parsed text
1671 &$stripState: Parser's internal StripState object
1673 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1674 Return true without providing an interwiki to continue interwiki search.
1675 $prefix: interwiki prefix we are looking for.
1676 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1677 iw_trans and optionally iw_api and iw_wikiid.
1679 'InvalidateEmailComplete': Called after a user's email has been invalidated
1681 $user: user (object) whose email is being invalidated
1683 'IRCLineURL': When constructing the URL to use in an IRC notification.
1684 Callee may modify $url and $query, URL will be constructed as $url . $query
1685 &$url: URL to index.php
1686 &$query: Query string
1687 $rc: RecentChange object that triggered url generation
1689 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1690 &$article: article (object) being checked
1692 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1693 &$ip: IP being check
1694 &$result: Change this value to override the result of IP::isTrustedProxy()
1696 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1697 $url: URL used to upload from
1698 &$allowed: Boolean indicating if uploading is allowed for given URL
1700 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1701 instance to return false if the domain name doesn't match your organization.
1702 $addr: The e-mail address entered by the user
1703 &$result: Set this and return false to override the internal checks
1705 'isValidPassword': Override the result of User::isValidPassword()
1706 $password: The password entered by the user
1707 &$result: Set this and return false to override the internal checks
1708 $user: User the password is being validated for
1710 'Language::getMessagesFileName':
1711 $code: The language code or the language we're looking for a messages file for
1712 &$file: The messages file path, you can override this to change the location.
1714 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1715 $wgExtensionMessagesFiles instead.
1716 Use this to define synonyms of magic words depending of the language
1717 &$magicExtensions: associative array of magic words synonyms
1718 $lang: language code (string)
1720 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1721 remove namespaces. Do not use this hook to add namespaces. Use
1722 CanonicalNamespaces for that.
1723 &$namespaces: Array of namespaces indexed by their numbers
1725 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1726 listed in $wgExtensionMessagesFiles instead.
1727 Use to define aliases of special pages names depending of the language
1728 &$specialPageAliases: associative array of magic words synonyms
1729 $lang: language code (string)
1731 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1732 &$names: array of language code => language name
1733 $code: language of the preferred translations
1735 'LanguageLinks': Manipulate a page's language links. This is called
1736 in various places to allow extensions to define the effective language
1738 $title: The page's Title.
1739 &$links: Associative array mapping language codes to prefixed links of the
1740 form "language:title".
1741 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1742 Currently unused, but planned to provide support for marking individual
1743 language links in the UI, e.g. for featured articles.
1745 'LanguageSelector': Hook to change the language selector available on a page.
1746 $out: The output page.
1747 $cssClassName: CSS class name of the language selector.
1749 'LinkBegin': Used when generating internal and interwiki links in
1750 Linker::link(), before processing starts. Return false to skip default
1751 processing and return $ret. See documentation for Linker::link() for details on
1752 the expected meanings of parameters.
1753 $skin: the Skin object
1754 $target: the Title that the link is pointing to
1755 &$html: the contents that the <a> tag should have (raw HTML); null means
1757 &$customAttribs: the HTML attributes that the <a> tag should have, in
1758 associative array form, with keys and values unescaped. Should be merged
1759 with default values, with a value of false meaning to suppress the
1761 &$query: the query string to add to the generated URL (the bit after the "?"),
1762 in associative array form, with keys and values unescaped.
1763 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1764 &$ret: the value to return if your hook returns false.
1766 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1767 just before the function returns a value. If you return true, an <a> element
1768 with HTML attributes $attribs and contents $html will be returned. If you
1769 return false, $ret will be returned.
1770 $skin: the Skin object
1771 $target: the Title object that the link is pointing to
1772 $options: the options. Will always include either 'known' or 'broken', and may
1773 include 'noclasses'.
1774 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1775 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1776 associative array form.
1777 &$ret: the value to return if your hook returns false.
1779 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1781 &$url: the image url
1782 &$alt: the image's alt text
1783 &$img: the new image HTML (if returning false)
1785 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1788 &$text: the link text
1789 &$link: the new link HTML (if returning false)
1790 &$attribs: the attributes to be applied.
1791 $linkType: The external link type
1793 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1795 $title: the Title object that the link is pointing to
1796 $file: the File object or false if broken link
1797 &$html: the link text
1798 &$attribs: the attributes to be applied
1799 &$ret: the value to return if your hook returns false
1801 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1803 &$linksUpdate: the LinksUpdate object
1805 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1806 each link table insert. For example, pagelinks, imagelinks, externallinks.
1807 $linksUpdate: LinksUpdate object
1808 $table: the table to insert links to
1809 $insertions: an array of links to insert
1811 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1812 including delete and insert, has completed for all link tables
1813 &$linksUpdate: the LinksUpdate object
1815 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1816 &$linksUpdate: the LinksUpdate object
1818 'ListDefinedTags': When trying to find all defined tags.
1819 &$tags: The list of tags.
1821 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1822 $updater: A DatabaseUpdater subclass
1824 'LocalFile::getHistory': Called before file history query performed.
1825 &$file: the File object
1827 &$fields: select fields
1829 &$opts: query options
1830 &$join_conds: JOIN conditions
1832 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1833 $file: the File object
1834 $archiveName: name of an old file version or false if it's the current one
1836 'LocalisationCacheRecache': Called when loading the localisation data into
1838 $cache: The LocalisationCache object
1839 $code: language code
1840 &$alldata: The localisation data from core and extensions
1841 &$purgeBlobs: whether to purge/update the message blobs via
1842 MessageBlobStore::clear()
1844 'LocalisationCacheRecacheFallback': Called for each language when merging
1845 fallback data into the cache.
1846 $cache: The LocalisationCache object
1847 $code: language code
1848 &$alldata: The localisation data from core and extensions. Note some keys may
1849 be omitted if they won't be merged into the final result.
1851 'LocalisationChecksBlacklist': When fetching the blacklist of
1852 localisation checks.
1853 &$blacklist: array of checks to blacklist. See the bottom of
1854 maintenance/language/checkLanguage.inc for the format of this variable.
1856 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1857 optional localisation messages
1858 &$ignored: Array of ignored message keys
1859 &$optional: Array of optional message keys
1861 'LocalUserCreated': Called when a local user has been created
1862 $user: User object for the created user
1863 $autocreated: Boolean, whether this was an auto-creation
1865 'LogEventsListGetExtraInputs': When getting extra inputs to display on
1866 Special:Log for a specific log type
1867 $type: String of log type being displayed
1868 $logEventsList: LogEventsList object for context and access to the WebRequest
1869 &$input: string HTML of an input element
1871 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1872 Returning false will prevent the string from being added to the OutputPage.
1873 &$s: html string to show for the log extract
1874 $types: String or Array Log types to show
1875 $page: String or Title The page title to show log entries for
1876 $user: String The user who made the log entries
1877 $param: Associative Array with the following additional options:
1878 - lim Integer Limit of items to show, default is 50
1879 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1880 - showIfEmpty boolean Set to false if you don't want any output in case the
1881 loglist is empty if set to true (default), "No matching items in log" is
1882 displayed if loglist is empty
1883 - msgKey Array If you want a nice box with a message, set this to the key of
1884 the message. First element is the message key, additional optional elements
1885 are parameters for the key that are processed with
1886 wfMessage()->params()->parseAsBlock()
1887 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1889 - wrap String Wrap the message in html (usually something like
1890 "<div ...>$1</div>").
1891 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1893 'LogException': Called before an exception (or PHP error) is logged. This is
1894 meant for integration with external error aggregation services; returning false
1895 will NOT prevent logging.
1896 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
1897 $suppressed: true if the error was suppressed via
1898 error_reporting()/wfSuppressWarnings()
1900 'LoginAuthenticateAudit': A login attempt for a valid user account either
1901 succeeded or failed. No return data is accepted; this hook is for auditing only.
1902 $user: the User object being authenticated against
1903 $password: the password being submitted and found wanting
1904 $retval: a LoginForm class constant with authenticateUserData() return
1905 value (SUCCESS, WRONG_PASS, etc.).
1907 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
1908 error messages. Allows to add additional error messages (except messages already
1909 in LoginForm::$validErrorMessages).
1910 &$messages: Already added messages (inclusive messages from
1911 LoginForm::$validErrorMessages)
1913 'LoginPasswordResetMessage': User is being requested to reset their password on
1914 login. Use this hook to change the Message that will be output on
1915 Special:ChangePassword.
1916 &$msg: Message object that will be shown to the user
1917 $username: Username of the user who's password was expired.
1919 'LoginUserMigrated': Called during login to allow extensions the opportunity to
1920 inform a user that their username doesn't exist for a specific reason, instead
1921 of letting the login form give the generic error message that the account does
1922 not exist. For example, when the account has been renamed or deleted.
1923 $user: the User object being authenticated against.
1924 &$msg: the message identifier for abort reason, or an array to pass a message
1927 'LogLine': Processes a single log entry on Special:Log.
1928 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1929 logging.log_type database field.
1930 $log_action: string for the type of log action (e.g. 'delete', 'block',
1931 'create2'). Corresponds to logging.log_action database field.
1932 $title: Title object that corresponds to logging.log_namespace and
1933 logging.log_title database fields.
1934 $paramArray: Array of parameters that corresponds to logging.log_params field.
1935 Note that only $paramArray[0] appears to contain anything.
1936 &$comment: string that corresponds to logging.log_comment database field, and
1937 which is displayed in the UI.
1938 &$revert: string that is displayed in the UI, similar to $comment.
1939 $time: timestamp of the log entry (added in 1.12)
1941 'LonelyPagesQuery': Allow extensions to modify the query used by
1942 Special:LonelyPages.
1943 &$tables: tables to join in the query
1944 &$conds: conditions for the query
1945 &$joinConds: join conditions for the query
1947 'MagicWordwgVariableIDs': When defining new magic words IDs.
1948 &$variableIDs: array of strings
1950 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1952 $refreshLinks: RefreshLinks object
1954 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1955 Ideally, this hook should only be used to add variables that depend on
1956 the current page/request; static configuration should be added through
1957 ResourceLoaderGetConfigVars instead.
1958 &$vars: variable (or multiple variables) to be added into the output of
1959 Skin::makeVariablesScript
1960 $out: The OutputPage which called the hook, can be used to get the real title.
1962 'MarkPatrolled': Before an edit is marked patrolled.
1963 $rcid: ID of the revision to be marked patrolled
1964 &$user: the user (object) marking the revision as patrolled
1965 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1966 sysop in order to mark an edit patrolled.
1967 $auto: true if the edit is being marked as patrolled automatically
1969 'MarkPatrolledComplete': After an edit is marked patrolled.
1970 $rcid: ID of the revision marked as patrolled
1971 &$user: user (object) who marked the edit patrolled
1972 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1973 sysop to patrol the edit.
1974 $auto: true if the edit is being marked as patrolled automatically
1976 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1977 something completely different, after the basic globals have been set up, but
1978 before ordinary actions take place.
1980 $article: Article on which the action will be performed
1981 $title: Title on which the action will be performed
1983 $request: $wgRequest
1984 $mediaWiki: The $mediawiki object
1986 'MessageCache::get': When fetching a message. Can be used to override the key
1987 for customisations. Given and returned message key must be in special format:
1988 1) first letter must be in lower case according to the content language.
1989 2) spaces must be replaced with underscores
1990 &$key: message key (string)
1992 'MessageCacheReplace': When a message page is changed. Useful for updating
1994 $title: name of the page changed.
1995 $text: new contents of the page.
1997 'MessagesPreLoad': When loading a message from the database.
1998 $title: title of the message (string)
1999 &$message: value (string), change it to the message you want to define
2001 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2002 $mimeMagic: Instance of MimeMagic.
2003 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2004 &$tail: More or equal than last 65558 bytes of the file in a string
2005 (in - Do not alter!).
2007 &$mime: MIME type (out).
2009 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2010 MIME type detected by considering the file extension.
2011 $mimeMagic: Instance of MimeMagic.
2012 $ext: File extension.
2013 &$mime: MIME type (in/out).
2015 'MimeMagicInit': Before processing the list mapping MIME types to media types
2016 and the list mapping MIME types to file extensions.
2017 As an extension author, you are encouraged to submit patches to MediaWiki's
2018 core to add new MIME types to mime.types.
2019 $mimeMagic: Instance of MimeMagic.
2020 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2021 for adding new MIME info to the list.
2022 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2023 for adding new MIME types to the list.
2025 'ModifyExportQuery': Modify the query used by the exporter.
2026 $db: The database object to be queried.
2027 &$tables: Tables in the query.
2028 &$conds: Conditions in the query.
2029 &$opts: Options for the query.
2030 &$join_conds: Join conditions for the query.
2032 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2034 $oldTitle: Title object of the current (old) location
2035 $newTitle: Title object of the new location
2036 $user: User making the move
2037 $reason: string of the reason provided by the user
2038 $status: Status object to pass error messages to
2040 'MovePageIsValidMove': Specify whether a page can be moved for technical
2042 $oldTitle: Title object of the current (old) location
2043 $newTitle: Title object of the new location
2044 $status: Status object to pass error messages to
2046 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2048 $index: Integer; the index of the namespace being checked.
2049 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2050 namespace are movable. Hooks may change this value to override the return
2051 value of MWNamespace::isMovable().
2053 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2054 $title: the diff page title (nullable)
2055 &$oldId: the actual old Id to use in the diff
2056 &$newId: the actual new Id to use in the diff (0 means current)
2057 $old: the ?old= param value from the url
2058 $new: the ?new= param value from the url
2060 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2062 $wikiPage: the WikiPage edited
2063 $rev: the new revision
2064 $baseID: the revision ID this was based off, if any
2065 $user: the editing user
2067 'NormalizeMessageKey': Called before the software gets the text of a message
2068 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
2070 &$key: the message being looked up. Change this to something else to change
2071 what message gets displayed (string)
2072 &$useDB: whether or not to look up the message in the database (bool)
2073 &$langCode: the language code to get the message for (string) - or -
2074 whether to use the content language (true) or site language (false) (bool)
2075 &$transform: whether or not to expand variables and templates
2076 in the message (bool)
2078 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2079 return false to omit the line from RecentChanges and Watchlist special pages.
2080 &$changeslist: The OldChangesList instance.
2081 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2082 $rc: The RecentChange object.
2083 &$classes: array of css classes for the <li> element
2085 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2086 can alter or append to the array of URLs for search & suggestion formats.
2087 &$urls: array of associative arrays with Url element attributes
2089 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2090 when a page view triggers a re-rendering of the page. This may happen
2091 particularly if the parser cache is split by user language, and no cached
2092 rendering of the page exists in the user's language. The hook is called
2093 before checking whether page_links_updated indicates that the links are up
2094 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2095 without triggering any updates.
2096 $page: the Page that was rendered.
2097 $title: the Title of the rendered page.
2098 $parserOutput: ParserOutput resulting from rendering the page.
2100 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2101 users and/or IP addresses too.
2102 &$otherBlockLink: An array with links to other block logs
2103 $ip: The requested IP address or username
2105 'OutputPageBeforeHTML': A page has been processed by the parser and the
2106 resulting HTML is about to be displayed.
2107 &$parserOutput: the parserOutput (object) that corresponds to the page
2108 &$text: the text that will be displayed, in HTML (string)
2110 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2111 body tag to allow for extensions to add attributes to the body of the page they
2112 might need. Or to allow building extensions to add body classes that aren't of
2113 high enough demand to be included in core.
2114 $out: The OutputPage which called the hook, can be used to get the real title
2115 $sk: The Skin that called OutputPage::headElement
2116 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2118 'OutputPageCheckLastModified': when checking if the page has been modified
2119 since the last visit.
2120 &$modifiedTimes: array of timestamps.
2121 The following keys are set: page, user, epoch
2123 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2124 categories. Implementations should return false if they generate the category
2125 links, so the default link generation is skipped.
2126 &$out: OutputPage instance (object)
2127 $categories: associative array, keys are category names, values are category
2128 types ("normal" or "hidden")
2129 &$links: array, intended to hold the result. Must be an associative array with
2130 category types as keys and arrays of HTML links as values.
2132 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2133 &$out: OutputPage instance (object)
2134 $parserOutput: parserOutput instance being added in $out
2136 'PageContentInsertComplete': After a new article is created.
2137 $wikiPage: WikiPage created
2138 $user: User creating the article
2139 $content: New content as a Content object
2140 $summary: Edit summary/comment
2141 $isMinor: Whether or not the edit was marked as minor
2142 $isWatch: (No longer used)
2143 $section: (No longer used)
2144 $flags: Flags passed to WikiPage::doEditContent()
2145 $revision: New Revision of the article
2147 'PageContentLanguage': Allows changing the language in which the content of a
2148 page is written. Defaults to the wiki content language ($wgContLang).
2149 $title: Title object
2150 &$pageLang: the page content language (either an object or a language code)
2151 $wgLang: the user language
2153 'PageContentSave': Before an article is saved.
2154 $wikiPage: the WikiPage (object) being saved
2155 $user: the user (object) saving the article
2156 $content: the new article content, as a Content object
2157 $summary: the article summary (comment)
2158 $isminor: minor flag
2159 $iswatch: watch flag
2162 'PageContentSaveComplete': After an article has been updated.
2163 $wikiPage: WikiPage modified
2164 $user: User performing the modification
2165 $content: New content, as a Content object
2166 $summary: Edit summary/comment
2167 $isMinor: Whether or not the edit was marked as minor
2168 $isWatch: (No longer used)
2169 $section: (No longer used)
2170 $flags: Flags passed to WikiPage::doEditContent()
2171 $revision: New Revision of the article (can be null for edits that change
2173 $status: Status object about to be returned by doEditContent()
2174 $baseRevId: the rev ID (or false) this edit was based on
2176 'PageHistoryBeforeList': When a history page list is about to be constructed.
2177 &$article: the article that the history is loading for
2178 $context: RequestContext object
2180 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2181 $historyAction: the action object
2182 &$row: the revision row for this line
2183 &$s: the string representing this parsed line
2184 &$classes: array containing the <li> element classes
2186 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2187 any output is generated, to allow batch lookups for prefetching information
2188 needed for display. If the hook handler returns false, the regular behavior of
2189 doBatchLookups() is skipped.
2190 $pager: the PageHistoryPager
2191 $result: a ResultWrapper representing the query result
2193 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2196 &$queryInfo: the query parameters
2198 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2199 which depends on user options should install this hook and append its values to
2201 &$confstr: reference to a hash key string which can be modified
2202 $user: User (object) requesting the page
2203 &$forOptions: array of options the hash is for
2205 'PageViewUpdates': Allow database (or other) changes to be made after a
2206 page view is seen by MediaWiki. Note this does not capture views made
2207 via external caches such as Squid.
2208 $wikipage: WikiPage (object) for the page being viewed.
2209 $user: User (object) for the user who is viewing.
2211 'ParserAfterParse': Called from Parser::parse() just after the call to
2212 Parser::internalParse() returns.
2213 &$parser: parser object
2214 &$text: text being parsed
2215 &$stripState: stripState used (object)
2217 'ParserAfterStrip': Called at end of parsing time.
2218 TODO: No more strip, deprecated ?
2219 &$parser: parser object
2220 &$text: text being parsed
2221 &$stripState: stripState used (object)
2223 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2224 &$parser: Parser object being used
2225 &$text: text that will be returned
2227 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2228 Parser::internalParseHalfParsed()
2229 &$parser: Parser object being used
2230 &$text: text that will be returned
2232 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2233 &$parser: Parser object
2234 &$text: text to parse
2235 &$stripState: StripState instance being used
2237 'ParserBeforeStrip': Called at start of parsing time.
2238 TODO: No more strip, deprecated ?
2239 &$parser: parser object
2240 &$text: text being parsed
2241 &$stripState: stripState used (object)
2243 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2244 &$parser: Parser object being used
2247 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2249 $parserCache: ParserCache object $parserOutput was stored in
2250 $parserOutput: ParserOutput object that was stored
2251 $title: Title of the page that was parsed to generate $parserOutput
2252 $popts: ParserOptions used for generating $parserOutput
2253 $revId: ID of the revision that was parsed to create $parserOutput
2255 'ParserClearState': Called at the end of Parser::clearState().
2256 &$parser: Parser object being cleared
2258 'ParserCloned': Called when the parser is cloned.
2259 $parser: Newly-cloned Parser object
2261 'ParserFirstCallInit': Called when the parser initialises for the first time.
2262 &$parser: Parser object being cleared
2264 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2266 &$parser: Parser object
2267 &$varCache: array to store the value in case of multiples calls of the
2269 &$index: index (string) of the magic
2270 &$ret: value of the magic word (the hook should set it)
2271 &$frame: PPFrame object to use for expanding any template variables
2273 'ParserGetVariableValueTs': Use this to change the value of the time for the
2274 {{LOCAL...}} magic word.
2275 &$parser: Parser object
2276 &$time: actual time (timestamp)
2278 'ParserGetVariableValueVarCache': use this to change the value of the variable
2279 cache or return false to not use it.
2280 &$parser: Parser object
2281 &$varCache: variable cache (array)
2283 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2284 ParserLimitReportFormat instead.
2285 Called at the end of Parser:parse() when the parser will
2286 include comments about size of the text parsed.
2287 $parser: Parser object
2288 &$limitReport: text that will be included (without comment tags)
2290 'ParserLimitReportFormat': Called for each row in the parser limit report that
2291 needs formatting. If nothing handles this hook, the default is to use "$key" to
2292 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2294 $key: Key for the limit report item (string)
2295 &$value: Value of the limit report item
2296 &$report: String onto which to append the data
2297 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2298 text intended for display in a monospaced font.
2299 $localize: If false, $report should be output in English.
2301 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2302 will include comments about size of the text parsed. Hooks should use
2303 $output->setLimitReportData() to populate data. Functions for this hook should
2304 not use $wgLang; do that in ParserLimitReportFormat instead.
2305 $parser: Parser object
2306 $output: ParserOutput object
2308 'ParserMakeImageParams': Called before the parser make an image link, use this
2309 to modify the parameters of the image.
2310 $title: title object representing the file
2311 $file: file object that will be used to create the image
2312 &$params: 2-D array of parameters
2313 $parser: Parser object that called the hook
2315 'ParserSectionCreate': Called each time the parser creates a document section
2316 from wikitext. Use this to apply per-section modifications to HTML (like
2317 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2318 can begin in one section and end in another. Make sure your code can handle
2319 that case gracefully. See the EditSectionClearerLink extension for an example.
2320 $parser: the calling Parser instance
2321 $section: the section number, zero-based, but section 0 is usually empty
2322 &$sectionContent: ref to the content of the section. modify this.
2323 $showEditLinks: boolean describing whether this section has an edit link
2325 'ParserTestGlobals': Allows to define globals for parser tests.
2326 &$globals: Array with all the globals which should be set for parser tests.
2327 The arrays keys serve as the globals names, its values are the globals values.
2329 'ParserTestParser': Called when creating a new instance of Parser in
2330 tests/parser/parserTest.inc.
2331 &$parser: Parser object created
2333 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2334 run. Use when page save hooks require the presence of custom tables to ensure
2335 that tests continue to run properly.
2336 &$tables: array of table names
2338 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2339 $user: User object whose policy you are modifying
2340 &$effectivePolicy: Array of policy statements that apply to this user
2341 $purpose: string indicating purpose of the check, one of 'login', 'create',
2344 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2346 $block: Block object (which is set to be autoblocking)
2347 &$blockIds: Array of block IDs of the autoblock
2349 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2350 my talk page, my contributions" etc).
2351 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2352 &$title: Title object representing the current page
2353 $skin: SkinTemplate object providing context (e.g. to check if the user is
2356 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2357 &$user: User performing the action
2358 $action: Action being performed
2359 &$result: Whether or not the action should be prevented
2360 Change $result and return false to give a definitive answer, otherwise
2361 the built-in rate limiting checks are used, if enabled.
2362 $incrBy: Amount to increment counter by
2364 'PlaceNewSection': Override placement of new sections. Return false and put the
2365 merged text into $text to override the default behavior.
2366 $wikipage: WikiPage object
2367 $oldtext: the text of the article before editing
2368 $subject: subject of the new section
2369 &$text: text of the new section
2371 'PostLoginRedirect': Modify the post login redirect behavior.
2372 Occurs after signing up or logging in, allows for interception of redirect.
2373 &$returnTo: The page name to return to, as a string
2374 &$returnToQuery: array of url parameters, mapping parameter names to values
2375 &$type: type of login redirect as string;
2376 error: display a return to link ignoring $wgRedirectOnLogin
2377 signup: display a return to link using $wgRedirectOnLogin if needed
2378 success: display a return to link using $wgRedirectOnLogin if needed
2379 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2381 'PreferencesFormPreSave': Override preferences being saved
2382 $formData: array of user submitted data
2383 $form: PreferencesForm object, also a ContextSource
2384 $user: User object with preferences to be saved set
2385 &$result: boolean indicating success
2387 'PreferencesGetLegend': Override the text used for the <legend> of a
2388 preferences section.
2389 $form: the PreferencesForm object. This is a ContextSource as well
2390 $key: the section name
2391 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2394 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2395 AJAX search suggestions. Put results into &$results outparam and return false.
2396 $ns: array of int namespace keys to search in
2397 $search: search term (not guaranteed to be conveniently normalized)
2398 $limit: maximum number of results to return
2399 &$results: out param: array of page names (strings)
2400 $offset: number of results to offset from the beginning
2402 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2403 namespace from the search string so that extensions can attempt it.
2404 &$namespaces: array of int namespace keys to search in (change this if you can
2406 &$search: search term (replace this with term without the namespace if you can
2409 'PrefsEmailAudit': Called when user changes their email address.
2410 $user: User (object) changing his email address
2411 $oldaddr: old email address (string)
2412 $newaddr: new email address (string)
2414 'PrefsPasswordAudit': Called when user changes his password.
2415 $user: User (object) changing his password
2416 $newPass: new password
2417 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2419 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2421 $article: the title being (un)protected
2422 &$output: a string of the form HTML so far
2424 'ProtectionForm::save': Called when a protection form is submitted.
2425 $article: the Page being (un)protected
2426 &$errorMsg: an html message string of an error or an array of message name and
2428 $reasonstr: a string describing the reason page protection level is altered
2430 'ProtectionForm::showLogExtract': Called after the protection log extract is
2432 $article: the page the form is shown for
2433 $out: OutputPage object
2435 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2437 &$tables: Database tables to be used in the query
2438 &$conds: Conditions to be applied in the query
2439 &$joinConds: Join conditions to be applied in the query
2441 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2442 &$obj: RawAction object
2443 &$text: The text that's going to be the output
2445 'RecentChange_save': Called at the end of RecentChange::save().
2446 &$recentChange: RecentChange object
2448 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2449 names such as "oldid" that are preserved when using redirecting special pages
2450 such as Special:MyPage and Special:MyTalk.
2451 &$redirectParams: An array of parameters preserved by redirecting special pages.
2453 'RejectParserCacheValue': Return false to reject an otherwise usable
2454 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2455 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2457 $parserOutput: ParserOutput value.
2458 $wikiPage: WikiPage object.
2459 $parserOptions: ParserOptions object.
2461 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2462 instance. Can be used by an extension override what skin is used in certain
2464 $context: (IContextSource) The RequestContext the skin is being created for.
2465 &$skin: A variable reference you may set a Skin instance or string key on to
2466 override the skin that will be used for the context.
2468 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2469 $user: The user having their password expiration reset
2470 &$newExpire: The new expiration date
2472 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2473 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2474 to override its behavior. See the module docs for more information.
2475 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2477 $context: ResourceLoaderContext|null
2479 'ResourceLoaderGetConfigVars': Called at the end of
2480 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2481 configuration variables to JavaScript. Things that depend on the current page
2482 or request state must be added through MakeGlobalVariablesScript instead.
2483 &$vars: array( variable name => value )
2485 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2486 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2487 context-based variables.
2488 &$lessVars: array of variables already added
2490 'ResourceLoaderRegisterModules': Right before modules information is required,
2491 such as when responding to a resource
2492 loader request or generating HTML output.
2493 &$resourceLoader: ResourceLoader object
2495 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2496 called after the addition of 'qunit' and MediaWiki testing resources.
2497 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2498 included in core, is fed using tests/qunit/QUnitTestResources.php.
2499 To add a new qunit module named 'myext.tests':
2500 $testModules['qunit']['myext.tests'] = array(
2501 'script' => 'extension/myext/tests.js',
2502 'dependencies' => <any module dependency you might have>
2504 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2505 added to any module.
2506 &$ResourceLoader: object
2508 'RevisionInsertComplete': Called after a revision is inserted into the database.
2509 &$revision: the Revision
2510 $data: the data stored in old_text. The meaning depends on $flags: if external
2511 is set, it's the URL of the revision text in external storage; otherwise,
2512 it's the revision text itself. In either case, if gzip is set, the revision
2514 $flags: a comma-delimited list of strings representing the options used. May
2515 include: utf8 (this will always be set for new revisions); gzip; external.
2517 'SearchableNamespaces': An option to modify which namespaces are searchable.
2518 &$arr: Array of namespaces ($nsId => $name) which will be used.
2520 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2521 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2523 $term: Search term string
2524 &$title: Outparam; set to $title object and return false for a match
2526 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2527 if nothing was found.
2528 $term: Search term string
2529 &$title: Outparam; set to $title object and return false for a match
2531 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2532 the normal operations.
2533 $allSearchTerms: Array of the search terms in all content languages
2534 &$titleResult: Outparam; the value to return. A Title object or null.
2536 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2538 $term: Search term string
2539 &$title: Current Title object that is being returned (null if none found).
2541 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2543 $title: Current Title object being displayed in search results.
2544 &$id: Revision ID (default is false, for latest)
2546 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2547 perform when page content is modified. Currently called by
2548 AbstractContent::getSecondaryDataUpdates.
2549 $title: Title of the page that is being edited.
2550 $oldContent: Content object representing the page's content before the edit.
2551 $recursive: bool indicating whether DataUpdates should trigger recursive
2552 updates (relevant mostly for LinksUpdate).
2553 $parserOutput: ParserOutput representing the rendered version of the page
2555 &$updates: a list of DataUpdate objects, to be modified or replaced by
2558 'SelfLinkBegin': Called before a link to the current article is displayed to
2559 allow the display of the link to be customized.
2560 $nt: the Title object
2561 &$html: html to display for the link
2562 &$trail: optional text to display before $html
2563 &$prefix: optional text to display after $html
2564 &$ret: the value to return if your hook returns false
2566 'SendWatchlistEmailNotification': Return true to send watchlist email
2568 $targetUser: the user whom to send watchlist email notification
2569 $title: the page title
2570 $enotif: EmailNotification object
2572 'SetupAfterCache': Called in Setup.php, after cache objects are set
2574 'ShowMissingArticle': Called when generating the output for a non-existent page.
2575 $article: The article object corresponding to the page
2577 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2578 Customise the output of raw CSS and JavaScript in page views.
2579 $text: Text being shown
2580 $title: Title of the custom script/stylesheet page
2581 $output: Current OutputPage object
2583 'ShowSearchHit': Customize display of search hit.
2584 $searchPage: The SpecialSearch instance.
2585 $result: The SearchResult to show
2586 $terms: Search terms, for highlighting
2587 &$link: HTML of link to the matching page. May be modified.
2588 &$redirect: HTML of redirect info. May be modified.
2589 &$section: HTML of matching section. May be modified.
2590 &$extract: HTML of content extract. May be modified.
2591 &$score: HTML of score. May be modified.
2592 &$size: HTML of page size. May be modified.
2593 &$date: HTML of of page modification date. May be modified.
2594 &$related: HTML of additional info for the matching page. May be modified.
2595 &$html: May be set to the full HTML that should be used to represent the search
2596 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2597 function returned false.
2599 'ShowSearchHitTitle': Customise display of search hit title/link.
2600 &$title: Title to link to
2601 &$text: Text to use for the link
2602 $result: The search result
2603 $terms: The search terms entered
2604 $page: The SpecialSearch object
2605 &$query: Query string to be appended to the link
2607 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2608 Warning: This hook is run on each display. You should consider to use
2609 'SkinBuildSidebar' that is aggressively cached.
2611 &$bar: Sidebar content
2612 Modify $bar to add or modify sidebar portlets.
2614 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2615 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2616 the sitenotice/anonnotice.
2619 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2620 allow the normal method of notice selection/rendering to work, or change the
2621 value of $siteNotice and return false to alter it.
2622 &$siteNotice: HTML returned as the sitenotice
2625 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2627 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2628 the stock bottom scripts.
2630 'SkinAfterContent': Allows extensions to add text after the page content and
2631 article metadata. This hook should work in all skins. Set the &$data variable to
2632 the text you're going to add.
2633 &$data: (string) Text to be printed out directly (without parsing)
2636 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2638 &$bar: Sidebar contents
2639 Modify $bar to add or modify sidebar portlets.
2641 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2643 $title: displayed page title
2644 $type: 'normal' or 'history' for old/diff views
2645 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2646 message must be in HTML format, not wikitext!
2647 &$link: overridable HTML link to be passed into the message as $1
2648 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2651 'SkinEditSectionLinks': Modify the section edit links
2652 $skin: Skin object rendering the UI
2653 $title: Title object for the title being linked to (may not be the same as
2654 the page title, if the section is included from a template)
2655 $section: The designation of the section being pointed to, to be included in
2656 the link, like "§ion=$section"
2657 $tooltip: The default tooltip. Escape before using.
2658 By default, this is wrapped in the 'editsectionhint' message.
2659 &$result: Array containing all link detail arrays. Each link detail array should
2660 contain the following keys:
2661 - targetTitle - Target Title object
2662 - text - String for the text
2663 - attribs - Array of attributes
2664 - query - Array of query parameters to add to the URL
2665 - options - Array of options for Linker::link
2666 $lang: The language code to use for the link in the wfMessage function
2668 'SkinGetPoweredBy': TODO
2669 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2670 the MediaWiki icon but plain text instead.
2673 'SkinPreloadExistence': Supply titles that should be added to link existence
2674 cache before the page is rendered.
2675 &$titles: Array of Title objects
2678 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2679 If false is returned $subpages will be used instead of the HTML
2680 subPageSubtitle() generates.
2681 If true is returned, $subpages will be ignored and the rest of
2682 subPageSubtitle() will run.
2683 &$subpages: Subpage links HTML
2685 $out: OutputPage object
2687 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2689 &$sktemplate: SkinTemplate object
2690 &$nav_urls: array of tabs
2691 &$revid: The revision id of the permanent link
2692 &$revid2: The revision id of the permanent link, second time
2694 'SkinTemplateGetLanguageLink': After building the data for a language link from
2695 which the actual html is constructed.
2696 &$languageLink: array containing data about the link. The following keys can be
2697 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2698 $languageLinkTitle: Title object belonging to the external language link.
2699 $title: Title object of the page the link belongs to.
2700 $outputPage: The OutputPage object the links are built from.
2702 'SkinTemplateNavigation': Called on content pages after the tabs have been
2703 added, but before variants have been added.
2704 &$sktemplate: SkinTemplate object
2705 &$links: Structured navigation links. This is used to alter the navigation for
2706 skins which use buildNavigationUrls such as Vector.
2708 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2709 tab is added but before variants have been added.
2710 &$sktemplate: SkinTemplate object
2711 &$links: Structured navigation links. This is used to alter the navigation for
2712 skins which use buildNavigationUrls such as Vector.
2714 'SkinTemplateNavigation::Universal': Called on both content and special pages
2715 after variants have been added.
2716 &$sktemplate: SkinTemplate object
2717 &$links: Structured navigation links. This is used to alter the navigation for
2718 skins which use buildNavigationUrls such as Vector.
2720 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2722 &$sktemplate: SkinTemplate object
2723 &$tpl: QuickTemplate engine object
2725 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2726 &$sktemplate: SkinTemplate object
2727 &$res: set to true to prevent active tabs
2729 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2730 You can either create your own array, or alter the parameters for
2732 &$sktemplate: The SkinTemplate instance.
2733 $title: Title instance for the page.
2734 $message: Visible label of tab.
2735 $selected: Whether this is a selected tab.
2736 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2737 &$classes: Array of CSS classes to apply.
2738 &$query: Query string to add to link.
2740 &$result: Complete assoc. array if you want to return true.
2742 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2743 been rendered (useful for adding more).
2744 &$sk: The QuickTemplate based skin template running the hook.
2745 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2746 extensions that add support for BaseTemplateToolbox should watch for this
2747 dummy parameter with "$dummy=false" in their code and return without echoing
2748 any HTML to avoid creating duplicate toolbox items.
2750 'SoftwareInfo': Called by Special:Version for returning information about the
2752 &$software: The array of software in format 'name' => 'version'. See
2753 SpecialVersion::softwareInformation().
2755 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2756 $sp: SpecialPage object, for context
2757 &$fields: Current HTMLForm fields
2759 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2760 $id: User id number, only provided for backwards-compatibility
2761 $user: User object representing user contributions are being fetched for
2762 $sp: SpecialPage instance, providing context
2764 'SpecialListusersDefaultQuery': Called right before the end of
2765 UsersPager::getDefaultQuery().
2766 $pager: The UsersPager instance
2767 &$query: The query array to be returned
2769 'SpecialListusersFormatRow': Called right before the end of
2770 UsersPager::formatRow().
2771 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2772 $row: Database row object
2774 'SpecialListusersHeader': Called before closing the <fieldset> in
2775 UsersPager::getPageHeader().
2776 $pager: The UsersPager instance
2777 &$out: The header HTML
2779 'SpecialListusersHeaderForm': Called before adding the submit button in
2780 UsersPager::getPageHeader().
2781 $pager: The UsersPager instance
2782 &$out: The header HTML
2784 'SpecialListusersQueryInfo': Called right before the end of.
2785 UsersPager::getQueryInfo()
2786 $pager: The UsersPager instance
2787 &$query: The query array to be returned
2789 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2790 $type: String of the log type
2791 $request: WebRequest object for getting the value provided by the current user
2792 &$qc: Array for query conditions to add
2794 'SpecialMovepageAfterMove': Called after moving a page.
2795 &$movePage: MovePageForm object
2796 &$oldTitle: old title (object)
2797 &$newTitle: new title (object)
2799 'SpecialNewpagesConditions': Called when building sql query for
2801 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2802 $opts: FormOptions object containing special page options
2803 &$conds: array of WHERE conditionals for query
2804 &$tables: array of tables to be queried
2805 &$fields: array of columns to select
2806 &$join_conds: join conditions for the tables
2808 'SpecialNewPagesFilters': Called after building form options at NewPages.
2809 $special: the special page object
2810 &$filters: associative array of filter definitions. The keys are the HTML
2811 name/URL parameters. Each key maps to an associative array with a 'msg'
2812 (message key) and a 'default' value.
2814 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
2815 this hook to remove a core special page or conditionally register special pages.
2816 &$list: list (array) of core special pages
2818 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2819 $special: the SpecialPage object
2820 $subPage: the subpage string or null if no subpage was specified
2822 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2823 $special: the SpecialPage object
2824 $subPage: the subpage string or null if no subpage was specified
2826 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2827 $name: name of the special page
2828 &$form: HTMLForm object
2830 'SpecialPasswordResetOnSubmit': When executing a form submission on
2831 Special:PasswordReset.
2832 &$users: array of User objects.
2833 $data: array of data submitted by the user
2834 &$error: string, error code (message key) used to describe to error (out
2835 parameter). The hook needs to return false when setting this, otherwise it
2836 will have no effect.
2838 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2839 use this to change some selection criteria or substitute a different title.
2840 &$randstr: The random number from wfRandom()
2841 &$isRedir: Boolean, whether to select a redirect or non-redirect
2842 &$namespaces: An array of namespace indexes to get the title from
2843 &$extra: An array of extra SQL statements
2844 &$title: If the hook returns false, a Title object to use instead of the
2845 result from the normal query
2847 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2849 Called after building form options at RecentChanges.
2850 $special: the special page object
2851 &$filters: associative array of filter definitions. The keys are the HTML
2852 name/URL parameters. Each key maps to an associative array with a 'msg'
2853 (message key) and a 'default' value.
2855 'SpecialRecentChangesPanel': Called when building form options in
2856 SpecialRecentChanges.
2857 &$extraOpts: array of added items, to which can be added
2858 $opts: FormOptions for this request
2860 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
2862 Called when building SQL query for SpecialRecentChanges and
2863 SpecialRecentChangesLinked.
2864 &$conds: array of WHERE conditionals for query
2865 &$tables: array of tables to be queried
2866 &$join_conds: join conditions for the tables
2867 $opts: FormOptions for this request
2868 &$query_options: array of options for the database request
2869 &$select: Array of columns to select
2871 'SpecialResetTokensTokens': Called when building token list for
2873 &$tokens: array of token information arrays in the format of
2875 'preference' => '<preference-name>',
2876 'label-message' => '<message-key>',
2879 'SpecialSearchCreateLink': Called when making the message to create a page or
2880 go to the existing page.
2881 $t: title object searched for
2882 &$params: an array of the default message name and page title (as parameter)
2884 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2885 target doesn't exist.
2886 &$title: title object generated from the text entered by the user
2888 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2889 the advanced form, a.k.a. power search box.
2890 &$showSections: an array to add values with more options to
2891 $term: the search term (not a title object)
2892 $opts: an array of hidden options (containing 'redirs' and 'profile')
2894 'SpecialSearchProfileForm': Allows modification of search profile forms.
2895 $search: special page object
2896 &$form: String: form html
2897 $profile: String: current search profile
2898 $term: String: search term
2899 $opts: Array: key => value of hidden options for inclusion in custom forms
2901 'SpecialSearchProfiles': Allows modification of search profiles.
2902 &$profiles: profiles, which can be modified.
2904 'SpecialSearchResults': Called before search result display
2905 $term: string of search term
2906 &$titleMatches: empty or SearchResultSet object
2907 &$textMatches: empty or SearchResultSet object
2909 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2910 on the search results page. Useful for including an external search
2911 provider. To disable the output of MediaWiki search output, return
2913 $specialSearch: SpecialSearch object ($this)
2915 $term: Search term specified by the user
2917 'SpecialSearchResultsAppend': Called immediately before returning HTML
2918 on the search results page. Useful for including a feedback link.
2919 $specialSearch: SpecialSearch object ($this)
2921 $term: Search term specified by the user
2923 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2924 $search: SpecialSearch special page object
2925 $profile: String: current search profile
2926 $engine: the search engine
2928 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2929 &$extraStats: Array to save the new stats
2930 $extraStats['<name of statistic>'] => <value>;
2931 <value> can be an array with the keys "name" and "number":
2932 "name" is the HTML to be displayed in the name column
2933 "number" is the number to be displayed.
2934 or, <value> can be the number to be displayed and <name> is the
2935 message key to use in the name column,
2936 $context: IContextSource object
2938 'SpecialUploadComplete': Called after successfully uploading a file from
2940 &$form: The SpecialUpload object
2942 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2943 $wgVersion: Current $wgVersion for you to use
2944 &$versionUrl: Raw url to link to (eg: release notes)
2946 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2948 Called after building form options at Watchlist.
2949 $special: the special page object
2950 &$filters: associative array of filter definitions. The keys are the HTML
2951 name/URL parameters. Each key maps to an associative array with a 'msg'
2952 (message key) and a 'default' value.
2954 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2955 SpecialWatchlist. Allows extensions to register custom values they have
2956 inserted to rc_type so they can be returned as part of the watchlist.
2957 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2959 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
2960 Called when building sql query for SpecialWatchlist.
2961 &$conds: array of WHERE conditionals for query
2962 &$tables: array of tables to be queried
2963 &$join_conds: join conditions for the tables
2964 &$fields: array of query fields
2965 $opts: A FormOptions object with watchlist options for the current request
2967 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2968 URL for a title when we have no other parameters on the URL. Gives a chance for
2969 extensions that alter page view behavior radically to abort that redirect or
2971 $request: WebRequest
2972 $title: Title of the currently found title obj
2973 $output: OutputPage object
2975 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2976 rendered (by ThumbnailImage:toHtml method).
2977 $thumbnail: the ThumbnailImage object
2978 &$attribs: image attribute array
2979 &$linkAttribs: image link attribute array
2981 'TitleArrayFromResult': Called when creating an TitleArray object from a
2983 &$titleArray: set this to an object to override the default object returned
2984 $res: database result used to create the object
2986 'TitleExists': Called when determining whether a page exists at a given title.
2987 $title: The title being tested.
2988 &$exists: Whether the title exists.
2990 'TitleGetEditNotices': Allows extensions to add edit notices
2991 $title: The Title object for the page the edit notices are for
2992 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2993 &$notices: Array of notices. Keys are i18n message keys, values are
2994 parseAsBlock()ed messages.
2996 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2997 that can be applied.
2998 $title: The title in question.
2999 &$types: The types of protection available.
3001 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3002 overriding default behavior for determining if a page exists. If $isKnown is
3003 kept as null, regular checks happen. If it's a boolean, this value is returned
3004 by the isKnown method.
3005 $title: Title object that is being checked
3006 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3008 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3009 Called when determining if a page is a CSS or JS page.
3010 $title: Title object that is being checked
3011 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3012 Hooks may change this value to override the return value of
3013 Title::isCssOrJsPage().
3015 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3016 that this hook is not called for interwiki pages or pages in immovable
3017 namespaces: for these, isMovable() always returns false.
3018 $title: Title object that is being checked
3019 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3020 Hooks may change this value to override the return value of
3023 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3024 Called when determining if a page is a wikitext or should
3025 be handled by separate handler (via ArticleViewCustom).
3026 $title: Title object that is being checked
3027 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3028 Hooks may change this value to override the return value of
3029 Title::isWikitextPage()
3031 'TitleMove': Before moving an article (title).
3034 $user: user who does the move
3036 'TitleMoveComplete': After moving an article (title), post-commit.
3039 &$user: user who did the move
3040 $pageid: database ID of the page that's been moved
3041 $redirid: database ID of the created redirect
3042 $reason: reason for the move
3043 $revision: the Revision created by the move
3045 'TitleMoveCompleting': After moving an article (title), pre-commit.
3048 $user: user who did the move
3049 $pageid: database ID of the page that's been moved
3050 $redirid: database ID of the created redirect
3051 $reason: reason for the move
3052 $revision: the Revision created by the move
3054 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3055 or override the quick permissions check.
3056 $title: The Title object being accessed
3057 $user: The User performing the action
3058 $action: Action being performed
3059 &$errors: Array of errors
3060 $doExpensiveQueries: Whether to do expensive DB queries
3061 $short: Whether to return immediately on first error
3063 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3064 adding the default error message if nothing allows the user to read the page. If
3065 a handler wants a title to *not* be whitelisted, it should also return false.
3066 $title: Title object being checked against
3067 $user: Current user object
3068 &$whitelisted: Boolean value of whether this title is whitelisted
3070 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3071 $title: Title object to purge
3072 &$urls: An array of URLs to purge from the caches, to be manipulated.
3074 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3075 PageArchive object has been created but before any further processing is done.
3076 &$archive: PageArchive object
3077 $title: Title object of the page that we're viewing
3079 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3080 PageArchive object has been created but before any further processing is done.
3081 &$archive: PageArchive object
3082 $title: Title object of the page that we're viewing
3084 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3085 the site is not in read-only mode, that the Title object is not null and after
3086 a PageArchive object has been constructed but before performing any further
3088 &$archive: PageArchive object
3089 $title: Title object of the page that we're about to undelete
3091 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3092 $title: title object related to the revision
3093 $rev: revision (object) that will be viewed
3095 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3096 Since 1.24: Paths pointing to a directory will be recursively scanned for
3097 test case files matching the suffix "Test.php".
3098 &$paths: list of test cases and directories to search.
3100 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3102 $action: action name
3103 $article: article "acted on"
3105 'UnwatchArticle': Before a watch is removed from an article.
3106 &$user: user watching
3107 &$page: WikiPage object to be removed
3108 &$status: Status object to be returned if the hook returns false
3110 'UnwatchArticleComplete': After a watch is removed from an article.
3111 $user: user that watched
3112 &$page: WikiPage object that was watched
3114 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3115 &$formattedPageStatus: list of valid page states
3117 'UploadComplete': Upon completion of a file upload.
3118 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3119 $uploadBase->getLocalFile().
3121 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3122 $type: (string) the requested upload type
3123 &$className: the class name of the Upload instance to be created
3125 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3126 poke at member variables like $mUploadDescription before the file is saved. Do
3127 not use this hook to break upload processing. This will return the user to a
3128 blank form with no error message; use UploadVerification and UploadVerifyFile
3130 &$form: UploadForm object
3132 'UploadForm:initial': Before the upload form is generated. You might set the
3133 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3134 text (HTML) either before or after the editform.
3135 &$form: UploadForm object
3137 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3139 &$descriptor: (array) the HTMLForm descriptor
3141 'UploadFormSourceDescriptors': after the standard source inputs have been
3142 added to the descriptor
3143 &$descriptor: (array) the HTMLForm descriptor
3144 &$radio: Boolean, if source type should be shown as radio button
3145 $selectedSourceType: The selected source type
3147 'UploadVerification': Additional chances to reject an uploaded file. Consider
3148 using UploadVerifyFile instead.
3149 $saveName: (string) destination file name
3150 $tempName: (string) filesystem path to the temporary file for checks
3151 &$error: (string) output: message key for message to show if upload canceled by
3152 returning false. May also be an array, where the first element is the message
3153 key and the remaining elements are used as parameters to the message.
3155 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3156 in most cases over UploadVerification.
3157 $upload: (object) an instance of UploadBase, with all info about the upload
3158 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3159 Handlers will typically only apply for specific MIME types.
3160 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3161 representing the problem with the file, where the first element is the message
3162 key and the remaining elements are used as parameters to the message.
3164 'User::mailPasswordInternal': before creation and mailing of a user's new
3166 &$user: the user who sent the message out
3167 &$ip: IP of the user who sent the message out
3168 &$u: the account whose new password will be set
3170 'UserAddGroup': Called when adding a group; return false to override
3171 stock group addition.
3172 $user: the user object that is to have a group added
3173 &$group: the group to add, can be modified
3175 'UserArrayFromResult': Called when creating an UserArray object from a database
3177 &$userArray: set this to an object to override the default object returned
3178 $res: database result used to create the object
3180 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3181 want to display an error message, try getUserPermissionsErrors.
3182 &$title: Title object being checked against
3183 &$user: Current user object
3184 $action: Action being checked
3185 &$result: Pointer to result returned if hook returns false. If null is returned,
3186 userCan checks are continued by internal code.
3188 'UserCanSendEmail': To override User::canSendEmail() permission check.
3189 &$user: User (object) whose permission is being checked
3190 &$canSend: bool set on input, can override on output
3192 'UserClearNewTalkNotification': Called when clearing the "You have new
3193 messages!" message, return false to not delete it.
3194 &$user: User (object) that will clear the message
3195 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3197 'UserCreateForm': change to manipulate the login form
3198 &$template: SimpleTemplate instance for the form
3200 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3201 &$user: User to get groups for
3202 &$groups: Current effective groups
3204 'UserGetAllRights': After calculating a list of all available rights.
3205 &$rights: Array of rights, which may be added to.
3207 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3208 before returning the options to the caller. Warning: This hook is called for
3209 every call to User::getDefaultOptions(), which means it's potentially called
3210 dozens or hundreds of times. You may want to cache the results of non-trivial
3211 operations in your hook function for this reason.
3212 &$defaultOptions: Array of preference keys and their default values.
3214 'UserGetEmail': Called when getting an user email address.
3216 &$email: email, change this to override local email
3218 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3219 email authentication.
3221 &$timestamp: timestamp, change this to override local email authentication
3224 'UserGetImplicitGroups': DEPRECATED!
3225 Called in User::getImplicitGroups().
3226 &$groups: List of implicit (automatically-assigned) groups
3228 'UserGetLanguageObject': Called when getting user's interface language object.
3230 &$code: Language code that will be used to create the object
3231 $context: IContextSource object
3233 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3234 &$reservedUsernames: $wgReservedUsernames
3236 'UserGetRights': Called in User::getRights().
3237 $user: User to get rights for
3238 &$rights: Current rights
3240 'UserGroupsChanged': Called after user groups are changed.
3241 $user: User whose groups changed
3242 $added: Groups added
3243 $removed: Groups removed
3244 $performer: User who performed the change, false if via autopromotion
3246 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3247 specific block exemptions).
3248 $user: User in question
3249 $title: Title of the page in question
3250 &$blocked: Out-param, whether or not the user is blocked from that page.
3251 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3252 to edit their own user talk pages.
3254 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3256 $ip: User's IP address
3257 &$blocked: Whether the user is blocked, to be modified by the hook
3259 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3260 false if a UserGetRights hook might remove the named right.
3261 $right: The user right being checked
3263 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3264 $user: User in question.
3265 &$hidden: Set true if the user's name should be hidden.
3267 'UserIsLocked': Check if the user is locked. See User::isLocked().
3268 $user: User in question.
3269 &$locked: Set true if the user should be locked.
3271 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3272 environmental means; occurs after session is loaded.
3273 $user: user object being loaded
3275 'UserLoadDefaults': Called when loading a default user.
3279 'UserLoadFromDatabase': Called when loading a user from the database.
3281 &$s: database query object
3283 'UserLoadFromSession': Called to authenticate users on external/environmental
3284 means; occurs before session is loaded.
3285 $user: user object being loaded
3286 &$result: set this to a boolean value to abort the normal authentication
3289 'UserLoadOptions': When user options/preferences are being loaded from the
3292 &$options: Options, can be modified.
3294 'UserLoggedIn': Called after a user is logged in
3295 $user: User object for the logged-in user
3297 'UserLoginComplete': After a user has logged in.
3298 &$user: the user object that was created on login
3299 &$inject_html: Any HTML to inject after the "logged in" message.
3301 'UserLoginForm': change to manipulate the login form
3302 &$template: SimpleTemplate instance for the form
3304 'UserLogout': Before a user logs out.
3305 &$user: the user object that is about to be logged out
3307 'UserLogoutComplete': After a user has logged out.
3308 &$user: the user object _after_ logout (won't have name, ID, etc.)
3309 &$inject_html: Any HTML to inject after the "logged out" message.
3310 $oldName: name of the user before logout (string)
3312 'UserMailerChangeReturnPath': Called to generate a VERP return address
3313 when UserMailer sends an email, with a bounce handling extension.
3314 $to: Array of MailAddress objects for the recipients
3315 &$returnPath: The return address string
3317 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3318 to split up an email with multiple the To: field into separate emails.
3319 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3321 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3322 Extensions can block sending the email by returning false and setting $error.
3323 $to: array of MailAdresses of the targets
3324 $from: MailAddress of the sender
3325 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3326 &$error: should be set to an error message string
3328 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3329 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3330 $to: array of MailAdresses of the targets
3331 $from: MailAddress of the sender
3332 &$subject: email subject (not MIME encoded)
3333 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3334 &$body: email body (in MIME format) as a string
3335 &$error: should be set to an error message string
3337 'UserRemoveGroup': Called when removing a group; return false to override stock
3339 $user: the user object that is to have a group removed
3340 &$group: the group to be removed, can be modified
3342 'UserRequiresHTTPS': Called to determine whether a user needs
3343 to be switched to HTTPS.
3344 $user: User in question.
3345 &$https: Boolean whether $user should be switched to HTTPS.
3347 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3348 have been requested to be reset. This hook can be used to exclude certain
3349 options from being reset even when the user has requested all prefs to be reset,
3350 because certain options might be stored in the user_properties database table
3351 despite not being visible and editable via Special:Preferences.
3352 $user: the User (object) whose preferences are being reset
3353 &$newOptions: array of new (site default) preferences
3354 $options: array of the user's old preferences
3355 $resetKinds: array containing the kinds of preferences to reset
3357 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3359 &$user: user retrieving new talks messages
3360 &$talks: array of new talks page(s)
3362 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3363 After a user's group memberships are changed.
3364 &$user: User object that was changed
3365 $add: Array of strings corresponding to groups added
3366 $remove: Array of strings corresponding to groups removed
3368 'UserSaveOptions': Called just before saving user preferences/options.
3370 &$options: Options, modifiable
3372 'UserSaveSettings': Called when saving user settings.
3375 'UserSetCookies': Called when setting user cookies.
3377 &$session: session array, will be added to $_SESSION
3378 &$cookies: cookies array mapping cookie name to its value
3380 'UserSetEmail': Called when changing user email address.
3382 &$email: new email, change this to override new email address
3384 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3385 email authentication.
3387 &$timestamp: new timestamp, change this to override local email
3388 authentication timestamp
3390 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3391 "Foobar (Talk | Contribs | Block)".
3392 $userId: User id of the current user
3393 $userText: User name of the current user
3394 &$items: Array of user tool links as HTML fragments
3396 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3397 FormatMetadata::getExtendedMeta (return false means cache will be
3398 invalidated and GetExtendedMetadata hook called again).
3399 $timestamp: The timestamp metadata was generated
3400 $file: The file the metadata is for
3402 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3403 used to alter the SQL query which gets the list of wanted pages.
3404 &$wantedPages: WantedPagesPage object
3405 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3407 'WatchArticle': Before a watch is added to an article.
3408 &$user: user that will watch
3409 &$page: WikiPage object to be watched
3410 &$status: Status object to be returned if the hook returns false
3412 'WatchArticleComplete': After a watch is added to an article.
3413 &$user: user that watched
3414 &$page: WikiPage object watched
3416 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3417 form, used to manipulate the list of pages or preload data based on that list.
3418 &$watchlistInfo: array of watchlisted pages in
3419 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3421 'WatchlistEditorBuildRemoveLine': when building remove lines in
3422 Special:Watchlist/edit.
3423 &$tools: array of extra links
3424 $title: Title object
3425 $redirect: whether the page is a redirect
3427 &$link: HTML link to title
3429 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3431 $router: The PathRouter instance
3433 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3434 Return false to prevent setting of the cookie.
3435 &$name: Cookie name passed to WebResponse::setcookie()
3436 &$value: Cookie value passed to WebResponse::setcookie()
3437 &$expire: Cookie expiration, as for PHP's setcookie()
3438 $options: Options passed to WebResponse::setcookie()
3440 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3441 run a MediaWiki cli script.
3442 &$script: MediaWiki cli script path
3443 &$parameters: Array of arguments and options to the script
3444 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3447 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3448 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3449 &$qp: The list of QueryPages
3451 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3452 $row: The DB row of the entry.
3453 $title: The Title of the page where the link comes FROM
3454 $target: The Title of the page where the link goes TO
3455 &$props: Array of HTML strings to display after the title.
3457 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3458 dumps. One, and only one hook should set this, and return false.
3459 &$tables: Database tables to use in the SELECT query
3460 &$opts: Options to use for the query
3461 &$join: Join conditions
3463 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3464 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3465 specific to a content model should be provided by the respective Content's
3466 getDeletionUpdates() method.
3468 $content: the Content to generate updates for
3469 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3471 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3472 extra metadata to be added.
3473 $obj: The XmlDumpWriter object.
3474 &$out: The output string.
3475 $row: The database row for the page.
3476 $title: The title of the page.
3478 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3480 &$obj: The XmlDumpWriter object.
3481 &$out: The text being output.
3482 $row: The database row for the revision.
3483 $text: The revision text.
3485 More hooks might be available but undocumented, you can execute
3486 "php maintenance/findHooks.php" to find hidden ones.