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