3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'PageContentSave',
14 'PageContentSaveComplete', 'ArticleDelete'.
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle( $article ) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ( $wgReverseTitle ) {
41 wfReverseTitle( $article );
44 if ( $wgCapitalizeTitle ) {
45 wfCapitalizeTitle( $article );
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle( $article ) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ( $wgReverseTitle ) {
59 wfReverseTitle( $article );
62 if ( $wgCapitalizeTitle ) {
63 wfCapitalizeTitle( $article );
66 # code to actually show the article goes here
68 if ( $wgNotifyArticle ) {
69 wfNotifyArticleShow( $article );
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle( $article ) {
78 if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
80 # code to actually show the article goes here
82 Hooks::run( 'ArticleShowComplete', array( &$article ) );
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle( $article ) {
100 function reverseForExport( $article ) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array( 'someFunction', $someData );
143 $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array( $object, 'someMethod' );
147 $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
148 $wgHooks['EventName'][] = array( $object ); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction( $param1, $param2 )
157 someFunction( $someData, $param1, $param2 )
160 $object->onEventName( $param1, $param2 )
162 $object->someMethod( $param1, $param2 )
163 # object with method and data
164 $object->someMethod( $someData, $param1, $param2 )
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
174 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'brion' );
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * No return value (or null): the hook has operated successfully. Previously,
182 true was required. This is the default since MediaWiki 1.23.
183 * "some string": an error occurred; processing should stop and the error
184 should be shown to the user
185 * false: the hook has successfully done the work necessary and the calling
188 The last result would be for cases where the hook function replaces the main
189 functionality. For example, if you wanted to authenticate users to a custom
190 system (LDAP, another PHP program, whatever), you could do:
192 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
194 function ldapLogin( $username, $password ) {
199 Returning false makes less sense for events where the action is complete, and
200 will normally be ignored.
202 Note that none of the examples made use of create_function() as a way to
203 attach a function to a hook. This is known to cause problems (notably with
204 Special:Version), and should be avoided when at all possible.
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
215 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216 # protect the article
217 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
222 Hooks::run() returns true if the calling function should continue processing
223 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
224 error occurred, or one of the hooks handled the action already). Checking the
225 return value matters more for "before" hooks than for "complete" hooks.
227 Hooks::run() was added in MediaWiki 1.18, before that the global function
228 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can be changed)
232 into the hook code. Also note that earlier versions of wfRunHooks took a
233 variable number of arguments; the array() calling protocol came about after
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if you're going
239 to add events to the MediaWiki code.
241 'AbortAutoAccount': Return false to cancel automated local account creation,
242 where normally authentication against an external auth plugin would be creating
244 $user: the User object about to be created (read-only, incomplete)
245 &$abortMsg: out parameter: name of error message to be displayed to user
247 'AbortAutoblock': Return false to cancel an autoblock.
248 $autoblockip: The IP going to be autoblocked.
249 &$block: The block from which the autoblock is coming.
251 'AbortChangePassword': Return false to cancel password change.
252 $user: the User object to which the password change is occuring
253 $mOldpass: the old password provided by the user
254 $newpass: the new password provided by the user
255 &$abortMsg: the message identifier for abort reason
257 'AbortDiffCache': Can be used to cancel the caching of a diff.
258 &$diffEngine: DifferenceEngine object
260 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
261 $editor: The User who made the change.
262 $title: The Title of the page that was edited.
263 $rc: The current RecentChange object.
265 'AbortLogin': Return false to cancel account login.
266 $user: the User object being authenticated against
267 $password: the password being submitted, not yet checked for validity
268 &$retval: a LoginForm class constant to return from authenticateUserData();
269 default is LoginForm::ABORTED. Note that the client may be using a machine
270 API rather than the HTML user interface.
271 &$msg: the message identifier for abort reason (new in 1.18, not available
274 'AbortNewAccount': Return false to cancel explicit account creation.
275 $user: the User object about to be created (read-only, incomplete)
276 &$msg: out parameter: HTML to display on abort
277 &$status: out parameter: Status object to return, replaces the older $msg param
279 Create the object with Status::newFatal() to ensure proper API error
280 messages are returned when creating account through API clients.
282 'AbortTalkPageEmailNotification': Return false to cancel talk page email
284 $targetUser: the user whom to send talk page email notification
285 $title: the page title
287 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
288 $name: name of the action
289 &$form: HTMLForm object
290 $article: Article object
292 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
293 Allows to change the fields on the form that will be generated.
294 $name: name of the action
295 &$fields: HTMLForm descriptor array
296 $article: Article object
298 'AddNewAccount': After a user account is created.
299 $user: the User object that was created. (Parameter added in 1.7)
300 $byEmail: true when account was created "by email" (added in 1.12)
302 'AddNewAccountApiForm': Allow modifying internal login form when creating an
304 $apiModule: the ApiCreateAccount module calling
305 $loginForm: the LoginForm used
307 'AddNewAccountApiResult': Modify API output when creating a new account via API.
308 $apiModule: the ApiCreateAccount module calling
309 $loginForm: the LoginForm used
310 &$result: associative array for API result data
312 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
313 are created. Can be used to omit specific feeds from being outputted. You must not use
314 this hook to add feeds, use OutputPage::addFeedLink() instead.
315 &$feedLinks: Array of created feed links
317 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
318 before OutputPage::sendCacheControl() and final ob_end_flush() which
319 will send the buffered output to the client. This allows for last-minute
320 modification of the output within the buffer by using ob_get_clean().
321 $output: The OutputPage object where output() was called
323 'AfterImportPage': When a page import is completed.
324 $title: Title under which the revisions were imported
325 $foreignTitle: ForeignTitle object based on data provided by the XML file
326 $revCount: Number of revisions in the XML file
327 $sRevCount: Number of successfully imported revisions
328 $pageInfo: associative array of page information
330 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
331 just before adding its HTML to parser output.
332 $parser: Parser object that called the hook
333 $ig: Gallery, an object of one of the gallery classes (inheriting from
335 &$html: HTML generated by the gallery
337 'AlternateEdit': Before checking if a user can edit a page and before showing
338 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
339 $editPage: the EditPage object
341 'AlternateEditPreview': Before generating the preview of the page when editing
342 ( EditPage::getPreviewText() ).
343 Return false and set $previewHTML and $parserOutput to output custom page
345 $editPage: the EditPage object
346 &$content: the Content object for the text field from the edit page
347 &$previewHTML: Text to be placed into the page for the preview
348 &$parserOutput: the ParserOutput object for the preview
350 'AlternateUserMailer': Called before mail is sent so that mail could be logged
351 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
352 the regular method of sending mail. Return a string to return a php-mail-error
353 message containing the error. Returning true will continue with sending email
355 $headers: Associative array of headers for the email
356 $to: MailAddress object or array
358 $subject: Subject of the email
359 $body: Body of the message
361 'APIAfterExecute': After calling the execute() method of an API module. Use
362 this to extend core API modules.
363 &$module: Module object
365 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
366 &$main: ApiMain object
368 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
369 authenticate and authorize API clients before executing the module. Return
370 false and set a message to cancel the request.
371 $module: Module object
373 &$message: API usage message to die with, as a message key or array
374 as accepted by ApiBase::dieUsageMsg.
376 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
377 processing request parameters. Return false to let the request fail, returning
378 an error message or an <edit result="Failure"> tag if $resultArr was filled.
379 $editPage: the EditPage object
380 $text: the new text of the article (has yet to be saved)
381 &$resultArr: data in this array will be added to the API result
383 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
384 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
385 this hook may cancel the hook to signal that the item is not viewable in the
387 $row: A row of data from ContribsPager. The set of data returned by
388 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
390 $context: An IContextSource implementation.
391 &$feedItem: Set this to a FeedItem instance if the callback can handle the
392 provided row. This is provided to the hook as a null, if it is non null then
393 another callback has already handled the hook.
395 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
396 highlighting, add output to $context->getOutput() and return false.
397 $context: An IContextSource.
398 $text: Text to be highlighted.
399 $mime: MIME type of $text.
400 $format: API format code for $text.
402 'APIGetAllowedParams': Use this hook to modify a module's parameters.
403 &$module: ApiBase Module object
404 &$params: Array of parameters
405 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
407 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
408 Use this hook to modify a module's description.
409 &$module: ApiBase Module object
410 &$desc: String description, or array of description strings
412 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
413 $module: ApiBase Module object
414 &$msg: Array of Message objects
416 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
418 Use this hook to modify a module's parameter descriptions.
419 &$module: ApiBase Module object
420 &$desc: Array of parameter descriptions
422 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
424 $module: ApiBase Module object
425 &$msg: Array of arrays of Message objects
427 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
428 $module: ApiBase Module object
429 &$help: Array of HTML strings to be joined for the output.
430 $options: Array Options passed to ApiHelp::getHelp
431 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
432 the page and values as for Linker::generateTOC().
434 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
435 module manager. Can be used to conditionally register API modules.
436 $moduleManager: ApiModuleManager Module manager instance
438 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
439 an exception is thrown during API action execution.
440 $apiMain: Calling ApiMain instance.
441 $e: Exception object.
443 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
444 can alter or append to the array.
445 &$results: array with integer keys to associative arrays. Keys in associative
447 - title: Title object.
448 - redirect from: Title or null.
449 - extract: Description for this result.
450 - extract trimmed: If truthy, the extract will not be trimmed to
451 $wgOpenSearchDescriptionLength.
452 - image: Thumbnail for this result. Value is an array with subkeys 'source'
453 (url), 'width', 'height', 'alt', 'align'.
454 - url: Url for the given title.
456 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
457 module manager. Can be used to conditionally register API query modules.
458 $moduleManager: ApiModuleManager Module manager instance
460 'APIQueryAfterExecute': After calling the execute() method of an
461 action=query submodule. Use this to extend core API modules.
462 &$module: Module object
464 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
465 an action=query submodule. Use this to extend core API modules.
466 &$module: Module object
467 &$resultPageSet: ApiPageSet object
469 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
470 Use this hook to add custom tokens to prop=info. Every token has an action,
471 which will be used in the intoken parameter and in the output
472 (actiontoken="..."), and a callback function which should return the token, or
473 false if the user isn't allowed to obtain it. The prototype of the callback
474 function is func($pageid, $title), where $pageid is the page ID of the page the
475 token is requested for and $title is the associated Title object. In the hook,
476 just add your callback to the $tokenFunctions array and return true (returning
477 false makes no sense).
478 &$tokenFunctions: array(action => callback)
480 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
482 Use this hook to add custom tokens to list=recentchanges. Every token has an
483 action, which will be used in the rctoken parameter and in the output
484 (actiontoken="..."), and a callback function which should return the token, or
485 false if the user isn't allowed to obtain it. The prototype of the callback
486 function is func($pageid, $title, $rc), where $pageid is the page ID of the
487 page associated to the revision the token is requested for, $title the
488 associated Title object and $rc the associated RecentChange object. In the
489 hook, just add your callback to the $tokenFunctions array and return true
490 (returning false makes no sense).
491 &$tokenFunctions: array(action => callback)
493 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
494 Use this hook to add custom tokens to prop=revisions. Every token has an
495 action, which will be used in the rvtoken parameter and in the output
496 (actiontoken="..."), and a callback function which should return the token, or
497 false if the user isn't allowed to obtain it. The prototype of the callback
498 function is func($pageid, $title, $rev), where $pageid is the page ID of the
499 page associated to the revision the token is requested for, $title the
500 associated Title object and $rev the associated Revision object. In the hook,
501 just add your callback to the $tokenFunctions array and return true (returning
502 false makes no sense).
503 &$tokenFunctions: array(action => callback)
505 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
506 sites general information.
507 $module: the current ApiQuerySiteInfo module
508 &$results: array of results, add things here
510 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
511 sites statistics information.
512 &$results: array of results, add things here
514 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
515 action=query&meta=tokens. Note that most modules will probably be able to use
516 the 'csrf' token instead of creating their own token types.
517 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
518 and key to pass to Session::getToken() )
520 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
521 Use this hook to add custom token to list=users. Every token has an action,
522 which will be used in the ustoken parameter and in the output
523 (actiontoken="..."), and a callback function which should return the token, or
524 false if the user isn't allowed to obtain it. The prototype of the callback
525 function is func($user) where $user is the User object. In the hook, just add
526 your callback to the $tokenFunctions array and return true (returning false
528 &$tokenFunctions: array(action => callback)
530 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
531 should have its own entry in the $apis array and have a unique name, passed as
532 key for the array that represents the service data. In this data array, the
533 key-value-pair identified by the apiLink key is required.
534 &$apis: array of services
536 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
537 Use this hook to extend action=tokens with new token types.
538 &$tokenTypes: supported token types in format 'type' => callback function
539 used to retrieve this type of tokens.
541 'Article::MissingArticleConditions': Before fetching deletion & move log entries
542 to display a message of a non-existing page being deleted/moved, give extensions
543 a chance to hide their (unrelated) log entries.
544 &$conds: Array of query conditions (all of which have to be met; conditions will
545 AND in the final query)
546 $logTypes: Array of log types being queried
548 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
550 After fetching content of an article from the database.
551 &$article: the article (object) being loaded from the database
552 &$content: the content (string) of the article
554 'ArticleAfterFetchContentObject': After fetching content of an article from the
556 &$article: the article (object) being loaded from the database
557 &$content: the content of the article, as a Content object
559 'ArticleConfirmDelete': Before writing the confirmation form for article
561 $article: the article (object) being deleted
562 $output: the OutputPage object
563 &$reason: the reason (string) the article is being deleted
565 'ArticleContentOnDiff': Before showing the article content below a diff. Use
566 this to change the content in this area or how it is loaded.
567 $diffEngine: the DifferenceEngine
568 $output: the OutputPage object
570 'ArticleContentViewCustom': Allows to output the text of the article in a
571 different format than wikitext. Note that it is preferable to implement proper
572 handing for a custom data type using the ContentHandler facility.
573 $content: content of the page, as a Content object
574 $title: title of the page
575 $output: reference to $wgOut
577 'ArticleDelete': Before an article is deleted.
578 &$wikiPage: the WikiPage (object) being deleted
579 &$user: the user (object) deleting the article
580 &$reason: the reason (string) the article is being deleted
581 &$error: if the deletion was prohibited, the (raw HTML) error message to display
583 &$status: Status object, modify this to throw an error. Overridden by $error
585 $suppress: Whether this is a suppression deletion or not (added in 1.27)
587 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
588 $title: Title of the article that has been deleted.
589 $outputPage: OutputPage that can be used to append the output.
591 'ArticleDeleteComplete': After an article is deleted.
592 &$wikiPage: the WikiPage that was deleted
593 &$user: the user that deleted the article
594 $reason: the reason the article was deleted
595 $id: id of the article that was deleted
596 $content: the Content of the deleted page
597 $logEntry: the ManualLogEntry used to record the deletion
599 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
601 &$wikiPage: WikiPage (object) of the user talk page
602 $recipient: User (object) who's talk page was edited
604 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
605 article has been changed.
606 &$wikiPage: the WikiPage (object)
607 &$editInfo: data holder that includes the parser output ($editInfo->output) for
608 that page after the change
609 $changed: bool for if the page was changed
611 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
612 recentchanges table, return false to not delete old entries.
613 &$wikiPage: WikiPage (object) being modified
615 'ArticleFromTitle': when creating an article object from a title object using
616 Wiki::articleFromTitle().
617 &$title: Title (object) used to create the article object
618 &$article: Article (object) that will be returned
619 $context: IContextSource (object)
621 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
622 After a new article is created.
623 $wikiPage: WikiPage created
624 $user: User creating the article
626 $summary: Edit summary/comment
627 $isMinor: Whether or not the edit was marked as minor
628 $isWatch: (No longer used)
629 $section: (No longer used)
630 $flags: Flags passed to WikiPage::doEditContent()
631 $revision: New Revision of the article
633 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
634 $targetTitle: target title (object)
635 $destTitle: destination title (object)
637 'ArticlePageDataAfter': After loading data of an article from the database.
638 &$wikiPage: WikiPage (object) whose data were loaded
639 &$row: row (object) returned from the database server
641 'ArticlePageDataBefore': Before loading data of an article from the database.
642 &$wikiPage: WikiPage (object) that data will be loaded
643 &$fields: fields (array) to load from the database
645 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
646 $wikiPage: the WikiPage being saved
647 $popts: parser options to be used for pre-save transformation
649 'ArticleProtect': Before an article is protected.
650 &$wikiPage: the WikiPage being protected
651 &$user: the user doing the protection
652 $protect: Set of restriction keys
653 $reason: Reason for protect
655 'ArticleProtectComplete': After an article is protected.
656 &$wikiPage: the WikiPage that was protected
657 &$user: the user who did the protection
658 $protect: Set of restriction keys
659 $reason: Reason for protect
661 'ArticlePurge': Before executing "&action=purge".
662 &$wikiPage: WikiPage (object) to purge
664 'ArticleRevisionUndeleted': After an article revision is restored.
665 &$title: the article title
666 $revision: the revision
667 $oldPageID: the page ID of the revision when archived (may be null)
669 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
670 revisions of an article.
671 $title: Title object of the article
672 $ids: Ids to set the visibility for
674 'ArticleRollbackComplete': After an article rollback is completed.
675 $wikiPage: the WikiPage that was edited
676 $user: the user who did the rollback
677 $revision: the revision the page was reverted back to
678 $current: the reverted revision
680 'ArticleSave': DEPRECATED! Use PageContentSave instead.
681 Before an article is saved.
682 $wikiPage: the WikiPage (object) being saved
683 $user: the user (object) saving the article
684 $text: the new article text
685 $summary: the article summary (comment)
690 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
691 After an article has been updated.
692 $wikiPage: WikiPage modified
693 $user: User performing the modification
695 $summary: Edit summary/comment
696 $isMinor: Whether or not the edit was marked as minor
697 $isWatch: (No longer used)
698 $section: (No longer used)
699 $flags: Flags passed to WikiPage::doEditContent()
700 $revision: New Revision of the article
701 $status: Status object about to be returned by doEditContent()
702 $baseRevId: the rev ID (or false) this edit was based on
704 'ArticleUndelete': When one or more revisions of an article are restored.
705 &$title: Title corresponding to the article restored
706 $create: Whether or not the restoration caused the page to be created (i.e. it
707 didn't exist before).
708 $comment: The comment associated with the undeletion.
709 $oldPageId: ID of page previously deleted (from archive table)
711 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
712 $pageArchive: the PageArchive object
713 &$logEntry: ManualLogEntry object
714 $user: User who is performing the log action
716 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
717 the user is redirected back to the page.
718 $article: the article
719 &$sectionanchor: The section anchor link (e.g. "#overview" )
720 &$extraq: Extra query parameters which can be added via hooked functions
722 'ArticleViewCustom': DEPRECATED! Use ArticleContentViewCustom instead.
723 Allows to output the text of the article in a different format than wikitext.
724 Note that it is preferable to implement proper handing for a custom data type
725 using the ContentHandler facility.
726 $text: text of the page
727 $title: title of the page
728 $output: reference to $wgOut
730 'ArticleViewFooter': After showing the footer section of an ordinary page view
731 $article: Article object
732 $patrolFooterShown: boolean whether patrol footer is shown
734 'ArticleViewHeader': Before the parser cache is about to be tried for article
736 &$article: the article
737 &$pcache: whether to try the parser cache or not
738 &$outputDone: whether the output for this page finished or not. Set to
739 a ParserOutput object to both indicate that the output is done and what
740 parser output was used.
742 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
743 redirect was followed.
744 &$article: target article (object)
746 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
747 Called when creating a local account for an user logged in from an external
748 authentication method.
749 $user: User object created locally
751 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
752 Gives a chance for an extension to set it programmatically to a variable class.
753 &$auth: the $wgAuth object, probably a stub
755 'AutopromoteCondition': Check autopromote condition for user.
756 $type: condition type
759 &$result: result of checking autopromote condition
761 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
762 certain title are fetched.
764 $title: title of the page to which backlinks are sought
765 &$conds: query conditions
767 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
771 'BadImage': When checking against the bad image list. Change $bad and return
772 false to override. If an image is "bad", it is not rendered inline in wiki
773 pages or galleries in category pages.
774 $name: Image name being checked
775 &$bad: Whether or not the image is "bad"
777 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
778 custom HTML after the section. Any uses of the hook need to handle escaping.
779 $template: BaseTemplate
780 $portlet: string portlet name
783 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
784 and returning it for the skin to output. You can add items to the toolbox while
785 still letting the skin make final decisions on skin-specific markup conventions
787 &$sk: The BaseTemplate base skin template
788 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
789 BaseTemplate::makeListItem for details on the format of individual items
790 inside of this array.
792 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
793 "noarticletext-nopermission" at Article::showMissingArticle().
794 $article: article object
796 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
797 override how the redirect is output by modifying, or by returning false, and
798 letting standard HTTP rendering take place.
799 ATTENTION: This hook is likely to be removed soon due to overall design of the
801 $context: IContextSource object
802 &$redirect: string URL, modifiable
804 'BeforeInitialize': Before anything is initialized in
805 MediaWiki::performRequest().
806 &$title: Title being used for request
808 &$output: OutputPage object
810 $request: WebRequest object
811 $mediaWiki: Mediawiki object
813 'BeforePageDisplay': Prior to outputting a page.
814 &$out: OutputPage object
817 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
818 override how the redirect is output by modifying, or by returning false and
819 taking over the output.
820 $out: OutputPage object
821 &$redirect: URL, modifiable
822 &$code: HTTP code (eg '301' or '302'), modifiable
824 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
825 $parser: Parser object
827 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
828 as a key then the file will appear as a broken thumbnail.
829 &$descQuery: query string to add to thumbnail URL
831 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
832 $parser: Parser object
833 $title: title of the template
834 &$skip: skip this template and link it?
835 &$id: the id of the revision being parsed
837 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
838 &$parser: Parser object
839 &$ig: ImageGallery object
841 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
843 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
844 to a newly created user account.
845 &$injected_html: Any HTML to inject after the "logged in" message of a newly
848 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
849 normalizations have been performed, except for the $wgMaxImageArea check.
851 &$params: Array of parameters
852 &$checkImageAreaHookResult: null, set to true or false to override the
853 $wgMaxImageArea check result.
855 'BitmapHandlerTransform': before a file is transformed, gives extension the
856 possibility to transform it themselves
857 $handler: BitmapHandler
859 &$scalerParams: Array with scaler parameters
860 &$mto: null, set to a MediaTransformOutput
862 'BlockIp': Before an IP address or user is blocked.
863 &$block: the Block object about to be saved
864 &$user: the user _doing_ the block (not the one being blocked)
865 &$reason: if the hook is aborted, the error message to be returned in an array
867 'BlockIpComplete': After an IP address or user is blocked.
868 $block: the Block object that was saved
869 $user: the user who did the block (not the one being blocked)
871 'BookInformation': Before information output on Special:Booksources.
872 $isbn: ISBN to show information for
873 $output: OutputPage object in use
875 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
876 to be able to access the wiki via HTTPS.
877 $ip: The IP address in human-readable form
878 &$canDo: This reference should be set to false if the client may not be able
881 'CanonicalNamespaces': For extensions adding their own namespaces or altering
883 Note that if you need to specify namespace protection or content model for
884 a namespace that is added in a CanonicalNamespaces hook handler, you
885 should do so by altering $wgNamespaceProtection and
886 $wgNamespaceContentModels outside the handler, in top-level scope. The
887 point at which the CanonicalNamespaces hook fires is too late for altering
888 these variables. This applies even if the namespace addition is
889 conditional; it is permissible to declare a content model and protection
890 for a namespace and then decline to actually register it.
891 &$namespaces: Array of namespace numbers with corresponding canonical names
893 'CategoryAfterPageAdded': After a page is added to a category.
894 $category: Category that page was added to
895 $wikiPage: WikiPage that was added
897 'CategoryAfterPageRemoved': After a page is removed from a category.
898 $category: Category that page was removed from
899 $wikiPage: WikiPage that was removed
901 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
902 &$catpage: CategoryPage instance
904 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
905 in a Category page. Gives extensions the opportunity to batch load any
906 related data about the pages.
907 $type: The category type. Either 'page', 'file' or 'subcat'
908 $res: Query result from DatabaseBase::select()
910 'CategoryViewer::generateLink': Before generating an output link allow
911 extensions opportunity to generate a more specific or relevant link.
912 $type: The category type. Either 'page', 'img' or 'subcat'
913 $title: Title object for the categorized page
914 $html: Requested html content of anchor
915 &$link: Returned value. When set to a non-null value by a hook subscriber
916 this value will be used as the anchor instead of Linker::link
918 'ChangePasswordForm': For extensions that need to add a field to the
919 ChangePassword form via the Preferences form.
920 &$extraFields: An array of arrays that hold fields like would be passed to the
923 'ChangesListInitRows': Batch process change list rows prior to rendering.
924 $changesList: ChangesList instance
925 $rows: The data that will be rendered. May be a ResultWrapper instance or
928 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
929 &$changesList: ChangesList instance.
930 &$articlelink: HTML of link to article (already filled-in).
931 &$s: HTML of row that is being constructed.
932 &$rc: RecentChange instance.
933 $unpatrolled: Whether or not we are showing unpatrolled changes.
934 $watched: Whether or not the change is watched by the user.
936 'ChangesListSpecialPageFilters': Called after building form options on pages
937 inheriting from ChangesListSpecialPage (in core: RecentChanges,
938 RecentChangesLinked and Watchlist).
939 $special: ChangesListSpecialPage instance
940 &$filters: associative array of filter definitions. The keys are the HTML
941 name/URL parameters. Each key maps to an associative array with a 'msg'
942 (message key) and a 'default' value.
944 'ChangesListSpecialPageQuery': Called when building SQL query on pages
945 inheriting from ChangesListSpecialPage (in core: RecentChanges,
946 RecentChangesLinked and Watchlist).
947 $name: name of the special page, e.g. 'Watchlist'
948 &$tables: array of tables to be queried
949 &$fields: array of columns to select
950 &$conds: array of WHERE conditionals for query
951 &$query_options: array of options for the database request
952 &$join_conds: join conditions for the tables
953 $opts: FormOptions for this request
955 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
956 removed from all revisions and log entries to which it was applied). This gives
957 extensions a chance to take it off their books.
958 $tag: name of the tag
959 &$status: Status object. Add warnings to this as required. There is no point
960 setting errors, as the deletion has already been partly carried out by this
963 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
964 from the UI (Special:Tags) or via the API. You could use this hook if you want
965 to reserve a specific "namespace" of tags, or something similar.
966 $tag: name of the tag
967 $user: user initiating the action
968 &$status: Status object. Add your errors using `$status->fatal()` or warnings
969 using `$status->warning()`. Errors and warnings will be relayed to the user.
970 If you set an error, the user will be unable to create the tag.
972 'ChangeTagCanDelete': Tell whether a change tag should be able to be
973 deleted from the UI (Special:Tags) or via the API. The default is that tags
974 defined using the ListDefinedTags hook are not allowed to be deleted unless
975 specifically allowed. If you wish to allow deletion of the tag, set
976 `$status = Status::newGood()` to allow deletion, and then `return false` from
977 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
978 out custom deletion actions.
979 $tag: name of the tag
980 $user: user initiating the action
981 &$status: Status object. See above.
983 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
984 uses are in active use.
985 &$tags: list of all active tags. Append to this array.
987 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
988 $collationName: Name of the collation in question
989 &$collationObject: Null. Replace with a subclass of the Collation class that
990 implements the collation given in $collationName.
992 'ConfirmEmailComplete': Called after a user's email has been confirmed
994 $user: user (object) whose email is being confirmed
996 'ContentAlterParserOutput': Modify parser output for a given content object.
997 Called by Content::getParserOutput after parsing has finished. Can be used
998 for changes that depend on the result of the parsing but have to be done
999 before LinksUpdate is called (such as adding tracking categories based on
1001 $content: The Content to render
1002 $title: Title of the page, as context
1003 $parserOutput: ParserOutput to manipulate
1005 'ContentGetParserOutput': Customize parser output for a given content object,
1006 called by AbstractContent::getParserOutput. May be used to override the normal
1007 model-specific rendering of page content.
1008 $content: The Content to render
1009 $title: Title of the page, as context
1010 $revId: The revision ID, as context
1011 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1012 the output can only depend on parameters provided to this hook function, not
1014 $generateHtml: boolean, indicating whether full HTML should be generated. If
1015 false, generation of HTML may be skipped, but other information should still
1016 be present in the ParserOutput object.
1017 &$output: ParserOutput, to manipulate or replace
1019 'ContentHandlerDefaultModelFor': Called when the default content model is
1020 determined for a given title. May be used to assign a different model for that
1022 $title: the Title in question
1023 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1025 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1026 a given content model name, but no entry for that model exists in
1028 $modeName: the requested content model name
1029 &$handler: set this to a ContentHandler object, if desired.
1031 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1032 be used on a given page. This is especially useful to prevent some content
1033 models to be used in some special location.
1034 $contentModel: ID of the content model in question
1035 $title: the Title in question.
1036 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1037 Handler functions that modify $ok should generally return false to prevent
1038 further hooks from further modifying $ok.
1040 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1041 &$pager: Pager object for contributions
1042 &$queryInfo: The query for the contribs Pager
1044 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1046 &$data: an array of results of all contribs queries
1047 $pager: The ContribsPager object hooked into
1048 $offset: Index offset, inclusive
1049 $limit: Exact query limit
1050 $descending: Query direction, false for ascending, true for descending
1052 'ContributionsLineEnding': Called before a contributions HTML line is finished
1053 $page: SpecialPage object for contributions
1054 &$ret: the HTML line
1055 $row: the DB row for this line
1056 &$classes: the classes to add to the surrounding <li>
1058 'ContributionsToolLinks': Change tool links above Special:Contributions
1059 $id: User identifier
1060 $title: User page title
1061 &$tools: Array of tool links
1063 'ConvertContent': Called by AbstractContent::convert when a conversion to
1064 another content model is requested.
1065 Handler functions that modify $result should generally return false to disable
1066 further attempts at conversion.
1067 $content: The Content object to be converted.
1068 $toModel: The ID of the content model to convert to.
1069 $lossy: boolean indicating whether lossy conversion is allowed.
1070 &$result: Output parameter, in case the handler function wants to provide a
1071 converted Content object. Note that $result->getContentModel() must return
1074 'CustomEditor': When invoking the page editor
1075 Return true to allow the normal editor to be used, or false if implementing
1076 a custom editor, e.g. for a special namespace, etc.
1077 $article: Article being edited
1078 $user: User performing the edit
1080 'DatabaseOraclePostInit': Called after initialising an Oracle database
1081 $db: the DatabaseOracle object
1083 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1084 for Special:DeletedContributions
1085 Similar to ContribsPager::reallyDoQuery
1086 &$data: an array of results of all contribs queries
1087 $pager: The DeletedContribsPager object hooked into
1088 $offset: Index offset, inclusive
1089 $limit: Exact query limit
1090 $descending: Query direction, false for ascending, true for descending
1092 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1094 Similar to ContributionsLineEnding
1095 $page: SpecialPage object for DeletedContributions
1096 &$ret: the HTML line
1097 $row: the DB row for this line
1098 &$classes: the classes to add to the surrounding <li>
1100 'DiffRevisionTools': Override or extend the revision tools available from the
1101 diff view, i.e. undo, etc.
1102 $newRev: Revision object of the "new" revision
1103 &$links: Array of HTML links
1104 $oldRev: Revision object of the "old" revision (may be null)
1105 $user: Current user object
1107 'DiffViewHeader': Called before diff display
1108 $diff: DifferenceEngine object that's calling
1109 $oldRev: Revision object of the "old" revision (may be null/invalid)
1110 $newRev: Revision object of the "new" revision
1112 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1114 &$article: article (object) being viewed
1115 &$oldid: oldid (int) being viewed
1117 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1118 Override the HTML generated for section edit links
1119 $skin: Skin object rendering the UI
1120 $title: Title object for the title being linked to (may not be the same as
1121 the page title, if the section is included from a template)
1122 $section: The designation of the section being pointed to, to be included in
1123 the link, like "§ion=$section"
1124 $tooltip: The default tooltip. Escape before using.
1125 By default, this is wrapped in the 'editsectionhint' message.
1126 &$result: The HTML to return, prefilled with the default plus whatever other
1127 changes earlier hooks have made
1128 $lang: The language code to use for the link in the wfMessage function
1130 'EditFilter': Perform checks on an edit
1131 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1132 $text: Contents of the edit box
1133 $section: Section being edited
1134 &$error: Error message to return
1135 $summary: Edit summary for page
1137 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1138 Post-section-merge edit filter.
1139 $editor: EditPage instance (object)
1140 $text: content of the edit box
1141 &$error: error message to return
1142 $summary: Edit summary for page
1144 'EditFilterMergedContent': Post-section-merge edit filter.
1145 This may be triggered by the EditPage or any other facility that modifies page
1146 content. Use the $status object to indicate whether the edit should be allowed,
1147 and to provide a reason for disallowing it. Return false to abort the edit, and
1148 true to continue. Returning true if $status->isOK() returns false means "don't
1149 save but continue user interaction", e.g. show the edit form.
1150 $status->apiHookResult can be set to an array to be returned by api.php
1151 action=edit. This is used to deliver captchas.
1152 $context: object implementing the IContextSource interface.
1153 $content: content of the edit box, as a Content object.
1154 $status: Status object to represent errors, etc.
1155 $summary: Edit summary for page
1156 $user: the User object representing the user whois performing the edit.
1157 $minoredit: whether the edit was marked as minor by the user.
1159 'EditFormInitialText': Allows modifying the edit form when editing existing
1161 $editPage: EditPage object
1163 'EditFormPreloadText': Allows population of the edit form when creating
1165 &$text: Text to preload with
1166 &$title: Title object representing the page being created
1168 'EditPage::attemptSave': Called before an article is
1169 saved, that is before WikiPage::doEditContent() is called
1170 $editpage_Obj: the current EditPage object
1172 'EditPage::attemptSave:after': Called after an article save attempt
1173 $editpage_Obj: the current EditPage object
1174 $status: the resulting Status object
1175 $resultDetails: Result details array
1177 'EditPage::importFormData': allow extensions to read additional data
1179 $editpage: EditPage instance
1180 $request: Webrequest
1181 return value is ignored (should always return true)
1183 'EditPage::showEditForm:fields': allows injection of form field into edit form
1184 Return value is ignored (should always return true)
1185 &$editor: the EditPage instance for reference
1186 &$out: an OutputPage instance to write to
1188 'EditPage::showEditForm:initial': before showing the edit form
1189 Return false to halt editing; you'll need to handle error messages, etc.
1190 yourself. Alternatively, modifying $error and returning true will cause the
1191 contents of $error to be echoed at the top of the edit form as wikitext.
1192 Return true without altering $error to allow the edit to proceed.
1193 &$editor: EditPage instance (object)
1194 &$out: an OutputPage instance to write to
1196 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1197 but for the read-only 'view source' variant of the edit form.
1198 Return value is ignored (should always return true)
1199 $editor: EditPage instance (object)
1200 &$out: an OutputPage instance to write to
1202 'EditPage::showStandardInputs:options': allows injection of form fields into
1203 the editOptions area
1204 Return value is ignored (should always be true)
1205 $editor: EditPage instance (object)
1206 $out: an OutputPage instance to write to
1207 &$tabindex: HTML tabindex of the last edit check/button
1209 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1210 when there's an edit conflict. Return false to halt normal diff output; in
1211 this case you're responsible for computing and outputting the entire "conflict"
1212 part, i.e., the "difference between revisions" and "your text" headers and
1214 &$editor: EditPage instance
1215 &$out: OutputPage instance
1217 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1218 textarea in the edit form.
1219 &$editpage: The current EditPage object
1220 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1221 &$tabindex: HTML tabindex of the last edit check/button
1223 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1225 &$editpage: The current EditPage object
1226 &$checks: Array of edit checks like "watch this page"/"minor edit"
1227 &$tabindex: HTML tabindex of the last edit check/button
1229 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1230 textarea in the edit form.
1231 &$toolbar: The toolbar HTMl
1233 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1234 contribution/copyright notice.
1235 $title: title of page being edited
1236 &$msg: localization message name, overridable. Default is either
1237 'copyrightwarning' or 'copyrightwarning2'.
1239 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1240 "Show changes". Note that it is preferable to implement diff handling for
1241 different data types using the ContentHandler facility.
1242 $editPage: EditPage object
1243 &$newtext: wikitext that will be used as "your version"
1245 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1246 Allow modifying the wikitext that will be used in "Show changes". Note that it
1247 is preferable to implement diff handling for different data types using the
1248 ContentHandler facility.
1249 $editPage: EditPage object
1250 &$newtext: wikitext that will be used as "your version"
1252 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1253 previewed. Note that it is preferable to implement previews for different data
1254 types using the ContentHandler facility.
1255 $editPage: EditPage object
1256 &$content: Content object to be previewed (may be replaced by hook function)
1258 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1259 Allow modifying the wikitext that will be previewed. Note that it is preferable
1260 to implement previews for different data types using the ContentHandler
1262 $editPage: EditPage object
1263 &$toparse: wikitext that will be parsed
1265 'EditPageNoSuchSection': When a section edit request is given for an
1266 non-existent section
1267 &$editpage: The current EditPage object
1268 &$res: the HTML of the error text
1270 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1271 of terms of service summary link that might exist separately from the copyright
1273 $title: title of page being edited
1274 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1276 'EmailConfirmed': When checking that the user's email address is "confirmed".
1277 This runs before the other checks, such as anonymity and the real check; return
1278 true to allow those checks to occur, and false if checking is done.
1279 &$user: User being checked
1280 &$confirmed: Whether or not the email address is confirmed
1282 'EmailUser': Before sending email from one user to another.
1283 &$to: MailAddress object of receiving user
1284 &$from: MailAddress object of sending user
1285 &$subject: subject of the mail
1286 &$text: text of the mail
1287 &$error: Out-param for an error
1289 'EmailUserCC': Before sending the copy of the email to the author.
1290 &$to: MailAddress object of receiving user
1291 &$from: MailAddress object of sending user
1292 &$subject: subject of the mail
1293 &$text: text of the mail
1295 'EmailUserComplete': After sending email from one user to another.
1296 $to: MailAddress object of receiving user
1297 $from: MailAddress object of sending user
1298 $subject: subject of the mail
1299 $text: text of the mail
1301 'EmailUserForm': After building the email user form object.
1302 &$form: HTMLForm object
1304 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1306 $user: The user who is trying to email another user.
1307 $editToken: The user's edit token.
1308 &$hookErr: Out-param for the error. Passed as the parameters to
1309 OutputPage::showErrorPage.
1311 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1312 group of changes in EnhancedChangesList.
1313 Hook subscribers can return false to omit this line from recentchanges.
1314 $changesList: EnhancedChangesList object
1315 &$links: The links that were generated by EnhancedChangesList
1316 $block: The RecentChanges objects in that block
1318 'EnhancedChangesListModifyLineData': to alter data used to build
1319 a grouped recent change inner line in EnhancedChangesList.
1320 Hook subscribers can return false to omit this line from recentchanges.
1321 $changesList: EnhancedChangesList object
1322 &$data: An array with all the components that will be joined in order to create the line
1323 $block: An array of RecentChange objects in that block
1324 $rc: The RecentChange object for this line
1326 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1327 a non-grouped recent change line in EnhancedChangesList.
1328 $changesList: EnhancedChangesList object
1329 &$data: An array with all the components that will be joined in order to create the line
1330 $rc: The RecentChange object for this line
1332 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1334 $ip: The ip address of the user
1336 'ExtensionTypes': Called when generating the extensions credits, use this to
1337 change the tables headers.
1338 &$extTypes: associative array of extensions types
1340 'ExtractThumbParameters': DEPRECATED! Media handler should override
1341 MediaHandler::parseParamString instead.
1342 Called when extracting thumbnail parameters from a thumbnail file name.
1343 $thumbname: the base name of the thumbnail file
1344 &$params: the currently extracted params (has source name, temp or archived
1347 'FetchChangesList': When fetching the ChangesList derivative for a particular
1349 $user: User the list is being fetched for
1350 &$skin: Skin object to be used with the list
1351 &$list: List object (defaults to NULL, change it to an object instance and
1352 return false override the list derivative used)
1354 'FileDeleteComplete': When a file is deleted.
1355 &$file: reference to the deleted file
1356 &$oldimage: in case of the deletion of an old image, the name of the old file
1357 &$article: in case all revisions of the file are deleted a reference to the
1358 WikiFilePage associated with the file.
1359 &$user: user who performed the deletion
1362 'FileTransformed': When a file is transformed and moved into storage.
1363 $file: reference to the File object
1364 $thumb: the MediaTransformOutput object
1365 $tmpThumbPath: The temporary file system path of the transformed file
1366 $thumbPath: The permanent storage path of the transformed file
1368 'FileUndeleteComplete': When a file is undeleted
1369 $title: title object to the file
1370 $fileVersions: array of undeleted versions. Empty if all versions were restored
1371 $user: user who performed the undeletion
1374 'FileUpload': When a file upload occurs.
1375 $file: Image object representing the file that was uploaded
1376 $reupload: Boolean indicating if there was a previously another image there or
1378 $hasDescription: Boolean indicating that there was already a description page
1379 and a new one from the comment wasn't created (since 1.17)
1381 'FormatAutocomments': When an autocomment is formatted by the Linker.
1382 &$comment: Reference to the accumulated comment. Initially null, when set the
1383 default code will be skipped.
1384 $pre: Boolean, true if there is text before this autocomment
1385 $auto: The extracted part of the parsed comment before the call to the hook.
1386 $post: Boolean, true if there is text after this autocomment
1387 $title: An optional title object used to links to sections. Can be null.
1388 $local: Boolean indicating whether section links should refer to local page.
1389 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1390 autocomment originated; null for the local wiki. Added in 1.26, should default
1391 to null in handler functions, for backwards compatibility.
1393 'GalleryGetModes': Get list of classes that can render different modes of a
1395 &$modeArray: An associative array mapping mode names to classes that implement
1396 that mode. It is expected all registered classes are a subclass of
1399 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1401 $user: user to promote.
1402 &$promote: groups that will be added.
1404 'GetBlockedStatus': after loading blocking status of an user from the database
1405 &$user: user (object) being checked
1407 'GetCacheVaryCookies': Get cookies that should vary cache options.
1408 $out: OutputPage object
1409 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1410 that have to vary cache options
1412 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1414 &$title: Title object of page
1415 &$url: string value as output (out parameter, can modify)
1416 $query: query options passed to Title::getCanonicalURL()
1418 'GetDefaultSortkey': Override the default sortkey for a page.
1419 $title: Title object that we need to get a sortkey for
1420 &$sortkey: Sortkey to use.
1422 'GetDifferenceEngine': Called when getting a new difference engine interface
1423 object Return false for valid object in $differenceEngine or true for the
1424 default difference engine.
1425 $context: IContextSource context to be used for diff
1426 $old: Revision ID to show and diff with
1427 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1428 $refreshCache: If set, refreshes the diff cache
1429 $unhide: If set, allow viewing deleted revs
1430 &$differenceEngine: output parameter, difference engine object to be used for
1433 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1434 underscore) magic words. Called by MagicWord.
1435 &$doubleUnderscoreIDs: array of strings
1437 'GetExtendedMetadata': Get extended file metadata for the API
1438 &$combinedMeta: Array of the form:
1439 'MetadataPropName' => array(
1440 value' => prop value,
1441 'source' => 'name of hook'
1443 $file: File object of file in question
1444 $context: RequestContext (including language to use)
1445 $single: Only extract the current language; if false, the prop value should
1446 be in the metadata multi-language array format:
1447 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1448 &$maxCacheTime: how long the results can be cached
1450 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1451 &$title: Title object of page
1452 &$url: string value as output (out parameter, can modify)
1453 $query: query options passed to Title::getFullURL()
1455 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1456 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1458 &$output: string for the output timestamp
1459 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1460 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1461 $user: User whose preferences are being used to make timestamp
1462 $lang: Language that will be used to render the timestamp
1464 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1465 &$title: Title object of page
1466 &$url: string value as output (out parameter, can modify)
1467 $query: query options passed to Title::getInternalURL()
1469 'GetIP': modify the ip of the current user (called only once).
1470 &$ip: string holding the ip as determined so far
1472 'GetLinkColours': modify the CSS class of an array of page links.
1473 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1475 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1477 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1478 working with internal urls (non-interwiki) then it may be preferable to work
1479 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1480 be buggy for internal urls on render if you do not re-implement the horrible
1481 hack that Title::getLocalURL uses in your own extension.
1482 &$title: Title object of page
1483 &$url: string value as output (out parameter, can modify)
1484 $query: query options passed to Title::getLocalURL()
1486 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1487 without any fancy queries or variants.
1488 &$title: Title object of page
1489 &$url: string value as output (out parameter, can modify)
1491 'GetLocalURL::Internal': Modify local URLs to internal pages.
1492 &$title: Title object of page
1493 &$url: string value as output (out parameter, can modify)
1494 $query: query options passed to Title::getLocalURL()
1496 'GetLogTypesOnUser': Add log types where the target is a userpage
1497 &$types: Array of log types
1499 'GetMetadataVersion': Modify the image metadata version currently in use. This
1500 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1501 that need to have versioned metadata should add an element to the end of the
1502 version array of the form 'handler_name=version'. Most media handlers won't need
1503 to do this unless they broke backwards compatibility with a previous version of
1504 the media handler metadata output.
1505 &$version: Array of version strings
1507 'GetNewMessagesAlert': Disable or modify the new messages alert
1508 &$newMessagesAlert: An empty string by default. If the user has new talk page
1509 messages, this should be populated with an alert message to that effect
1510 $newtalks: An empty array if the user has no new messages or an array
1511 containing links and revisions if there are new messages (See
1512 User::getNewMessageLinks)
1513 $user: The user object of the user who is loading the page
1514 $out: OutputPage object (to check what type of page the user is on)
1516 'GetPreferences': Modify user preferences.
1517 $user: User whose preferences are being modified.
1518 &$preferences: Preferences description array, to be fed to an HTMLForm object
1520 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1521 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1523 &$output: string for the output timestamp
1524 &$diff: DateInterval representing the difference between the timestamps
1525 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1526 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1527 $user: User whose preferences are being used to make timestamp
1528 $lang: Language that will be used to render the timestamp
1530 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1531 checked for. Use instead of userCan for most cases. Return false if the user
1532 can't do it, and populate $result with the reason in the form of
1533 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1534 might want to use ApiMessage to provide machine-readable details for the API).
1535 For consistency, error messages
1536 should be plain text with no special coloring, bolding, etc. to show that
1537 they're errors; presenting them properly to the user as errors is done by the
1539 &$title: Title object being checked against
1540 &$user: Current user object
1541 $action: Action being checked
1542 &$result: User permissions error to add. If none, return true.
1544 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1545 called only if expensive checks are enabled. Add a permissions error when
1546 permissions errors are checked for. Return false if the user can't do it, and
1547 populate $result with the reason in the form of array( messagename, param1,
1548 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1549 to provide machine-readable details for the API). For consistency, error
1550 messages should be plain text with no
1551 special coloring, bolding, etc. to show that they're errors; presenting them
1552 properly to the user as errors is done by the caller.
1553 &$title: Title object being checked against
1554 &$user: Current user object
1555 $action: Action being checked
1556 &$result: User permissions error to add. If none, return true.
1558 'GitViewers': Called when generating the list of git viewers for
1559 Special:Version, use this to change the list.
1560 &$extTypes: associative array of repo URLS to viewer URLs.
1562 'HistoryRevisionTools': Override or extend the revision tools available from the
1563 page history view, i.e. undo, rollback, etc.
1564 $rev: Revision object
1565 &$links: Array of HTML links
1566 $prevRev: Revision object, next in line in page history, or null
1567 $user: Current user object
1569 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1571 $context: An IContextSource object with information about the request being
1574 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1575 image insertion. You can skip the default logic entirely by returning false, or
1576 just modify a few things using call-by-reference.
1578 &$title: Title object of the image
1579 &$file: File object, or false if it doesn't exist
1580 &$frameParams: Various parameters with special meanings; see documentation in
1581 includes/Linker.php for Linker::makeImageLink
1582 &$handlerParams: Various parameters with special meanings; see documentation in
1583 includes/Linker.php for Linker::makeImageLink
1584 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1585 &$res: Final HTML output, used if you return false
1587 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1588 the image on an image page.
1589 &$imagePage: ImagePage object ($this)
1592 'ImagePageAfterImageLinks': Called after the image links section on an image
1594 $imagePage: ImagePage object ($this)
1595 &$html: HTML for the hook to add
1597 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1598 $imagePage: ImagePage object ($this)
1600 &$line: the HTML of the history line
1601 &$css: the line CSS class
1603 'ImagePageFindFile': Called when fetching the file associated with an image
1605 $page: ImagePage object
1607 &$displayFile: displayed File object
1609 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1610 $page: ImagePage object
1611 &$toc: Array of <li> strings
1613 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1615 &$title: the Title object of the file as it would appear for the upload page
1616 &$path: the original file and path name when img_auth was invoked by the web
1618 &$name: the name only component of the file
1619 &$result: The location to pass back results of the hook routine (only used if
1621 $result[0]=The index of the header message
1622 $result[1]=The index of the body text message
1623 $result[2 through n]=Parameters passed to body text message. Please note the
1624 header message cannot receive/use parameters.
1626 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1627 Return false to stop further processing of the tag
1628 $reader: XMLReader object
1629 $logInfo: Array of information
1631 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1632 Return false to stop further processing of the tag
1633 $reader: XMLReader object
1634 &$pageInfo: Array of information
1636 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1637 Return false to stop further processing of the tag
1638 $reader: XMLReader object
1639 $pageInfo: Array of page information
1640 $revisionInfo: Array of revision information
1642 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1643 Return false to stop further processing of the tag
1644 $reader: XMLReader object
1646 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1647 Return false to stop further processing of the tag
1648 $reader: XMLReader object
1649 $revisionInfo: Array of information
1651 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1652 and edit summaries for transwiki imports.
1653 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1654 &$pageTitle: String that contains page title.
1656 'ImportSources': Called when reading from the $wgImportSources configuration
1657 variable. Can be used to lazy-load the import sources list.
1658 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1659 comment in DefaultSettings.php for the detail of how to structure this array.
1661 'InfoAction': When building information to display on the action=info page.
1662 $context: IContextSource object
1663 &$pageInfo: Array of information
1665 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1666 &$title: Title object for the current page
1667 &$request: WebRequest
1668 &$ignoreRedirect: boolean to skip redirect check
1669 &$target: Title/string of redirect target
1670 &$article: Article object
1672 'InternalParseBeforeLinks': during Parser's internalParse method before links
1673 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1674 &$parser: Parser object
1675 &$text: string containing partially parsed text
1676 &$stripState: Parser's internal StripState object
1678 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1679 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1680 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1681 template/parser function execution which respect nowiki and HTML-comments.
1682 &$parser: Parser object
1683 &$text: string containing partially parsed text
1684 &$stripState: Parser's internal StripState object
1686 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1687 Return true without providing an interwiki to continue interwiki search.
1688 $prefix: interwiki prefix we are looking for.
1689 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1690 iw_trans and optionally iw_api and iw_wikiid.
1692 'InvalidateEmailComplete': Called after a user's email has been invalidated
1694 $user: user (object) whose email is being invalidated
1696 'IRCLineURL': When constructing the URL to use in an IRC notification.
1697 Callee may modify $url and $query, URL will be constructed as $url . $query
1698 &$url: URL to index.php
1699 &$query: Query string
1700 $rc: RecentChange object that triggered url generation
1702 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1703 &$article: article (object) being checked
1705 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1706 &$ip: IP being check
1707 &$result: Change this value to override the result of IP::isTrustedProxy()
1709 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1710 $url: URL used to upload from
1711 &$allowed: Boolean indicating if uploading is allowed for given URL
1713 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1714 instance to return false if the domain name doesn't match your organization.
1715 $addr: The e-mail address entered by the user
1716 &$result: Set this and return false to override the internal checks
1718 'isValidPassword': Override the result of User::isValidPassword()
1719 $password: The password entered by the user
1720 &$result: Set this and return false to override the internal checks
1721 $user: User the password is being validated for
1723 'Language::getMessagesFileName':
1724 $code: The language code or the language we're looking for a messages file for
1725 &$file: The messages file path, you can override this to change the location.
1727 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1728 $wgExtensionMessagesFiles instead.
1729 Use this to define synonyms of magic words depending of the language
1730 &$magicExtensions: associative array of magic words synonyms
1731 $lang: language code (string)
1733 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1734 remove namespaces. Do not use this hook to add namespaces. Use
1735 CanonicalNamespaces for that.
1736 &$namespaces: Array of namespaces indexed by their numbers
1738 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1739 listed in $wgExtensionMessagesFiles instead.
1740 Use to define aliases of special pages names depending of the language
1741 &$specialPageAliases: associative array of magic words synonyms
1742 $lang: language code (string)
1744 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1745 &$names: array of language code => language name
1746 $code: language of the preferred translations
1748 'LanguageLinks': Manipulate a page's language links. This is called
1749 in various places to allow extensions to define the effective language
1751 $title: The page's Title.
1752 &$links: Associative array mapping language codes to prefixed links of the
1753 form "language:title".
1754 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1755 Currently unused, but planned to provide support for marking individual
1756 language links in the UI, e.g. for featured articles.
1758 'LanguageSelector': Hook to change the language selector available on a page.
1759 $out: The output page.
1760 $cssClassName: CSS class name of the language selector.
1762 'LinkBegin': Used when generating internal and interwiki links in
1763 Linker::link(), before processing starts. Return false to skip default
1764 processing and return $ret. See documentation for Linker::link() for details on
1765 the expected meanings of parameters.
1766 $skin: the Skin object
1767 $target: the Title that the link is pointing to
1768 &$html: the contents that the <a> tag should have (raw HTML); null means
1770 &$customAttribs: the HTML attributes that the <a> tag should have, in
1771 associative array form, with keys and values unescaped. Should be merged
1772 with default values, with a value of false meaning to suppress the
1774 &$query: the query string to add to the generated URL (the bit after the "?"),
1775 in associative array form, with keys and values unescaped.
1776 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1777 &$ret: the value to return if your hook returns false.
1779 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1780 just before the function returns a value. If you return true, an <a> element
1781 with HTML attributes $attribs and contents $html will be returned. If you
1782 return false, $ret will be returned.
1783 $skin: the Skin object
1784 $target: the Title object that the link is pointing to
1785 $options: the options. Will always include either 'known' or 'broken', and may
1786 include 'noclasses'.
1787 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1788 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1789 associative array form.
1790 &$ret: the value to return if your hook returns false.
1792 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1794 &$url: the image url
1795 &$alt: the image's alt text
1796 &$img: the new image HTML (if returning false)
1798 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1801 &$text: the link text
1802 &$link: the new link HTML (if returning false)
1803 &$attribs: the attributes to be applied.
1804 $linkType: The external link type
1806 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1808 $title: the Title object that the link is pointing to
1809 $file: the File object or false if broken link
1810 &$html: the link text
1811 &$attribs: the attributes to be applied
1812 &$ret: the value to return if your hook returns false
1814 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1816 &$linksUpdate: the LinksUpdate object
1818 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1819 each link table insert. For example, pagelinks, imagelinks, externallinks.
1820 $linksUpdate: LinksUpdate object
1821 $table: the table to insert links to
1822 $insertions: an array of links to insert
1824 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1825 including delete and insert, has completed for all link tables
1826 &$linksUpdate: the LinksUpdate object
1828 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1829 &$linksUpdate: the LinksUpdate object
1831 'ListDefinedTags': When trying to find all defined tags.
1832 &$tags: The list of tags.
1834 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1835 $updater: A DatabaseUpdater subclass
1837 'LocalFile::getHistory': Called before file history query performed.
1838 &$file: the File object
1840 &$fields: select fields
1842 &$opts: query options
1843 &$join_conds: JOIN conditions
1845 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1846 $file: the File object
1847 $archiveName: name of an old file version or false if it's the current one
1849 'LocalisationCacheRecache': Called when loading the localisation data into
1851 $cache: The LocalisationCache object
1852 $code: language code
1853 &$alldata: The localisation data from core and extensions
1854 &$purgeBlobs: whether to purge/update the message blobs via
1855 MessageBlobStore::clear()
1857 'LocalisationCacheRecacheFallback': Called for each language when merging
1858 fallback data into the cache.
1859 $cache: The LocalisationCache object
1860 $code: language code
1861 &$alldata: The localisation data from core and extensions. Note some keys may
1862 be omitted if they won't be merged into the final result.
1864 'LocalisationChecksBlacklist': When fetching the blacklist of
1865 localisation checks.
1866 &$blacklist: array of checks to blacklist. See the bottom of
1867 maintenance/language/checkLanguage.inc for the format of this variable.
1869 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1870 optional localisation messages
1871 &$ignored: Array of ignored message keys
1872 &$optional: Array of optional message keys
1874 'LocalUserCreated': Called when a local user has been created
1875 $user: User object for the created user
1876 $autocreated: Boolean, whether this was an auto-creation
1878 'LogEventsListGetExtraInputs': When getting extra inputs to display on
1879 Special:Log for a specific log type
1880 $type: String of log type being displayed
1881 $logEventsList: LogEventsList object for context and access to the WebRequest
1882 &$input: string HTML of an input element
1884 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1885 Returning false will prevent the string from being added to the OutputPage.
1886 &$s: html string to show for the log extract
1887 $types: String or Array Log types to show
1888 $page: String or Title The page title to show log entries for
1889 $user: String The user who made the log entries
1890 $param: Associative Array with the following additional options:
1891 - lim Integer Limit of items to show, default is 50
1892 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1893 - showIfEmpty boolean Set to false if you don't want any output in case the
1894 loglist is empty if set to true (default), "No matching items in log" is
1895 displayed if loglist is empty
1896 - msgKey Array If you want a nice box with a message, set this to the key of
1897 the message. First element is the message key, additional optional elements
1898 are parameters for the key that are processed with
1899 wfMessage()->params()->parseAsBlock()
1900 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1902 - wrap String Wrap the message in html (usually something like
1903 "<div ...>$1</div>").
1904 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1906 'LogException': Called before an exception (or PHP error) is logged. This is
1907 meant for integration with external error aggregation services; returning false
1908 will NOT prevent logging.
1909 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
1910 $suppressed: true if the error was suppressed via
1911 error_reporting()/wfSuppressWarnings()
1913 'LoginAuthenticateAudit': A login attempt for a valid user account either
1914 succeeded or failed. No return data is accepted; this hook is for auditing only.
1915 $user: the User object being authenticated against
1916 $password: the password being submitted and found wanting
1917 $retval: a LoginForm class constant with authenticateUserData() return
1918 value (SUCCESS, WRONG_PASS, etc.).
1920 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
1921 error messages. Allows to add additional error messages (except messages already
1922 in LoginForm::$validErrorMessages).
1923 &$messages: Already added messages (inclusive messages from
1924 LoginForm::$validErrorMessages)
1926 'LoginPasswordResetMessage': User is being requested to reset their password on
1927 login. Use this hook to change the Message that will be output on
1928 Special:ChangePassword.
1929 &$msg: Message object that will be shown to the user
1930 $username: Username of the user who's password was expired.
1932 'LoginUserMigrated': Called during login to allow extensions the opportunity to
1933 inform a user that their username doesn't exist for a specific reason, instead
1934 of letting the login form give the generic error message that the account does
1935 not exist. For example, when the account has been renamed or deleted.
1936 $user: the User object being authenticated against.
1937 &$msg: the message identifier for abort reason, or an array to pass a message
1940 'LogLine': Processes a single log entry on Special:Log.
1941 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1942 logging.log_type database field.
1943 $log_action: string for the type of log action (e.g. 'delete', 'block',
1944 'create2'). Corresponds to logging.log_action database field.
1945 $title: Title object that corresponds to logging.log_namespace and
1946 logging.log_title database fields.
1947 $paramArray: Array of parameters that corresponds to logging.log_params field.
1948 Note that only $paramArray[0] appears to contain anything.
1949 &$comment: string that corresponds to logging.log_comment database field, and
1950 which is displayed in the UI.
1951 &$revert: string that is displayed in the UI, similar to $comment.
1952 $time: timestamp of the log entry (added in 1.12)
1954 'LonelyPagesQuery': Allow extensions to modify the query used by
1955 Special:LonelyPages.
1956 &$tables: tables to join in the query
1957 &$conds: conditions for the query
1958 &$joinConds: join conditions for the query
1960 'MagicWordwgVariableIDs': When defining new magic words IDs.
1961 &$variableIDs: array of strings
1963 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1965 $refreshLinks: RefreshLinks object
1967 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1968 Ideally, this hook should only be used to add variables that depend on
1969 the current page/request; static configuration should be added through
1970 ResourceLoaderGetConfigVars instead.
1971 &$vars: variable (or multiple variables) to be added into the output of
1972 Skin::makeVariablesScript
1973 $out: The OutputPage which called the hook, can be used to get the real title.
1975 'MarkPatrolled': Before an edit is marked patrolled.
1976 $rcid: ID of the revision to be marked patrolled
1977 &$user: the user (object) marking the revision as patrolled
1978 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1979 sysop in order to mark an edit patrolled.
1980 $auto: true if the edit is being marked as patrolled automatically
1982 'MarkPatrolledComplete': After an edit is marked patrolled.
1983 $rcid: ID of the revision marked as patrolled
1984 &$user: user (object) who marked the edit patrolled
1985 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1986 sysop to patrol the edit.
1987 $auto: true if the edit is being marked as patrolled automatically
1989 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1990 something completely different, after the basic globals have been set up, but
1991 before ordinary actions take place.
1993 $article: Article on which the action will be performed
1994 $title: Title on which the action will be performed
1996 $request: $wgRequest
1997 $mediaWiki: The $mediawiki object
1999 'MessageCache::get': When fetching a message. Can be used to override the key
2000 for customisations. Given and returned message key must be in special format:
2001 1) first letter must be in lower case according to the content language.
2002 2) spaces must be replaced with underscores
2003 &$key: message key (string)
2005 'MessageCacheReplace': When a message page is changed. Useful for updating
2007 $title: name of the page changed.
2008 $text: new contents of the page.
2010 'MessagesPreLoad': When loading a message from the database.
2011 $title: title of the message (string)
2012 &$message: value (string), change it to the message you want to define
2014 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2015 $mimeMagic: Instance of MimeMagic.
2016 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2017 &$tail: More or equal than last 65558 bytes of the file in a string
2018 (in - Do not alter!).
2020 &$mime: MIME type (out).
2022 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2023 MIME type detected by considering the file extension.
2024 $mimeMagic: Instance of MimeMagic.
2025 $ext: File extension.
2026 &$mime: MIME type (in/out).
2028 'MimeMagicInit': Before processing the list mapping MIME types to media types
2029 and the list mapping MIME types to file extensions.
2030 As an extension author, you are encouraged to submit patches to MediaWiki's
2031 core to add new MIME types to mime.types.
2032 $mimeMagic: Instance of MimeMagic.
2033 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2034 for adding new MIME info to the list.
2035 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2036 for adding new MIME types to the list.
2038 'ModifyExportQuery': Modify the query used by the exporter.
2039 $db: The database object to be queried.
2040 &$tables: Tables in the query.
2041 &$conds: Conditions in the query.
2042 &$opts: Options for the query.
2043 &$join_conds: Join conditions for the query.
2045 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2047 $oldTitle: Title object of the current (old) location
2048 $newTitle: Title object of the new location
2049 $user: User making the move
2050 $reason: string of the reason provided by the user
2051 $status: Status object to pass error messages to
2053 'MovePageIsValidMove': Specify whether a page can be moved for technical
2055 $oldTitle: Title object of the current (old) location
2056 $newTitle: Title object of the new location
2057 $status: Status object to pass error messages to
2059 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2061 $index: Integer; the index of the namespace being checked.
2062 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2063 namespace are movable. Hooks may change this value to override the return
2064 value of MWNamespace::isMovable().
2066 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2067 $title: the diff page title (nullable)
2068 &$oldId: the actual old Id to use in the diff
2069 &$newId: the actual new Id to use in the diff (0 means current)
2070 $old: the ?old= param value from the url
2071 $new: the ?new= param value from the url
2073 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2075 $wikiPage: the WikiPage edited
2076 $rev: the new revision
2077 $baseID: the revision ID this was based off, if any
2078 $user: the editing user
2080 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2081 return false to omit the line from RecentChanges and Watchlist special pages.
2082 &$changeslist: The OldChangesList instance.
2083 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2084 $rc: The RecentChange object.
2085 &$classes: array of css classes for the <li> element
2087 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2088 can alter or append to the array of URLs for search & suggestion formats.
2089 &$urls: array of associative arrays with Url element attributes
2091 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2092 when a page view triggers a re-rendering of the page. This may happen
2093 particularly if the parser cache is split by user language, and no cached
2094 rendering of the page exists in the user's language. The hook is called
2095 before checking whether page_links_updated indicates that the links are up
2096 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2097 without triggering any updates.
2098 $page: the Page that was rendered.
2099 $title: the Title of the rendered page.
2100 $parserOutput: ParserOutput resulting from rendering the page.
2102 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2103 users and/or IP addresses too.
2104 &$otherBlockLink: An array with links to other block logs
2105 $ip: The requested IP address or username
2107 'OutputPageBeforeHTML': A page has been processed by the parser and the
2108 resulting HTML is about to be displayed.
2109 &$parserOutput: the parserOutput (object) that corresponds to the page
2110 &$text: the text that will be displayed, in HTML (string)
2112 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2113 body tag to allow for extensions to add attributes to the body of the page they
2114 might need. Or to allow building extensions to add body classes that aren't of
2115 high enough demand to be included in core.
2116 $out: The OutputPage which called the hook, can be used to get the real title
2117 $sk: The Skin that called OutputPage::headElement
2118 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2120 'OutputPageCheckLastModified': when checking if the page has been modified
2121 since the last visit.
2122 &$modifiedTimes: array of timestamps.
2123 The following keys are set: page, user, epoch
2125 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2126 categories. Implementations should return false if they generate the category
2127 links, so the default link generation is skipped.
2128 &$out: OutputPage instance (object)
2129 $categories: associative array, keys are category names, values are category
2130 types ("normal" or "hidden")
2131 &$links: array, intended to hold the result. Must be an associative array with
2132 category types as keys and arrays of HTML links as values.
2134 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2135 &$out: OutputPage instance (object)
2136 $parserOutput: parserOutput instance being added in $out
2138 'PageContentInsertComplete': After a new article is created.
2139 $wikiPage: WikiPage created
2140 $user: User creating the article
2141 $content: New content as a Content object
2142 $summary: Edit summary/comment
2143 $isMinor: Whether or not the edit was marked as minor
2144 $isWatch: (No longer used)
2145 $section: (No longer used)
2146 $flags: Flags passed to WikiPage::doEditContent()
2147 $revision: New Revision of the article
2149 'PageContentLanguage': Allows changing the language in which the content of a
2150 page is written. Defaults to the wiki content language ($wgContLang).
2151 $title: Title object
2152 &$pageLang: the page content language (either an object or a language code)
2153 $wgLang: the user language
2155 'PageContentSave': Before an article is saved.
2156 $wikiPage: the WikiPage (object) being saved
2157 $user: the user (object) saving the article
2158 $content: the new article content, as a Content object
2159 $summary: the article summary (comment)
2160 $isminor: minor flag
2161 $iswatch: watch flag
2164 'PageContentSaveComplete': After an article has been updated.
2165 $wikiPage: WikiPage modified
2166 $user: User performing the modification
2167 $content: New content, as a Content object
2168 $summary: Edit summary/comment
2169 $isMinor: Whether or not the edit was marked as minor
2170 $isWatch: (No longer used)
2171 $section: (No longer used)
2172 $flags: Flags passed to WikiPage::doEditContent()
2173 $revision: New Revision of the article (can be null for edits that change
2175 $status: Status object about to be returned by doEditContent()
2176 $baseRevId: the rev ID (or false) this edit was based on
2178 'PageHistoryBeforeList': When a history page list is about to be constructed.
2179 &$article: the article that the history is loading for
2180 $context: RequestContext object
2182 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2183 $historyAction: the action object
2184 &$row: the revision row for this line
2185 &$s: the string representing this parsed line
2186 &$classes: array containing the <li> element classes
2188 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2189 any output is generated, to allow batch lookups for prefetching information
2190 needed for display. If the hook handler returns false, the regular behavior of
2191 doBatchLookups() is skipped.
2192 $pager: the PageHistoryPager
2193 $result: a ResultWrapper representing the query result
2195 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2198 &$queryInfo: the query parameters
2200 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2201 which depends on user options should install this hook and append its values to
2203 &$confstr: reference to a hash key string which can be modified
2204 $user: User (object) requesting the page
2205 &$forOptions: array of options the hash is for
2207 'PageViewUpdates': Allow database (or other) changes to be made after a
2208 page view is seen by MediaWiki. Note this does not capture views made
2209 via external caches such as Squid.
2210 $wikipage: WikiPage (object) for the page being viewed.
2211 $user: User (object) for the user who is viewing.
2213 'ParserAfterParse': Called from Parser::parse() just after the call to
2214 Parser::internalParse() returns.
2215 &$parser: parser object
2216 &$text: text being parsed
2217 &$stripState: stripState used (object)
2219 'ParserAfterStrip': Called at end of parsing time.
2220 TODO: No more strip, deprecated ?
2221 &$parser: parser object
2222 &$text: text being parsed
2223 &$stripState: stripState used (object)
2225 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2226 &$parser: Parser object being used
2227 &$text: text that will be returned
2229 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2230 Parser::internalParseHalfParsed()
2231 &$parser: Parser object being used
2232 &$text: text that will be returned
2234 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2235 &$parser: Parser object
2236 &$text: text to parse
2237 &$stripState: StripState instance being used
2239 'ParserBeforeStrip': Called at start of parsing time.
2240 TODO: No more strip, deprecated ?
2241 &$parser: parser object
2242 &$text: text being parsed
2243 &$stripState: stripState used (object)
2245 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2246 &$parser: Parser object being used
2249 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2251 $parserCache: ParserCache object $parserOutput was stored in
2252 $parserOutput: ParserOutput object that was stored
2253 $title: Title of the page that was parsed to generate $parserOutput
2254 $popts: ParserOptions used for generating $parserOutput
2255 $revId: ID of the revision that was parsed to create $parserOutput
2257 'ParserClearState': Called at the end of Parser::clearState().
2258 &$parser: Parser object being cleared
2260 'ParserCloned': Called when the parser is cloned.
2261 $parser: Newly-cloned Parser object
2263 'ParserFirstCallInit': Called when the parser initialises for the first time.
2264 &$parser: Parser object being cleared
2266 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2268 &$parser: Parser object
2269 &$varCache: array to store the value in case of multiples calls of the
2271 &$index: index (string) of the magic
2272 &$ret: value of the magic word (the hook should set it)
2273 &$frame: PPFrame object to use for expanding any template variables
2275 'ParserGetVariableValueTs': Use this to change the value of the time for the
2276 {{LOCAL...}} magic word.
2277 &$parser: Parser object
2278 &$time: actual time (timestamp)
2280 'ParserGetVariableValueVarCache': use this to change the value of the variable
2281 cache or return false to not use it.
2282 &$parser: Parser object
2283 &$varCache: variable cache (array)
2285 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2286 ParserLimitReportFormat instead.
2287 Called at the end of Parser:parse() when the parser will
2288 include comments about size of the text parsed.
2289 $parser: Parser object
2290 &$limitReport: text that will be included (without comment tags)
2292 'ParserLimitReportFormat': Called for each row in the parser limit report that
2293 needs formatting. If nothing handles this hook, the default is to use "$key" to
2294 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2296 $key: Key for the limit report item (string)
2297 &$value: Value of the limit report item
2298 &$report: String onto which to append the data
2299 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2300 text intended for display in a monospaced font.
2301 $localize: If false, $report should be output in English.
2303 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2304 will include comments about size of the text parsed. Hooks should use
2305 $output->setLimitReportData() to populate data. Functions for this hook should
2306 not use $wgLang; do that in ParserLimitReportFormat instead.
2307 $parser: Parser object
2308 $output: ParserOutput object
2310 'ParserMakeImageParams': Called before the parser make an image link, use this
2311 to modify the parameters of the image.
2312 $title: title object representing the file
2313 $file: file object that will be used to create the image
2314 &$params: 2-D array of parameters
2315 $parser: Parser object that called the hook
2317 'ParserSectionCreate': Called each time the parser creates a document section
2318 from wikitext. Use this to apply per-section modifications to HTML (like
2319 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2320 can begin in one section and end in another. Make sure your code can handle
2321 that case gracefully. See the EditSectionClearerLink extension for an example.
2322 $parser: the calling Parser instance
2323 $section: the section number, zero-based, but section 0 is usually empty
2324 &$sectionContent: ref to the content of the section. modify this.
2325 $showEditLinks: boolean describing whether this section has an edit link
2327 'ParserTestGlobals': Allows to define globals for parser tests.
2328 &$globals: Array with all the globals which should be set for parser tests.
2329 The arrays keys serve as the globals names, its values are the globals values.
2331 'ParserTestParser': Called when creating a new instance of Parser in
2332 tests/parser/parserTest.inc.
2333 &$parser: Parser object created
2335 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2336 run. Use when page save hooks require the presence of custom tables to ensure
2337 that tests continue to run properly.
2338 &$tables: array of table names
2340 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2341 $page: the WikiPage of the candidate edit
2342 $content: the Content object of the candidate edit
2343 $output: the ParserOutput result of the candidate edit
2345 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2346 $user: User object whose policy you are modifying
2347 &$effectivePolicy: Array of policy statements that apply to this user
2348 $purpose: string indicating purpose of the check, one of 'login', 'create',
2351 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2353 $block: Block object (which is set to be autoblocking)
2354 &$blockIds: Array of block IDs of the autoblock
2356 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2357 my talk page, my contributions" etc).
2358 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2359 &$title: Title object representing the current page
2360 $skin: SkinTemplate object providing context (e.g. to check if the user is
2363 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2364 &$user: User performing the action
2365 $action: Action being performed
2366 &$result: Whether or not the action should be prevented
2367 Change $result and return false to give a definitive answer, otherwise
2368 the built-in rate limiting checks are used, if enabled.
2369 $incrBy: Amount to increment counter by
2371 'PlaceNewSection': Override placement of new sections. Return false and put the
2372 merged text into $text to override the default behavior.
2373 $wikipage: WikiPage object
2374 $oldtext: the text of the article before editing
2375 $subject: subject of the new section
2376 &$text: text of the new section
2378 'PostLoginRedirect': Modify the post login redirect behavior.
2379 Occurs after signing up or logging in, allows for interception of redirect.
2380 &$returnTo: The page name to return to, as a string
2381 &$returnToQuery: array of url parameters, mapping parameter names to values
2382 &$type: type of login redirect as string;
2383 error: display a return to link ignoring $wgRedirectOnLogin
2384 signup: display a return to link using $wgRedirectOnLogin if needed
2385 success: display a return to link using $wgRedirectOnLogin if needed
2386 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2388 'PreferencesFormPreSave': Override preferences being saved
2389 $formData: array of user submitted data
2390 $form: PreferencesForm object, also a ContextSource
2391 $user: User object with preferences to be saved set
2392 &$result: boolean indicating success
2394 'PreferencesGetLegend': Override the text used for the <legend> of a
2395 preferences section.
2396 $form: the PreferencesForm object. This is a ContextSource as well
2397 $key: the section name
2398 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2401 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2402 Override the title prefix search used for OpenSearch and
2403 AJAX search suggestions. Put results into &$results outparam and return false.
2404 $ns: array of int namespace keys to search in
2405 $search: search term (not guaranteed to be conveniently normalized)
2406 $limit: maximum number of results to return
2407 &$results: out param: array of page names (strings)
2408 $offset: number of results to offset from the beginning
2410 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2411 namespace from the search string so that extensions can attempt it.
2412 &$namespaces: array of int namespace keys to search in (change this if you can
2414 &$search: search term (replace this with term without the namespace if you can
2417 'PrefsEmailAudit': Called when user changes their email address.
2418 $user: User (object) changing his email address
2419 $oldaddr: old email address (string)
2420 $newaddr: new email address (string)
2422 'PrefsPasswordAudit': Called when user changes his password.
2423 $user: User (object) changing his password
2424 $newPass: new password
2425 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2427 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2429 $article: the title being (un)protected
2430 &$output: a string of the form HTML so far
2432 'ProtectionForm::save': Called when a protection form is submitted.
2433 $article: the Page being (un)protected
2434 &$errorMsg: an html message string of an error or an array of message name and
2436 $reasonstr: a string describing the reason page protection level is altered
2438 'ProtectionForm::showLogExtract': Called after the protection log extract is
2440 $article: the page the form is shown for
2441 $out: OutputPage object
2443 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2445 &$tables: Database tables to be used in the query
2446 &$conds: Conditions to be applied in the query
2447 &$joinConds: Join conditions to be applied in the query
2449 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2450 &$obj: RawAction object
2451 &$text: The text that's going to be the output
2453 'RecentChange_save': Called at the end of RecentChange::save().
2454 &$recentChange: RecentChange object
2456 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2457 names such as "oldid" that are preserved when using redirecting special pages
2458 such as Special:MyPage and Special:MyTalk.
2459 &$redirectParams: An array of parameters preserved by redirecting special pages.
2461 'RejectParserCacheValue': Return false to reject an otherwise usable
2462 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2463 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2465 $parserOutput: ParserOutput value.
2466 $wikiPage: WikiPage object.
2467 $parserOptions: ParserOptions object.
2469 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2470 instance. Can be used by an extension override what skin is used in certain
2472 $context: (IContextSource) The RequestContext the skin is being created for.
2473 &$skin: A variable reference you may set a Skin instance or string key on to
2474 override the skin that will be used for the context.
2476 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2477 $user: The user having their password expiration reset
2478 &$newExpire: The new expiration date
2480 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2481 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2482 to override its behavior. See the module docs for more information.
2483 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2485 $context: ResourceLoaderContext|null
2487 'ResourceLoaderGetConfigVars': Called at the end of
2488 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2489 configuration variables to JavaScript. Things that depend on the current page
2490 or request state must be added through MakeGlobalVariablesScript instead.
2491 &$vars: array( variable name => value )
2493 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2494 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2495 context-based variables.
2496 &$lessVars: array of variables already added
2498 'ResourceLoaderRegisterModules': Right before modules information is required,
2499 such as when responding to a resource
2500 loader request or generating HTML output.
2501 &$resourceLoader: ResourceLoader object
2503 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2504 called after the addition of 'qunit' and MediaWiki testing resources.
2505 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2506 included in core, is fed using tests/qunit/QUnitTestResources.php.
2507 To add a new qunit module named 'myext.tests':
2508 $testModules['qunit']['myext.tests'] = array(
2509 'script' => 'extension/myext/tests.js',
2510 'dependencies' => <any module dependency you might have>
2512 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2513 added to any module.
2514 &$ResourceLoader: object
2516 'RevisionInsertComplete': Called after a revision is inserted into the database.
2517 &$revision: the Revision
2518 $data: the data stored in old_text. The meaning depends on $flags: if external
2519 is set, it's the URL of the revision text in external storage; otherwise,
2520 it's the revision text itself. In either case, if gzip is set, the revision
2522 $flags: a comma-delimited list of strings representing the options used. May
2523 include: utf8 (this will always be set for new revisions); gzip; external.
2525 'SearchableNamespaces': An option to modify which namespaces are searchable.
2526 &$arr: Array of namespaces ($nsId => $name) which will be used.
2528 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2529 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2531 $term: Search term string
2532 &$title: Outparam; set to $title object and return false for a match
2534 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2535 if nothing was found.
2536 $term: Search term string
2537 &$title: Outparam; set to $title object and return false for a match
2539 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2540 the normal operations.
2541 $allSearchTerms: Array of the search terms in all content languages
2542 &$titleResult: Outparam; the value to return. A Title object or null.
2544 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2546 $term: Search term string
2547 &$title: Current Title object that is being returned (null if none found).
2549 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2551 $title: Current Title object being displayed in search results.
2552 &$id: Revision ID (default is false, for latest)
2554 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2555 perform when page content is modified. Currently called by
2556 AbstractContent::getSecondaryDataUpdates.
2557 $title: Title of the page that is being edited.
2558 $oldContent: Content object representing the page's content before the edit.
2559 $recursive: bool indicating whether DataUpdates should trigger recursive
2560 updates (relevant mostly for LinksUpdate).
2561 $parserOutput: ParserOutput representing the rendered version of the page
2563 &$updates: a list of DataUpdate objects, to be modified or replaced by
2566 'SelfLinkBegin': Called before a link to the current article is displayed to
2567 allow the display of the link to be customized.
2568 $nt: the Title object
2569 &$html: html to display for the link
2570 &$trail: optional text to display before $html
2571 &$prefix: optional text to display after $html
2572 &$ret: the value to return if your hook returns false
2574 'SendWatchlistEmailNotification': Return true to send watchlist email
2576 $targetUser: the user whom to send watchlist email notification
2577 $title: the page title
2578 $enotif: EmailNotification object
2580 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2581 loaded from storage. Return false to prevent it from being used.
2582 &$reason: String rejection reason to be logged
2583 $info: MediaWiki\Session\SessionInfo being validated
2584 $request: WebRequest being loaded from
2585 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2586 $data: Array|false Data array for the MediaWiki\Session\Session
2588 'SessionMetadata': Add metadata to a session being saved.
2589 $backend: MediaWiki\Session\SessionBackend being saved.
2590 &$metadata: Array Metadata to be stored. Add new keys here.
2591 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2592 request and 0+ FauxRequests.
2594 'SetupAfterCache': Called in Setup.php, after cache objects are set
2596 'ShortPagesQuery': Allow extensions to modify the query used by
2598 &$tables: tables to join in the query
2599 &$conds: conditions for the query
2600 &$joinConds: join conditions for the query
2601 &$options: options for the query
2603 'ShowMissingArticle': Called when generating the output for a non-existent page.
2604 $article: The article object corresponding to the page
2606 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2607 Customise the output of raw CSS and JavaScript in page views.
2608 $text: Text being shown
2609 $title: Title of the custom script/stylesheet page
2610 $output: Current OutputPage object
2612 'ShowSearchHit': Customize display of search hit.
2613 $searchPage: The SpecialSearch instance.
2614 $result: The SearchResult to show
2615 $terms: Search terms, for highlighting
2616 &$link: HTML of link to the matching page. May be modified.
2617 &$redirect: HTML of redirect info. May be modified.
2618 &$section: HTML of matching section. May be modified.
2619 &$extract: HTML of content extract. May be modified.
2620 &$score: HTML of score. May be modified.
2621 &$size: HTML of page size. May be modified.
2622 &$date: HTML of of page modification date. May be modified.
2623 &$related: HTML of additional info for the matching page. May be modified.
2624 &$html: May be set to the full HTML that should be used to represent the search
2625 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2626 function returned false.
2628 'ShowSearchHitTitle': Customise display of search hit title/link.
2629 &$title: Title to link to
2630 &$text: Text to use for the link
2631 $result: The search result
2632 $terms: The search terms entered
2633 $page: The SpecialSearch object
2634 &$query: Query string to be appended to the link
2636 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2637 Warning: This hook is run on each display. You should consider to use
2638 'SkinBuildSidebar' that is aggressively cached.
2640 &$bar: Sidebar content
2641 Modify $bar to add or modify sidebar portlets.
2643 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2644 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2645 the sitenotice/anonnotice.
2648 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2649 allow the normal method of notice selection/rendering to work, or change the
2650 value of $siteNotice and return false to alter it.
2651 &$siteNotice: HTML returned as the sitenotice
2654 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2656 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2657 the stock bottom scripts.
2659 'SkinAfterContent': Allows extensions to add text after the page content and
2660 article metadata. This hook should work in all skins. Set the &$data variable to
2661 the text you're going to add.
2662 &$data: (string) Text to be printed out directly (without parsing)
2665 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2667 &$bar: Sidebar contents
2668 Modify $bar to add or modify sidebar portlets.
2670 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2672 $title: displayed page title
2673 $type: 'normal' or 'history' for old/diff views
2674 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2675 message must be in HTML format, not wikitext!
2676 &$link: overridable HTML link to be passed into the message as $1
2677 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2680 'SkinEditSectionLinks': Modify the section edit links
2681 $skin: Skin object rendering the UI
2682 $title: Title object for the title being linked to (may not be the same as
2683 the page title, if the section is included from a template)
2684 $section: The designation of the section being pointed to, to be included in
2685 the link, like "§ion=$section"
2686 $tooltip: The default tooltip. Escape before using.
2687 By default, this is wrapped in the 'editsectionhint' message.
2688 &$result: Array containing all link detail arrays. Each link detail array should
2689 contain the following keys:
2690 - targetTitle - Target Title object
2691 - text - String for the text
2692 - attribs - Array of attributes
2693 - query - Array of query parameters to add to the URL
2694 - options - Array of options for Linker::link
2695 $lang: The language code to use for the link in the wfMessage function
2697 'SkinGetPoweredBy': TODO
2698 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2699 the MediaWiki icon but plain text instead.
2702 'SkinPreloadExistence': Supply titles that should be added to link existence
2703 cache before the page is rendered.
2704 &$titles: Array of Title objects
2707 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2708 If false is returned $subpages will be used instead of the HTML
2709 subPageSubtitle() generates.
2710 If true is returned, $subpages will be ignored and the rest of
2711 subPageSubtitle() will run.
2712 &$subpages: Subpage links HTML
2714 $out: OutputPage object
2716 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2718 &$sktemplate: SkinTemplate object
2719 &$nav_urls: array of tabs
2720 &$revid: The revision id of the permanent link
2721 &$revid2: The revision id of the permanent link, second time
2723 'SkinTemplateGetLanguageLink': After building the data for a language link from
2724 which the actual html is constructed.
2725 &$languageLink: array containing data about the link. The following keys can be
2726 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2727 $languageLinkTitle: Title object belonging to the external language link.
2728 $title: Title object of the page the link belongs to.
2729 $outputPage: The OutputPage object the links are built from.
2731 'SkinTemplateNavigation': Called on content pages after the tabs have been
2732 added, but before variants have been added.
2733 &$sktemplate: SkinTemplate object
2734 &$links: Structured navigation links. This is used to alter the navigation for
2735 skins which use buildNavigationUrls such as Vector.
2737 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2738 tab is added but before variants have been added.
2739 &$sktemplate: SkinTemplate object
2740 &$links: Structured navigation links. This is used to alter the navigation for
2741 skins which use buildNavigationUrls such as Vector.
2743 'SkinTemplateNavigation::Universal': Called on both content and special pages
2744 after variants have been added.
2745 &$sktemplate: SkinTemplate object
2746 &$links: Structured navigation links. This is used to alter the navigation for
2747 skins which use buildNavigationUrls such as Vector.
2749 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2751 &$sktemplate: SkinTemplate object
2752 &$tpl: QuickTemplate engine object
2754 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2755 &$sktemplate: SkinTemplate object
2756 &$res: set to true to prevent active tabs
2758 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2759 You can either create your own array, or alter the parameters for
2761 &$sktemplate: The SkinTemplate instance.
2762 $title: Title instance for the page.
2763 $message: Visible label of tab.
2764 $selected: Whether this is a selected tab.
2765 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2766 &$classes: Array of CSS classes to apply.
2767 &$query: Query string to add to link.
2769 &$result: Complete assoc. array if you want to return true.
2771 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2772 been rendered (useful for adding more).
2773 &$sk: The QuickTemplate based skin template running the hook.
2774 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2775 extensions that add support for BaseTemplateToolbox should watch for this
2776 dummy parameter with "$dummy=false" in their code and return without echoing
2777 any HTML to avoid creating duplicate toolbox items.
2779 'SoftwareInfo': Called by Special:Version for returning information about the
2781 &$software: The array of software in format 'name' => 'version'. See
2782 SpecialVersion::softwareInformation().
2784 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2785 $sp: SpecialPage object, for context
2786 &$fields: Current HTMLForm fields
2788 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2789 $id: User id number, only provided for backwards-compatibility
2790 $user: User object representing user contributions are being fetched for
2791 $sp: SpecialPage instance, providing context
2793 'SpecialContributions::getForm::filters': Called with a list of filters to render
2794 on Special:Contributions.
2795 $sp: SpecialContributions object, for context
2796 &$filters: List of filters rendered as HTML
2798 'SpecialListusersDefaultQuery': Called right before the end of
2799 UsersPager::getDefaultQuery().
2800 $pager: The UsersPager instance
2801 &$query: The query array to be returned
2803 'SpecialListusersFormatRow': Called right before the end of
2804 UsersPager::formatRow().
2805 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2806 $row: Database row object
2808 'SpecialListusersHeader': Called before closing the <fieldset> in
2809 UsersPager::getPageHeader().
2810 $pager: The UsersPager instance
2811 &$out: The header HTML
2813 'SpecialListusersHeaderForm': Called before adding the submit button in
2814 UsersPager::getPageHeader().
2815 $pager: The UsersPager instance
2816 &$out: The header HTML
2818 'SpecialListusersQueryInfo': Called right before the end of.
2819 UsersPager::getQueryInfo()
2820 $pager: The UsersPager instance
2821 &$query: The query array to be returned
2823 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2824 $type: String of the log type
2825 $request: WebRequest object for getting the value provided by the current user
2826 &$qc: Array for query conditions to add
2828 'SpecialMovepageAfterMove': Called after moving a page.
2829 &$movePage: MovePageForm object
2830 &$oldTitle: old title (object)
2831 &$newTitle: new title (object)
2833 'SpecialNewpagesConditions': Called when building sql query for
2835 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2836 $opts: FormOptions object containing special page options
2837 &$conds: array of WHERE conditionals for query
2838 &$tables: array of tables to be queried
2839 &$fields: array of columns to select
2840 &$join_conds: join conditions for the tables
2842 'SpecialNewPagesFilters': Called after building form options at NewPages.
2843 $special: the special page object
2844 &$filters: associative array of filter definitions. The keys are the HTML
2845 name/URL parameters. Each key maps to an associative array with a 'msg'
2846 (message key) and a 'default' value.
2848 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
2849 this hook to remove a core special page or conditionally register special pages.
2850 &$list: list (array) of core special pages
2852 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2853 $special: the SpecialPage object
2854 $subPage: the subpage string or null if no subpage was specified
2856 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2857 $special: the SpecialPage object
2858 $subPage: the subpage string or null if no subpage was specified
2860 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2861 $name: name of the special page
2862 &$form: HTMLForm object
2864 'SpecialPasswordResetOnSubmit': When executing a form submission on
2865 Special:PasswordReset.
2866 &$users: array of User objects.
2867 $data: array of data submitted by the user
2868 &$error: string, error code (message key) used to describe to error (out
2869 parameter). The hook needs to return false when setting this, otherwise it
2870 will have no effect.
2872 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2873 use this to change some selection criteria or substitute a different title.
2874 &$randstr: The random number from wfRandom()
2875 &$isRedir: Boolean, whether to select a redirect or non-redirect
2876 &$namespaces: An array of namespace indexes to get the title from
2877 &$extra: An array of extra SQL statements
2878 &$title: If the hook returns false, a Title object to use instead of the
2879 result from the normal query
2881 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2883 Called after building form options at RecentChanges.
2884 $special: the special page object
2885 &$filters: associative array of filter definitions. The keys are the HTML
2886 name/URL parameters. Each key maps to an associative array with a 'msg'
2887 (message key) and a 'default' value.
2889 'SpecialRecentChangesPanel': Called when building form options in
2890 SpecialRecentChanges.
2891 &$extraOpts: array of added items, to which can be added
2892 $opts: FormOptions for this request
2894 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
2896 Called when building SQL query for SpecialRecentChanges and
2897 SpecialRecentChangesLinked.
2898 &$conds: array of WHERE conditionals for query
2899 &$tables: array of tables to be queried
2900 &$join_conds: join conditions for the tables
2901 $opts: FormOptions for this request
2902 &$query_options: array of options for the database request
2903 &$select: Array of columns to select
2905 'SpecialResetTokensTokens': Called when building token list for
2907 &$tokens: array of token information arrays in the format of
2909 'preference' => '<preference-name>',
2910 'label-message' => '<message-key>',
2913 'SpecialSearchCreateLink': Called when making the message to create a page or
2914 go to the existing page.
2915 $t: title object searched for
2916 &$params: an array of the default message name and page title (as parameter)
2918 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
2919 canceled and a normal search will be performed. Returning true without setting
2920 $url does a standard redirect to $title. Setting $url redirects to the
2922 $term - The string the user searched for
2923 $title - The title the 'go' feature has decided to forward the user to
2924 &$url - Initially null, hook subscribers can set this to specify the final url to redirect to
2926 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2927 target doesn't exist.
2928 &$title: title object generated from the text entered by the user
2930 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2931 the advanced form, a.k.a. power search box.
2932 &$showSections: an array to add values with more options to
2933 $term: the search term (not a title object)
2934 $opts: an array of hidden options (containing 'redirs' and 'profile')
2936 'SpecialSearchProfileForm': Allows modification of search profile forms.
2937 $search: special page object
2938 &$form: String: form html
2939 $profile: String: current search profile
2940 $term: String: search term
2941 $opts: Array: key => value of hidden options for inclusion in custom forms
2943 'SpecialSearchProfiles': Allows modification of search profiles.
2944 &$profiles: profiles, which can be modified.
2946 'SpecialSearchResults': Called before search result display
2947 $term: string of search term
2948 &$titleMatches: empty or SearchResultSet object
2949 &$textMatches: empty or SearchResultSet object
2951 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2952 on the search results page. Useful for including an external search
2953 provider. To disable the output of MediaWiki search output, return
2955 $specialSearch: SpecialSearch object ($this)
2957 $term: Search term specified by the user
2959 'SpecialSearchResultsAppend': Called immediately before returning HTML
2960 on the search results page. Useful for including a feedback link.
2961 $specialSearch: SpecialSearch object ($this)
2963 $term: Search term specified by the user
2965 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2966 $search: SpecialSearch special page object
2967 $profile: String: current search profile
2968 $engine: the search engine
2970 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2971 &$extraStats: Array to save the new stats
2972 $extraStats['<name of statistic>'] => <value>;
2973 <value> can be an array with the keys "name" and "number":
2974 "name" is the HTML to be displayed in the name column
2975 "number" is the number to be displayed.
2976 or, <value> can be the number to be displayed and <name> is the
2977 message key to use in the name column,
2978 $context: IContextSource object
2980 'SpecialUploadComplete': Called after successfully uploading a file from
2982 &$form: The SpecialUpload object
2984 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2985 $wgVersion: Current $wgVersion for you to use
2986 &$versionUrl: Raw url to link to (eg: release notes)
2988 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2990 Called after building form options at Watchlist.
2991 $special: the special page object
2992 &$filters: associative array of filter definitions. The keys are the HTML
2993 name/URL parameters. Each key maps to an associative array with a 'msg'
2994 (message key) and a 'default' value.
2996 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2997 SpecialWatchlist. Allows extensions to register custom values they have
2998 inserted to rc_type so they can be returned as part of the watchlist.
2999 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3001 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3002 Called when building sql query for SpecialWatchlist.
3003 &$conds: array of WHERE conditionals for query
3004 &$tables: array of tables to be queried
3005 &$join_conds: join conditions for the tables
3006 &$fields: array of query fields
3007 $opts: A FormOptions object with watchlist options for the current request
3009 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3010 URL for a title when we have no other parameters on the URL. Gives a chance for
3011 extensions that alter page view behavior radically to abort that redirect or
3013 $request: WebRequest
3014 $title: Title of the currently found title obj
3015 $output: OutputPage object
3017 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3018 rendered (by ThumbnailImage:toHtml method).
3019 $thumbnail: the ThumbnailImage object
3020 &$attribs: image attribute array
3021 &$linkAttribs: image link attribute array
3023 'TitleArrayFromResult': Called when creating an TitleArray object from a
3025 &$titleArray: set this to an object to override the default object returned
3026 $res: database result used to create the object
3028 'TitleExists': Called when determining whether a page exists at a given title.
3029 $title: The title being tested.
3030 &$exists: Whether the title exists.
3032 'TitleGetEditNotices': Allows extensions to add edit notices
3033 $title: The Title object for the page the edit notices are for
3034 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3035 &$notices: Array of notices. Keys are i18n message keys, values are
3036 parseAsBlock()ed messages.
3038 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3039 that can be applied.
3040 $title: The title in question.
3041 &$types: The types of protection available.
3043 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3044 overriding default behavior for determining if a page exists. If $isKnown is
3045 kept as null, regular checks happen. If it's a boolean, this value is returned
3046 by the isKnown method.
3047 $title: Title object that is being checked
3048 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3050 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3051 Called when determining if a page is a CSS or JS page.
3052 $title: Title object that is being checked
3053 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3054 Hooks may change this value to override the return value of
3055 Title::isCssOrJsPage().
3057 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3058 that this hook is not called for interwiki pages or pages in immovable
3059 namespaces: for these, isMovable() always returns false.
3060 $title: Title object that is being checked
3061 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3062 Hooks may change this value to override the return value of
3065 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3066 Called when determining if a page is a wikitext or should
3067 be handled by separate handler (via ArticleViewCustom).
3068 $title: Title object that is being checked
3069 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3070 Hooks may change this value to override the return value of
3071 Title::isWikitextPage()
3073 'TitleMove': Before moving an article (title).
3076 $user: user who does the move
3078 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3081 $user: user who does the move
3083 'TitleMoveComplete': After moving an article (title), post-commit.
3086 &$user: user who did the move
3087 $pageid: database ID of the page that's been moved
3088 $redirid: database ID of the created redirect
3089 $reason: reason for the move
3090 $revision: the Revision created by the move
3092 'TitleMoveCompleting': After moving an article (title), pre-commit.
3095 $user: user who did the move
3096 $pageid: database ID of the page that's been moved
3097 $redirid: database ID of the created redirect
3098 $reason: reason for the move
3099 $revision: the Revision created by the move
3101 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3102 or override the quick permissions check.
3103 $title: The Title object being accessed
3104 $user: The User performing the action
3105 $action: Action being performed
3106 &$errors: Array of errors
3107 $doExpensiveQueries: Whether to do expensive DB queries
3108 $short: Whether to return immediately on first error
3110 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3111 adding the default error message if nothing allows the user to read the page. If
3112 a handler wants a title to *not* be whitelisted, it should also return false.
3113 $title: Title object being checked against
3114 $user: Current user object
3115 &$whitelisted: Boolean value of whether this title is whitelisted
3117 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3118 $title: Title object to purge
3119 &$urls: An array of URLs to purge from the caches, to be manipulated.
3121 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3122 PageArchive object has been created but before any further processing is done.
3123 &$archive: PageArchive object
3124 $title: Title object of the page that we're viewing
3126 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3127 PageArchive object has been created but before any further processing is done.
3128 &$archive: PageArchive object
3129 $title: Title object of the page that we're viewing
3131 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3132 the site is not in read-only mode, that the Title object is not null and after
3133 a PageArchive object has been constructed but before performing any further
3135 &$archive: PageArchive object
3136 $title: Title object of the page that we're about to undelete
3138 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3139 $title: title object related to the revision
3140 $rev: revision (object) that will be viewed
3142 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3143 Since 1.24: Paths pointing to a directory will be recursively scanned for
3144 test case files matching the suffix "Test.php".
3145 &$paths: list of test cases and directories to search.
3147 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3149 $action: action name
3150 $article: article "acted on"
3152 'UnwatchArticle': Before a watch is removed from an article.
3153 &$user: user watching
3154 &$page: WikiPage object to be removed
3155 &$status: Status object to be returned if the hook returns false
3157 'UnwatchArticleComplete': After a watch is removed from an article.
3158 $user: user that watched
3159 &$page: WikiPage object that was watched
3161 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3162 &$formattedPageStatus: list of valid page states
3164 'UploadComplete': Upon completion of a file upload.
3165 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3166 $uploadBase->getLocalFile().
3168 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3169 $type: (string) the requested upload type
3170 &$className: the class name of the Upload instance to be created
3172 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3173 poke at member variables like $mUploadDescription before the file is saved. Do
3174 not use this hook to break upload processing. This will return the user to a
3175 blank form with no error message; use UploadVerification and UploadVerifyFile
3177 &$form: UploadForm object
3179 'UploadForm:initial': Before the upload form is generated. You might set the
3180 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3181 text (HTML) either before or after the editform.
3182 &$form: UploadForm object
3184 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3186 &$descriptor: (array) the HTMLForm descriptor
3188 'UploadFormSourceDescriptors': after the standard source inputs have been
3189 added to the descriptor
3190 &$descriptor: (array) the HTMLForm descriptor
3191 &$radio: Boolean, if source type should be shown as radio button
3192 $selectedSourceType: The selected source type
3194 'UploadVerification': Additional chances to reject an uploaded file. Consider
3195 using UploadVerifyFile instead.
3196 $saveName: (string) destination file name
3197 $tempName: (string) filesystem path to the temporary file for checks
3198 &$error: (string) output: message key for message to show if upload canceled by
3199 returning false. May also be an array, where the first element is the message
3200 key and the remaining elements are used as parameters to the message.
3202 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3203 in most cases over UploadVerification.
3204 $upload: (object) an instance of UploadBase, with all info about the upload
3205 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3206 Handlers will typically only apply for specific MIME types.
3207 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3208 representing the problem with the file, where the first element is the message
3209 key and the remaining elements are used as parameters to the message.
3211 'User::mailPasswordInternal': before creation and mailing of a user's new
3213 &$user: the user who sent the message out
3214 &$ip: IP of the user who sent the message out
3215 &$u: the account whose new password will be set
3217 'UserAddGroup': Called when adding a group; return false to override
3218 stock group addition.
3219 $user: the user object that is to have a group added
3220 &$group: the group to add, can be modified
3222 'UserArrayFromResult': Called when creating an UserArray object from a database
3224 &$userArray: set this to an object to override the default object returned
3225 $res: database result used to create the object
3227 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3228 want to display an error message, try getUserPermissionsErrors.
3229 &$title: Title object being checked against
3230 &$user: Current user object
3231 $action: Action being checked
3232 &$result: Pointer to result returned if hook returns false. If null is returned,
3233 userCan checks are continued by internal code.
3235 'UserCanSendEmail': To override User::canSendEmail() permission check.
3236 &$user: User (object) whose permission is being checked
3237 &$canSend: bool set on input, can override on output
3239 'UserClearNewTalkNotification': Called when clearing the "You have new
3240 messages!" message, return false to not delete it.
3241 &$user: User (object) that will clear the message
3242 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3244 'UserCreateForm': change to manipulate the login form
3245 &$template: SimpleTemplate instance for the form
3247 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3248 &$user: User to get groups for
3249 &$groups: Current effective groups
3251 'UserGetAllRights': After calculating a list of all available rights.
3252 &$rights: Array of rights, which may be added to.
3254 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3255 before returning the options to the caller. Warning: This hook is called for
3256 every call to User::getDefaultOptions(), which means it's potentially called
3257 dozens or hundreds of times. You may want to cache the results of non-trivial
3258 operations in your hook function for this reason.
3259 &$defaultOptions: Array of preference keys and their default values.
3261 'UserGetEmail': Called when getting an user email address.
3263 &$email: email, change this to override local email
3265 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3266 email authentication.
3268 &$timestamp: timestamp, change this to override local email authentication
3271 'UserGetImplicitGroups': DEPRECATED!
3272 Called in User::getImplicitGroups().
3273 &$groups: List of implicit (automatically-assigned) groups
3275 'UserGetLanguageObject': Called when getting user's interface language object.
3277 &$code: Language code that will be used to create the object
3278 $context: IContextSource object
3280 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3281 &$reservedUsernames: $wgReservedUsernames
3283 'UserGetRights': Called in User::getRights().
3284 $user: User to get rights for
3285 &$rights: Current rights
3287 'UserGroupsChanged': Called after user groups are changed.
3288 $user: User whose groups changed
3289 $added: Groups added
3290 $removed: Groups removed
3291 $performer: User who performed the change, false if via autopromotion
3292 $reason: The reason, if any, given by the user performing the change,
3293 false if via autopromotion.
3295 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3296 specific block exemptions).
3297 $user: User in question
3298 $title: Title of the page in question
3299 &$blocked: Out-param, whether or not the user is blocked from that page.
3300 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3301 to edit their own user talk pages.
3303 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3305 $ip: User's IP address
3306 &$blocked: Whether the user is blocked, to be modified by the hook
3308 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3309 false if a UserGetRights hook might remove the named right.
3310 $right: The user right being checked
3312 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3313 $user: User in question.
3314 &$hidden: Set true if the user's name should be hidden.
3316 'UserIsLocked': Check if the user is locked. See User::isLocked().
3317 $user: User in question.
3318 &$locked: Set true if the user should be locked.
3320 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3321 environmental means; occurs after session is loaded.
3322 $user: user object being loaded
3324 'UserLoadDefaults': Called when loading a default user.
3328 'UserLoadFromDatabase': Called when loading a user from the database.
3330 &$s: database query object
3332 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3333 Called to authenticate users on external/environmental means; occurs before
3335 $user: user object being loaded
3336 &$result: set this to a boolean value to abort the normal authentication
3339 'UserLoadOptions': When user options/preferences are being loaded from the
3342 &$options: Options, can be modified.
3344 'UserLoggedIn': Called after a user is logged in
3345 $user: User object for the logged-in user
3347 'UserLoginComplete': After a user has logged in.
3348 &$user: the user object that was created on login
3349 &$inject_html: Any HTML to inject after the "logged in" message.
3351 'UserLoginForm': change to manipulate the login form
3352 &$template: SimpleTemplate instance for the form
3354 'UserLogout': Before a user logs out.
3355 &$user: the user object that is about to be logged out
3357 'UserLogoutComplete': After a user has logged out.
3358 &$user: the user object _after_ logout (won't have name, ID, etc.)
3359 &$inject_html: Any HTML to inject after the "logged out" message.
3360 $oldName: name of the user before logout (string)
3362 'UserMailerChangeReturnPath': Called to generate a VERP return address
3363 when UserMailer sends an email, with a bounce handling extension.
3364 $to: Array of MailAddress objects for the recipients
3365 &$returnPath: The return address string
3367 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3368 to split up an email with multiple the To: field into separate emails.
3369 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3371 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3372 Extensions can block sending the email by returning false and setting $error.
3373 $to: array of MailAdresses of the targets
3374 $from: MailAddress of the sender
3375 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3376 &$error: should be set to an error message string
3378 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3379 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3380 $to: array of MailAdresses of the targets
3381 $from: MailAddress of the sender
3382 &$subject: email subject (not MIME encoded)
3383 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3384 &$body: email body (in MIME format) as a string
3385 &$error: should be set to an error message string
3387 'UserRemoveGroup': Called when removing a group; return false to override stock
3389 $user: the user object that is to have a group removed
3390 &$group: the group to be removed, can be modified
3392 'UserRequiresHTTPS': Called to determine whether a user needs
3393 to be switched to HTTPS.
3394 $user: User in question.
3395 &$https: Boolean whether $user should be switched to HTTPS.
3397 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3398 have been requested to be reset. This hook can be used to exclude certain
3399 options from being reset even when the user has requested all prefs to be reset,
3400 because certain options might be stored in the user_properties database table
3401 despite not being visible and editable via Special:Preferences.
3402 $user: the User (object) whose preferences are being reset
3403 &$newOptions: array of new (site default) preferences
3404 $options: array of the user's old preferences
3405 $resetKinds: array containing the kinds of preferences to reset
3407 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3409 &$user: user retrieving new talks messages
3410 &$talks: array of new talks page(s)
3412 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3413 After a user's group memberships are changed.
3414 &$user: User object that was changed
3415 $add: Array of strings corresponding to groups added
3416 $remove: Array of strings corresponding to groups removed
3418 'UserSaveOptions': Called just before saving user preferences/options.
3420 &$options: Options, modifiable
3422 'UserSaveSettings': Called when saving user settings.
3425 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3426 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3427 instead. Otherwise, you can no longer count on user data being saved to cookies
3428 versus some other mechanism.
3429 Called when setting user cookies.
3431 &$session: session array, will be added to the session
3432 &$cookies: cookies array mapping cookie name to its value
3434 'UserSetEmail': Called when changing user email address.
3436 &$email: new email, change this to override new email address
3438 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3439 email authentication.
3441 &$timestamp: new timestamp, change this to override local email
3442 authentication timestamp
3444 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3445 "Foobar (Talk | Contribs | Block)".
3446 $userId: User id of the current user
3447 $userText: User name of the current user
3448 &$items: Array of user tool links as HTML fragments
3450 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3451 FormatMetadata::getExtendedMeta (return false means cache will be
3452 invalidated and GetExtendedMetadata hook called again).
3453 $timestamp: The timestamp metadata was generated
3454 $file: The file the metadata is for
3456 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3457 used to alter the SQL query which gets the list of wanted pages.
3458 &$wantedPages: WantedPagesPage object
3459 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3461 'WatchArticle': Before a watch is added to an article.
3462 &$user: user that will watch
3463 &$page: WikiPage object to be watched
3464 &$status: Status object to be returned if the hook returns false
3466 'WatchArticleComplete': After a watch is added to an article.
3467 &$user: user that watched
3468 &$page: WikiPage object watched
3470 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3471 form, used to manipulate the list of pages or preload data based on that list.
3472 &$watchlistInfo: array of watchlisted pages in
3473 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3475 'WatchlistEditorBuildRemoveLine': when building remove lines in
3476 Special:Watchlist/edit.
3477 &$tools: array of extra links
3478 $title: Title object
3479 $redirect: whether the page is a redirect
3481 &$link: HTML link to title
3483 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3485 $router: The PathRouter instance
3487 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3488 Return false to prevent setting of the cookie.
3489 &$name: Cookie name passed to WebResponse::setcookie()
3490 &$value: Cookie value passed to WebResponse::setcookie()
3491 &$expire: Cookie expiration, as for PHP's setcookie()
3492 &$options: Options passed to WebResponse::setcookie()
3494 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3495 run a MediaWiki cli script.
3496 &$script: MediaWiki cli script path
3497 &$parameters: Array of arguments and options to the script
3498 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3501 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3502 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3503 &$qp: The list of QueryPages
3505 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3506 $row: The DB row of the entry.
3507 $title: The Title of the page where the link comes FROM
3508 $target: The Title of the page where the link goes TO
3509 &$props: Array of HTML strings to display after the title.
3511 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3512 dumps. One, and only one hook should set this, and return false.
3513 &$tables: Database tables to use in the SELECT query
3514 &$opts: Options to use for the query
3515 &$join: Join conditions
3517 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3518 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3519 specific to a content model should be provided by the respective Content's
3520 getDeletionUpdates() method.
3522 $content: the Content to generate updates for
3523 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3525 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3526 extra metadata to be added.
3527 $obj: The XmlDumpWriter object.
3528 &$out: The output string.
3529 $row: The database row for the page.
3530 $title: The title of the page.
3532 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3534 &$obj: The XmlDumpWriter object.
3535 &$out: The text being output.
3536 $row: The database row for the revision.
3537 $text: The revision text.
3539 More hooks might be available but undocumented, you can execute
3540 "php maintenance/findHooks.php" to find hidden ones.