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', 'ArticleSave', 'ArticleSaveComplete',
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 (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('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['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = 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 wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() 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 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: HTML to display on abort
266 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
267 Create the object with Status::newFatal() to ensure proper API error messages
268 are returned when creating account through API clients.
270 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
271 $targetUser: the user whom to send talk page email notification
272 $title: the page title
274 'SendWatchlistEmailNotification': Return true to send watchlist email notification
275 $targetUser: the user whom to send watchlist email notification
276 $title: the page title
277 $enotif: EmailNotification object
279 'AbortChangePassword': Return false to cancel password change.
280 $user: the User object to which the password change is occuring
281 $mOldpass: the old password provided by the user
282 $newpass: the new password provided by the user
283 &$abortMsg: the message identifier for abort reason
285 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
286 $name: name of the action
287 &$form: HTMLForm object
288 $article: Article object
290 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
291 Allows to change the fields on the form that will be generated.
292 $name: name of the action
293 &$fields: HTMLForm descriptor array
294 $article: Article object
296 'AddNewAccount': After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
301 $apiModule: the ApiCreateAccount module calling
302 $loginForm: the LoginForm used
304 'AddNewAccountApiResult': Modify API output when creating a new account via API.
305 $apiModule: the ApiCreateAccount module calling
306 $loginForm: the LoginForm used
307 &$result: associative array for API result data
309 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
310 before OutputPage::sendCacheControl() and final ob_end_flush() which
311 will send the buffered output to the client. This allows for last-minute
312 modification of the output within the buffer by using ob_get_clean().
313 $output: The OutputPage object where output() was called
315 'AfterImportPage': When a page import is completed.
316 $title: Title under which the revisions were imported
317 $foreignTitle: ForeignTitle object based on data provided by the XML file
318 $revCount: Number of revisions in the XML file
319 $sRevCount: Number of successfully imported revisions
320 $pageInfo: associative array of page information
322 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
323 just before adding its HTML to parser output.
324 $parser: Parser object that called the hook
325 $ig: Gallery, an object of one of the gallery classes (inheriting from
327 $html: HTML generated by the gallery
329 'AlternateEdit': Before checking if a user can edit a page and before showing
330 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
331 $editPage: the EditPage object
333 'AlternateEditPreview': Before generating the preview of the page when editing
334 ( EditPage::getPreviewText() ).
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
339 return false and set $previewHTML and $parserOutput to output custom page
342 'AlternateUserMailer': Called before mail is sent so that mail could be logged
343 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
344 the regular method of sending mail. Return a string to return a php-mail-error
345 message containing the error. Returning true will continue with sending email
347 $headers: Associative array of headers for the email
348 $to: MailAddress object or array
350 $subject: Subject of the email
351 $body: Body of the message
353 'APIAfterExecute': After calling the execute() method of an API module. Use
354 this to extend core API modules.
355 &$module: Module object
357 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
358 &$main: ApiMain object
360 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
361 authenticate and authorize API clients before executing the module. Return
362 false and set a message to cancel the request.
363 $module: Module object
365 &$message: API usage message to die with, as a message key or array
366 as accepted by ApiBase::dieUsageMsg.
368 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
369 processing request parameters. Return false to let the request fail, returning
370 an error message or an <edit result="Failure"> tag if $resultArr was filled.
371 $editPage : the EditPage object
372 $text : the new text of the article (has yet to be saved)
373 &$resultArr : data in this array will be added to the API result
375 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
376 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
377 this hook may cancel the hook to signal that the item is not viewable in the
379 $row: A row of data from ContribsPager. The set of data returned by ContribsPager
380 can be adjusted by handling the ContribsPager::reallyDoQuery hook.
381 $context: An IContextSource implementation.
382 &$feedItem: Set this to a FeedItem instance if the callback can handle the provided
383 row. This is provided to the hook as a null, if it is non null then another callback
384 has already handled the hook.
386 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
387 highlighting, add output to $context->getOutput() and return false.
388 $context: An IContextSource.
389 $text: Text to be highlighted.
390 $mime: MIME type of $text.
391 $format: API format code for $text.
393 'APIGetAllowedParams': Use this hook to modify a module's parameters.
394 &$module: ApiBase Module object
395 &$params: Array of parameters
396 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
398 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
399 Use this hook to modify a module's description.
400 &$module: ApiBase Module object
401 &$desc: String description, or array of description strings
403 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
404 $module: ApiBase Module object
405 &$msg: Array of Message objects
407 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
408 Use this hook to modify a module's parameter descriptions.
409 &$module: ApiBase Module object
410 &$desc: Array of parameter descriptions
412 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
413 $module: ApiBase Module object
414 &$msg: Array of arrays of Message objects
416 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
417 $module: ApiBase Module object
418 &$help: Array of HTML strings to be joined for the output.
419 $options: Array Options passed to ApiHelp::getHelp
421 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
422 can alter or append to the array.
423 &$results: array with integer keys to associative arrays. Keys in associative
425 - title: Title object.
426 - redirect from: Title or null.
427 - extract: Description for this result.
428 - extract trimmed: If truthy, the extract will not be trimmed to
429 $wgOpenSearchDescriptionLength.
430 - image: Thumbnail for this result. Value is an array with subkeys 'source'
431 (url), 'width', 'height', 'alt', 'align'.
432 - url: Url for the given title.
434 'APIQueryAfterExecute': After calling the execute() method of an
435 action=query submodule. Use this to extend core API modules.
436 &$module: Module object
438 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
439 an action=query submodule. Use this to extend core API modules.
440 &$module: Module object
441 &$resultPageSet: ApiPageSet object
443 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
444 Use this hook to add custom tokens to prop=info. Every token has an action,
445 which will be used in the intoken parameter and in the output
446 (actiontoken="..."), and a callback function which should return the token, or
447 false if the user isn't allowed to obtain it. The prototype of the callback
448 function is func($pageid, $title), where $pageid is the page ID of the page the
449 token is requested for and $title is the associated Title object. In the hook,
450 just add your callback to the $tokenFunctions array and return true (returning
451 false makes no sense).
452 $tokenFunctions: array(action => callback)
454 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
455 Use this hook to add custom tokens to prop=revisions. Every token has an
456 action, which will be used in the rvtoken parameter and in the output
457 (actiontoken="..."), and a callback function which should return the token, or
458 false if the user isn't allowed to obtain it. The prototype of the callback
459 function is func($pageid, $title, $rev), where $pageid is the page ID of the
460 page associated to the revision the token is requested for, $title the
461 associated Title object and $rev the associated Revision object. In the hook,
462 just add your callback to the $tokenFunctions array and return true (returning
463 false makes no sense).
464 $tokenFunctions: array(action => callback)
466 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
467 Use this hook to add custom tokens to list=recentchanges. Every token has an
468 action, which will be used in the rctoken parameter and in the output
469 (actiontoken="..."), and a callback function which should return the token, or
470 false if the user isn't allowed to obtain it. The prototype of the callback
471 function is func($pageid, $title, $rc), where $pageid is the page ID of the
472 page associated to the revision the token is requested for, $title the
473 associated Title object and $rc the associated RecentChange object. In the
474 hook, just add your callback to the $tokenFunctions array and return true
475 (returning false makes no sense).
476 $tokenFunctions: array(action => callback)
478 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
479 sites general information.
480 $module: the current ApiQuerySiteInfo module
481 &$results: array of results, add things here
483 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
484 sites statistics information.
485 &$results: array of results, add things here
487 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
488 action=query&meta=tokens. Note that most modules will probably be able to use
489 the 'csrf' token instead of creating their own token types.
490 &$salts: array( type => salt to pass to User::getEditToken() )
492 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
493 Use this hook to add custom token to list=users. Every token has an action,
494 which will be used in the ustoken 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($user) where $user is the User object. In the hook, just add
498 your callback to the $tokenFunctions array and return true (returning false
500 $tokenFunctions: array(action => callback)
502 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
503 an exception is thrown during API action execution.
504 $apiMain: Calling ApiMain instance.
505 $e: Exception object.
507 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
508 should have its own entry in the $apis array and have a unique name, passed as
509 key for the array that represents the service data. In this data array, the
510 key-value-pair identified by the apiLink key is required.
511 &$apis: array of services
513 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
514 Use this hook to extend action=tokens with new token types.
515 &$tokenTypes: supported token types in format 'type' => callback function
516 used to retrieve this type of tokens.
518 'Article::MissingArticleConditions': Before fetching deletion & move log entries
519 to display a message of a non-existing page being deleted/moved, give extensions
520 a chance to hide their (unrelated) log entries.
521 &$conds: Array of query conditions (all of which have to be met; conditions will
522 AND in the final query)
523 $logTypes: Array of log types being queried
525 'ArticleAfterFetchContent': After fetching content of an article from the
526 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
527 $article: the article (object) being loaded from the database
528 &$content: the content (string) of the article
530 'ArticleAfterFetchContentObject': After fetching content of an article from the
532 $article: the article (object) being loaded from the database
533 &$content: the content of the article, as a Content object
535 'ArticleConfirmDelete': Before writing the confirmation form for article
537 $article: the article (object) being deleted
538 $output: the OutputPage object
539 &$reason: the reason (string) the article is being deleted
541 'ArticleContentOnDiff': Before showing the article content below a diff. Use
542 this to change the content in this area or how it is loaded.
543 $diffEngine: the DifferenceEngine
544 $output: the OutputPage object
546 'ArticleDelete': Before an article is deleted.
547 $wikiPage: the WikiPage (object) being deleted
548 $user: the user (object) deleting the article
549 $reason: the reason (string) the article is being deleted
550 $error: if the deletion was prohibited, the (raw HTML) error message to display
552 $status: Status object, modify this to throw an error. Overridden by $error
555 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
556 $title: Title of the article that has been deleted.
557 $outputPage: OutputPage that can be used to append the output.
559 'ArticleDeleteComplete': After an article is deleted.
560 $wikiPage: the WikiPage that was deleted
561 $user: the user that deleted the article
562 $reason: the reason the article was deleted
563 $id: id of the article that was deleted
564 $content: the Content of the deleted page
565 $logEntry: the ManualLogEntry used to record the deletion
567 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
569 &$wikiPage: WikiPage (object) of the user talk page
570 $recipient: User (object) who's talk page was edited
572 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
573 article has been changed.
574 $wikiPage: the WikiPage (object)
575 $editInfo: data holder that includes the parser output ($editInfo->output) for
576 that page after the change
577 $changed: bool for if the page was changed
579 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
580 recentchanges table, return false to not delete old entries.
581 $wikiPage: WikiPage (object) being modified
583 'ArticleFromTitle': when creating an article object from a title object using
584 Wiki::articleFromTitle().
585 $title: Title (object) used to create the article object
586 $article: Article (object) that will be returned
587 $context: IContextSource (object)
589 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
590 PageContentInsertComplete.
591 $wikiPage: WikiPage created
592 $user: User creating the article
594 $summary: Edit summary/comment
595 $isMinor: Whether or not the edit was marked as minor
596 $isWatch: (No longer used)
597 $section: (No longer used)
598 $flags: Flags passed to WikiPage::doEditContent()
599 $revision: New Revision of the article
601 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
602 $targetTitle: target title (object)
603 $destTitle: destination title (object)
605 'ArticlePageDataAfter': After loading data of an article from the database.
606 $wikiPage: WikiPage (object) whose data were loaded
607 $row: row (object) returned from the database server
609 'ArticlePageDataBefore': Before loading data of an article from the database.
610 $wikiPage: WikiPage (object) that data will be loaded
611 $fields: fields (array) to load from the database
613 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
614 $wikiPage: the WikiPage being saved
615 $popts: parser options to be used for pre-save transformation
617 'ArticleProtect': Before an article is protected.
618 $wikiPage: the WikiPage being protected
619 $user: the user doing the protection
620 $protect: boolean whether this is a protect or an unprotect
621 $reason: Reason for protect
622 $moveonly: boolean whether this is for move only or not
624 'ArticleProtectComplete': After an article is protected.
625 $wikiPage: the WikiPage that was protected
626 $user: the user who did the protection
627 $protect: boolean whether it was a protect or an unprotect
628 $reason: Reason for protect
629 $moveonly: boolean whether it was for move only or not
631 'ArticlePurge': Before executing "&action=purge".
632 $wikiPage: WikiPage (object) to purge
634 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
635 revisions of an article.
636 &$title: Title object of the article
638 'ArticleRevisionUndeleted': After an article revision is restored.
639 $title: the article title
640 $revision: the revision
641 $oldPageID: the page ID of the revision when archived (may be null)
643 'ArticleRollbackComplete': After an article rollback is completed.
644 $wikiPage: the WikiPage that was edited
645 $user: the user who did the rollback
646 $revision: the revision the page was reverted back to
647 $current: the reverted revision
649 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
651 $wikiPage: the WikiPage (object) being saved
652 $user: the user (object) saving the article
653 $text: the new article text
654 $summary: the article summary (comment)
659 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
660 PageContentSaveComplete instead.
661 $wikiPage: WikiPage modified
662 $user: User performing the modification
664 $summary: Edit summary/comment
665 $isMinor: Whether or not the edit was marked as minor
666 $isWatch: (No longer used)
667 $section: (No longer used)
668 $flags: Flags passed to WikiPage::doEditContent()
669 $revision: New Revision of the article
670 $status: Status object about to be returned by doEditContent()
671 $baseRevId: the rev ID (or false) this edit was based on
673 'ArticleUndelete': When one or more revisions of an article are restored.
674 $title: Title corresponding to the article restored
675 $create: Whether or not the restoration caused the page to be created (i.e. it
676 didn't exist before).
677 $comment: The comment associated with the undeletion.
678 $oldPageId: ID of page previously deleted (from archive table)
680 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
681 $pageArchive: the PageArchive object
682 &$logEntry: ManualLogEntry object
683 $user: User who is performing the log action
685 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
686 the user is redirected back to the page.
687 &$article: the article
688 &$sectionanchor: The section anchor link (e.g. "#overview" )
689 &$extraq: Extra query parameters which can be added via hooked functions
691 'ArticleViewFooter': After showing the footer section of an ordinary page view
692 $article: Article object
693 $patrolFooterShown: boolean whether patrol footer is shown
695 'ArticleViewHeader': Before the parser cache is about to be tried for article
697 &$article: the article
698 &$pcache: whether to try the parser cache or not
699 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
700 object to both indicate that the output is done and what parser output was used.
702 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
703 redirect was followed.
704 $article: target article (object)
706 'ArticleViewCustom': Allows to output the text of the article in a different
707 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
708 that it is preferable to implement proper handing for a custom data type using
709 the ContentHandler facility.
710 $text: text of the page
711 $title: title of the page
712 $output: reference to $wgOut
714 'ArticleContentViewCustom': Allows to output the text of the article in a
715 different format than wikitext. Note that it is preferable to implement proper
716 handing for a custom data type using the ContentHandler facility.
717 $content: content of the page, as a Content object
718 $title: title of the page
719 $output: reference to $wgOut
721 'AuthPluginAutoCreate': Called when creating a local account for an user logged
722 in from an external authentication method.
723 $user: User object created locally
725 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
726 Gives a chance for an extension to set it programmatically to a variable class.
727 &$auth: the $wgAuth object, probably a stub
729 'AutopromoteCondition': Check autopromote condition for user.
730 $type: condition type
733 $result: result of checking autopromote condition
735 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
739 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
740 certain title are fetched.
742 $title: title of the page to which backlinks are sought
743 &$conds: query conditions
745 'BadImage': When checking against the bad image list. Change $bad and return
746 false to override. If an image is "bad", it is not rendered inline in wiki
747 pages or galleries in category pages.
748 $name: Image name being checked
749 &$bad: Whether or not the image is "bad"
751 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
752 custom HTML after the section. Any uses of the hook need to handle escaping.
753 $template BaseTemplate
754 $portlet: string portlet name
757 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
758 "noarticletext-nopermission" at Article::showMissingArticle().
759 $article: article object
761 'BeforeInitialize': Before anything is initialized in
762 MediaWiki::performRequest().
763 &$title: Title being used for request
765 &$output: OutputPage object
767 $request: WebRequest object
768 $mediaWiki: Mediawiki object
770 'BeforePageDisplay': Prior to outputting a page.
771 &$out: OutputPage object
774 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
775 override how the redirect is output by modifying, or by returning false, and
776 letting standard HTTP rendering take place.
777 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
778 $context: IContextSource object
779 &$redirect: string URL, modifiable
781 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
782 override how the redirect is output by modifying, or by returning false and
783 taking over the output.
784 $out: OutputPage object
785 &$redirect: URL, modifiable
786 &$code: HTTP code (eg '301' or '302'), modifiable
788 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
789 $parser: Parser object
791 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
792 as a key then the file will appear as a broken thumbnail.
793 &$descQuery: query string to add to thumbnail URL
795 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
796 $parser: Parser object
797 $title: title of the template
798 &$skip: skip this template and link it?
799 &$id: the id of the revision being parsed
801 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
802 &$parser: Parser object
803 &$ig: ImageGallery object
805 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
807 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
808 to a newly created user account.
809 &$injected_html: Any HTML to inject after the "logged in" message of a newly
812 'BitmapHandlerTransform': before a file is transformed, gives extension the
813 possibility to transform it themselves
814 $handler: BitmapHandler
816 &$scalerParams: Array with scaler parameters
817 &$mto: null, set to a MediaTransformOutput
819 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
820 normalizations have been performed, except for the $wgMaxImageArea check.
822 &$params: Array of parameters
823 &$checkImageAreaHookResult: null, set to true or false to override the
824 $wgMaxImageArea check result.
826 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
828 $block: Block object (which is set to be autoblocking)
829 &$blockIds: Array of block IDs of the autoblock
831 'BlockIp': Before an IP address or user is blocked.
832 $block: the Block object about to be saved
833 $user: the user _doing_ the block (not the one being blocked)
834 &$reason: if the hook is aborted, the error message to be returned in an array
836 'BlockIpComplete': After an IP address or user is blocked.
837 $block: the Block object that was saved
838 $user: the user who did the block (not the one being blocked)
840 'BookInformation': Before information output on Special:Booksources.
841 $isbn: ISBN to show information for
842 $output: OutputPage object in use
844 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
845 to be able to access the wiki via HTTPS.
846 $ip: The IP address in human-readable form
847 &$canDo: This reference should be set to false if the client may not be able
850 'CanonicalNamespaces': For extensions adding their own namespaces or altering
852 Note that if you need to specify namespace protection or content model for
853 a namespace that is added in a CanonicalNamespaces hook handler, you
854 should do so by altering $wgNamespaceProtection and
855 $wgNamespaceContentModels outside the handler, in top-level scope. The
856 point at which the CanonicalNamespaces hook fires is too late for altering
857 these variables. This applies even if the namespace addition is
858 conditional; it is permissible to declare a content model and protection
859 for a namespace and then decline to actually register it.
860 &$namespaces: Array of namespace numbers with corresponding canonical names
862 'CategoryAfterPageAdded': After a page is added to a category.
863 $category: Category that page was added to
864 $wikiPage: WikiPage that was added
866 'CategoryAfterPageRemoved': After a page is removed from a category.
867 $category: Category that page was removed from
868 $wikiPage: WikiPage that was removed
870 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
871 $catpage: CategoryPage instance
873 'ChangePasswordForm': For extensions that need to add a field to the
874 ChangePassword form via the Preferences form.
875 &$extraFields: An array of arrays that hold fields like would be passed to the
878 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
879 &$changesList: ChangesList instance.
880 &$articlelink: HTML of link to article (already filled-in).
881 &$s: HTML of row that is being constructed.
882 &$rc: RecentChange instance.
883 $unpatrolled: Whether or not we are showing unpatrolled changes.
884 $watched: Whether or not the change is watched by the user.
886 'ChangesListInitRows': Batch process change list rows prior to rendering.
887 $changesList: ChangesList instance
888 $rows: The data that will be rendered. May be a ResultWrapper instance or
891 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
892 $special: ChangesListSpecialPage instance
893 &$filters: associative array of filter definitions. The keys are the HTML
894 name/URL parameters. Each key maps to an associative array with a 'msg'
895 (message key) and a 'default' value.
897 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
898 $name: name of the special page, e.g. 'Watchlist'
899 &$tables: array of tables to be queried
900 &$fields: array of columns to select
901 &$conds: array of WHERE conditionals for query
902 &$query_options: array of options for the database request
903 &$join_conds: join conditions for the tables
904 $opts: FormOptions for this request
906 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
907 removed from all revisions and log entries to which it was applied). This gives
908 extensions a chance to take it off their books.
909 $tag: name of the tag
910 &$status: Status object. Add warnings to this as required. There is no point
911 setting errors, as the deletion has already been partly carried out by this
914 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
915 from the UI (Special:Tags) or via the API. You could use this hook if you want
916 to reserve a specific "namespace" of tags, or something similar.
917 $tag: name of the tag
918 $user: user initiating the action
919 &$status: Status object. Add your errors using `$status->fatal()` or warnings
920 using `$status->warning()`. Errors and warnings will be relayed to the user.
921 If you set an error, the user will be unable to create the tag.
923 'ChangeTagCanDelete': Tell whether a change tag should be able to be
924 deleted from the UI (Special:Tags) or via the API. The default is that tags
925 defined using the ListDefinedTags hook are not allowed to be deleted unless
926 specifically allowed. If you wish to allow deletion of the tag, set
927 `$status = Status::newGood()` to allow deletion, and then `return false` from
928 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
929 out custom deletion actions.
930 $tag: name of the tag
931 $user: user initiating the action
932 &$status: Status object. See above.
934 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
935 uses are in active use.
936 &$tags: list of all active tags. Append to this array.
938 'LoginUserMigrated': Called during login to allow extensions the opportunity to
939 inform a user that their username doesn't exist for a specific reason, instead
940 of letting the login form give the generic error message that the account does
941 not exist. For example, when the account has been renamed or deleted.
942 $user: the User object being authenticated against.
943 &$msg: the message identifier for abort reason, or an array to pass a message
946 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
947 $collationName: Name of the collation in question
948 &$collationObject: Null. Replace with a subclass of the Collation class that
949 implements the collation given in $collationName.
951 'ConfirmEmailComplete': Called after a user's email has been confirmed
953 $user: user (object) whose email is being confirmed
955 'ContentHandlerDefaultModelFor': Called when the default content model is determined
956 for a given title. May be used to assign a different model for that title.
957 $title: the Title in question
958 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
960 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
961 content model name, but no entry for that model exists in $wgContentHandlers.
962 $modeName: the requested content model name
963 &$handler: set this to a ContentHandler object, if desired.
965 'ContentModelCanBeUsedOn': Called to determine whether that content model can
966 be used on a given page. This is especially useful to prevent some content models
967 to be used in some special location.
968 $contentModel: ID of the content model in question
969 $title: the Title in question.
970 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
971 Handler functions that modify $ok should generally return false to prevent further
972 hooks from further modifying $ok.
974 'ContentGetParserOutput': Customize parser output for a given content object,
975 called by AbstractContent::getParserOutput. May be used to override the normal
976 model-specific rendering of page content.
977 $content: The Content to render
978 $title: Title of the page, as context
979 $revId: The revision ID, as context
980 $options: ParserOptions for rendering. To avoid confusing the parser cache,
981 the output can only depend on parameters provided to this hook function, not on global state.
982 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
983 generation of HTML may be skipped, but other information should still be present in the
985 &$output: ParserOutput, to manipulate or replace
987 'ContentAlterParserOutput': Modify parser output for a given content object.
988 Called by Content::getParserOutput after parsing has finished. Can be used
989 for changes that depend on the result of the parsing but have to be done
990 before LinksUpdate is called (such as adding tracking categories based on
992 $content: The Content to render
993 $title: Title of the page, as context
994 $parserOutput: ParserOutput to manipulate
996 'ConvertContent': Called by AbstractContent::convert when a conversion to another
997 content model is requested.
998 $content: The Content object to be converted.
999 $toModel: The ID of the content model to convert to.
1000 $lossy: boolean indicating whether lossy conversion is allowed.
1001 &$result: Output parameter, in case the handler function wants to provide a
1002 converted Content object. Note that $result->getContentModel() must return $toModel.
1003 Handler functions that modify $result should generally return false to further
1004 attempts at conversion.
1006 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1007 &$pager: Pager object for contributions
1008 &$queryInfo: The query for the contribs Pager
1010 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
1011 &$data: an array of results of all contribs queries
1012 $pager: The ContribsPager object hooked into
1013 $offset: Index offset, inclusive
1014 $limit: Exact query limit
1015 $descending: Query direction, false for ascending, true for descending
1017 'ContributionsLineEnding': Called before a contributions HTML line is finished
1018 $page: SpecialPage object for contributions
1019 &$ret: the HTML line
1020 $row: the DB row for this line
1021 &$classes: the classes to add to the surrounding <li>
1023 'ContributionsToolLinks': Change tool links above Special:Contributions
1024 $id: User identifier
1025 $title: User page title
1026 &$tools: Array of tool links
1028 'CustomEditor': When invoking the page editor
1029 $article: Article being edited
1030 $user: User performing the edit
1032 Return true to allow the normal editor to be used, or false
1033 if implementing a custom editor, e.g. for a special namespace,
1036 'DatabaseOraclePostInit': Called after initialising an Oracle database
1037 &$db: the DatabaseOracle object
1039 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
1040 $title: the diff page title (nullable)
1041 &$oldId: the actual old Id to use in the diff
1042 &$newId: the actual new Id to use in the diff (0 means current)
1043 $old: the ?old= param value from the url
1044 $new: the ?new= param value from the url
1046 'DiffRevisionTools': Override or extend the revision tools available from the
1047 diff view, i.e. undo, etc.
1048 $newRev: Revision object of the "new" revision
1049 &$links: Array of HTML links
1050 $oldRev: Revision object of the "old" revision (may be null)
1052 'DiffViewHeader': Called before diff display
1053 $diff: DifferenceEngine object that's calling
1054 $oldRev: Revision object of the "old" revision (may be null/invalid)
1055 $newRev: Revision object of the "new" revision
1057 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1059 $article: article (object) being viewed
1060 $oldid: oldid (int) being viewed
1062 'DoEditSectionLink': Override the HTML generated for section edit links
1063 * Deprecated in favour of SkinEditSectionLinks hook *
1064 $skin: Skin object rendering the UI
1065 $title: Title object for the title being linked to (may not be the same as
1066 the page title, if the section is included from a template)
1067 $section: The designation of the section being pointed to, to be included in
1068 the link, like "§ion=$section"
1069 $tooltip: The default tooltip. Escape before using.
1070 By default, this is wrapped in the 'editsectionhint' message.
1071 &$result: The HTML to return, prefilled with the default plus whatever other
1072 changes earlier hooks have made
1073 $lang: The language code to use for the link in the wfMessage function
1075 'EditFilter': Perform checks on an edit
1076 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1077 $text: Contents of the edit box
1078 $section: Section being edited
1079 &$error: Error message to return
1080 $summary: Edit summary for page
1082 'EditFilterMerged': Post-section-merge edit filter.
1083 DEPRECATED, use EditFilterMergedContent instead.
1084 $editor: EditPage instance (object)
1085 $text: content of the edit box
1086 &$error: error message to return
1087 $summary: Edit summary for page
1089 'EditFilterMergedContent': Post-section-merge edit filter.
1090 This may be triggered by the EditPage or any other facility that modifies page content.
1091 Use the $status object to indicate whether the edit should be allowed, and to provide
1092 a reason for disallowing it. Return false to abort the edit, and true to continue.
1093 Returning true if $status->isOK() returns false means "don't save but continue user
1094 interaction", e.g. show the edit form. $status->apiHookResult can be set to an array
1095 to be returned by api.php action=edit. This is used to deliver captchas.
1096 $context: object implementing the IContextSource interface.
1097 $content: content of the edit box, as a Content object.
1098 $status: Status object to represent errors, etc.
1099 $summary: Edit summary for page
1100 $user: the User object representing the user whois performing the edit.
1101 $minoredit: whether the edit was marked as minor by the user.
1103 'EditFormPreloadText': Allows population of the edit form when creating
1105 &$text: Text to preload with
1106 &$title: Title object representing the page being created
1108 'EditFormInitialText': Allows modifying the edit form when editing existing
1110 $editPage: EditPage object
1112 'EditPage::attemptSave': Called before an article is
1113 saved, that is before WikiPage::doEditContent() is called
1114 $editpage_Obj: the current EditPage object
1116 'EditPage::importFormData': allow extensions to read additional data
1118 $editpage: EditPage instance
1119 $request: Webrequest
1120 return value is ignored (should always return true)
1122 'EditPage::showEditForm:fields': allows injection of form field into edit form
1123 $editor: the EditPage instance for reference
1124 $out: an OutputPage instance to write to
1125 return value is ignored (should always return true)
1127 'EditPage::showEditForm:initial': before showing the edit form
1128 $editor: EditPage instance (object)
1129 $out: an OutputPage instance to write to
1131 Return false to halt editing; you'll need to handle error messages, etc.
1132 yourself. Alternatively, modifying $error and returning true will cause the
1133 contents of $error to be echoed at the top of the edit form as wikitext.
1134 Return true without altering $error to allow the edit to proceed.
1136 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1137 but for the read-only 'view source' variant of the edit form.
1138 $editor: EditPage instance (object)
1139 &$out: an OutputPage instance to write to
1140 return value is ignored (should always return true)
1142 'EditPage::showStandardInputs:options': allows injection of form fields into
1143 the editOptions area
1144 $editor: EditPage instance (object)
1145 $out: an OutputPage instance to write to
1146 &$tabindex: HTML tabindex of the last edit check/button
1147 return value is ignored (should always be true)
1149 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1150 when there's an edit conflict. Return false to halt normal diff output; in
1151 this case you're responsible for computing and outputting the entire "conflict"
1152 part, i.e., the "difference between revisions" and "your text" headers and
1154 &$editor: EditPage instance
1155 &$out: OutputPage instance
1157 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1158 textarea in the edit form.
1159 &$editpage: The current EditPage object
1160 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1161 &$tabindex: HTML tabindex of the last edit check/button
1163 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1165 &$editpage: The current EditPage object
1166 &$checks: Array of edit checks like "watch this page"/"minor edit"
1167 &$tabindex: HTML tabindex of the last edit check/button
1169 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1170 textarea in the edit form.
1171 &$toolbar: The toolbar HTMl
1173 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1174 contribution/copyright notice.
1175 $title: title of page being edited
1176 &$msg: localization message name, overridable. Default is either
1177 'copyrightwarning' or 'copyrightwarning2'.
1179 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1180 modifying the wikitext that will be used in "Show changes". Note that it is
1181 preferable to implement diff handling for different data types using the
1182 ContentHandler facility.
1183 $editPage: EditPage object
1184 &$newtext: wikitext that will be used as "your version"
1186 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1187 "Show changes". Note that it is preferable to implement diff handling for
1188 different data types using the ContentHandler facility.
1189 $editPage: EditPage object
1190 &$newtext: wikitext that will be used as "your version"
1192 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1193 Allow modifying the wikitext that will be previewed. Note that it is preferable
1194 to implement previews for different data types using the ContentHandler
1196 $editPage: EditPage object
1197 &$toparse: wikitext that will be parsed
1199 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1200 previewed. Note that it is preferable to implement previews for different data
1201 types using the ContentHandler facility.
1202 $editPage: EditPage object
1203 &$content: Content object to be previewed (may be replaced by hook function)
1205 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1206 &$editpage: The current EditPage object
1207 &$res: the HTML of the error text
1209 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1210 of terms of service summary link that might exist separately from the copyright
1212 $title: title of page being edited
1213 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1215 'EmailConfirmed': When checking that the user's email address is "confirmed".
1216 $user: User being checked
1217 $confirmed: Whether or not the email address is confirmed
1218 This runs before the other checks, such as anonymity and the real check; return
1219 true to allow those checks to occur, and false if checking is done.
1221 'EmailUser': Before sending email from one user to another.
1222 $to: address of receiving user
1223 $from: address of sending user
1224 $subject: subject of the mail
1225 $text: text of the mail
1227 'EmailUserCC': Before sending the copy of the email to the author.
1228 $to: address of receiving user
1229 $from: address of sending user
1230 $subject: subject of the mail
1231 $text: text of the mail
1233 'EmailUserComplete': After sending email from one user to another.
1234 $to: address of receiving user
1235 $from: address of sending user
1236 $subject: subject of the mail
1237 $text: text of the mail
1239 'EmailUserForm': After building the email user form object.
1240 $form: HTMLForm object
1242 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1244 $user: The user who is trying to email another user.
1245 $editToken: The user's edit token.
1246 &$hookErr: Out-param for the error. Passed as the parameters to
1247 OutputPage::showErrorPage.
1249 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1251 $ip: The ip address of the user
1253 'ExtensionTypes': Called when generating the extensions credits, use this to
1254 change the tables headers.
1255 &$extTypes: associative array of extensions types
1257 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1258 thumbnail file name.
1259 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1260 $thumbname: the base name of the thumbnail file
1261 &$params: the currently extracted params (has source name, temp or archived zone)
1263 'FetchChangesList': When fetching the ChangesList derivative for a particular
1265 $user: User the list is being fetched for
1266 &$skin: Skin object to be used with the list
1267 &$list: List object (defaults to NULL, change it to an object instance and
1268 return false override the list derivative used)
1270 'FileDeleteComplete': When a file is deleted.
1271 $file: reference to the deleted file
1272 $oldimage: in case of the deletion of an old image, the name of the old file
1273 $article: in case all revisions of the file are deleted a reference to the
1274 WikiFilePage associated with the file.
1275 $user: user who performed the deletion
1278 'FileTransformed': When a file is transformed and moved into storage.
1279 $file: reference to the File object
1280 $thumb: the MediaTransformOutput object
1281 $tmpThumbPath: The temporary file system path of the transformed file
1282 $thumbPath: The permanent storage path of the transformed file
1284 'FileUpload': When a file upload occurs.
1285 $file : Image object representing the file that was uploaded
1286 $reupload : Boolean indicating if there was a previously another image there or
1288 $hasDescription : Boolean indicating that there was already a description page
1289 and a new one from the comment wasn't created (since 1.17)
1291 'FileUndeleteComplete': When a file is undeleted
1292 $title: title object to the file
1293 $fileVersions: array of undeleted versions. Empty if all versions were restored
1294 $user: user who performed the undeletion
1297 'FormatAutocomments': When an autocomment is formatted by the Linker.
1298 &$comment: Reference to the accumulated comment. Initially null, when set the
1299 default code will be skipped.
1300 $pre: Boolean, true if there is text before this autocomment
1301 $auto: The extracted part of the parsed comment before the call to the hook.
1302 $post: Boolean, true if there is text after this autocomment
1303 $title: An optional title object used to links to sections. Can be null.
1304 $local: Boolean indicating whether section links should refer to local page.
1306 'GalleryGetModes': Get list of classes that can render different modes of a
1308 &$modeArray: An associative array mapping mode names to classes that implement
1309 that mode. It is expected all registered classes are a subclass of
1312 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1314 &$user: user to promote.
1315 &$promote: groups that will be added.
1317 'GetBlockedStatus': after loading blocking status of an user from the database
1318 $user: user (object) being checked
1320 'GetCacheVaryCookies': Get cookies that should vary cache options.
1321 $out: OutputPage object
1322 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1323 that have to vary cache options
1325 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1327 $title: Title object of page
1328 $url: string value as output (out parameter, can modify)
1329 $query: query options passed to Title::getCanonicalURL()
1331 'GetDefaultSortkey': Override the default sortkey for a page.
1332 $title: Title object that we need to get a sortkey for
1333 &$sortkey: Sortkey to use.
1335 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1336 underscore) magic words. Called by MagicWord.
1337 &$doubleUnderscoreIDs: array of strings
1339 'GetExtendedMetadata': Get extended file metadata for the API
1340 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1341 'value' => prop value, 'source' => 'name of hook' ).
1342 $file: File object of file in question
1343 $context: RequestContext (including language to use)
1344 $single: Only extract the current language; if false, the prop value should
1345 be in the metadata multi-language array format:
1346 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1347 &$maxCacheTime: how long the results can be cached
1349 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1350 $title: Title object of page
1351 $url: string value as output (out parameter, can modify)
1352 $query: query options passed to Title::getFullURL()
1354 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1355 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1357 &$output: string for the output timestamp
1358 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1359 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1360 $user: User whose preferences are being used to make timestamp
1361 $lang: Language that will be used to render the timestamp
1363 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1364 $title: Title object of page
1365 $url: string value as output (out parameter, can modify)
1366 $query: query options passed to Title::getInternalURL()
1368 'GetIP': modify the ip of the current user (called only once).
1369 &$ip: string holding the ip as determined so far
1371 'GetLinkColours': modify the CSS class of an array of page links.
1372 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1374 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1376 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1377 working with internal urls (non-interwiki) then it may be preferable to work
1378 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1379 be buggy for internal urls on render if you do not re-implement the horrible
1380 hack that Title::getLocalURL uses in your own extension.
1381 $title: Title object of page
1382 &$url: string value as output (out parameter, can modify)
1383 $query: query options passed to Title::getLocalURL()
1385 'GetLocalURL::Internal': Modify local URLs to internal pages.
1386 $title: Title object of page
1387 &$url: string value as output (out parameter, can modify)
1388 $query: query options passed to Title::getLocalURL()
1390 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1391 without any fancy queries or variants.
1392 $title: Title object of page
1393 &$url: string value as output (out parameter, can modify)
1395 'GetLogTypesOnUser': Add log types where the target is a userpage
1396 &$types: Array of log types
1398 'GetMetadataVersion': Modify the image metadata version currently in use. This
1399 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1400 that need to have versioned metadata should add an element to the end of the
1401 version array of the form 'handler_name=version'. Most media handlers won't need
1402 to do this unless they broke backwards compatibility with a previous version of
1403 the media handler metadata output.
1404 &$version: Array of version strings
1406 'GetNewMessagesAlert': Disable or modify the new messages alert
1407 &$newMessagesAlert: An empty string by default. If the user has new talk page
1408 messages, this should be populated with an alert message to that effect
1409 $newtalks: An empty array if the user has no new messages or an array containing
1410 links and revisions if there are new messages (See User::getNewMessageLinks)
1411 $user: The user object of the user who is loading the page
1412 $out: OutputPage object (to check what type of page the user is on)
1414 'GetPreferences': Modify user preferences.
1415 $user: User whose preferences are being modified.
1416 &$preferences: Preferences description array, to be fed to an HTMLForm object
1418 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1419 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1421 &$output: string for the output timestamp
1422 &$diff: DateInterval representing the difference between the timestamps
1423 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1424 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1425 $user: User whose preferences are being used to make timestamp
1426 $lang: Language that will be used to render the timestamp
1428 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1429 checked for. Use instead of userCan for most cases. Return false if the user
1430 can't do it, and populate $result with the reason in the form of
1431 array( messagename, param1, param2, ... ). For consistency, error messages
1432 should be plain text with no special coloring, bolding, etc. to show that
1433 they're errors; presenting them properly to the user as errors is done by the
1435 $title: Title object being checked against
1436 $user : Current user object
1437 $action: Action being checked
1438 $result: User permissions error to add. If none, return true.
1440 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1441 called only if expensive checks are enabled. Add a permissions error when
1442 permissions errors are checked for. Return false if the user can't do it, and
1443 populate $result with the reason in the form of array( messagename, param1,
1444 param2, ... ). For consistency, error messages should be plain text with no
1445 special coloring, bolding, etc. to show that they're errors; presenting them
1446 properly to the user as errors is done by the caller.
1448 $title: Title object being checked against
1449 $user : Current user object
1450 $action: Action being checked
1451 $result: User permissions error to add. If none, return true.
1453 'GitViewers': Called when generating the list of git viewers for
1454 Special:Version, use this to change the list.
1455 &$extTypes: associative array of repo URLS to viewer URLs.
1457 'HistoryRevisionTools': Override or extend the revision tools available from the
1458 page history view, i.e. undo, rollback, etc.
1459 $rev: Revision object
1460 &$links: Array of HTML links
1462 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1464 $context: An IContextSource object with information about the request being served.
1466 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1467 image insertion. You can skip the default logic entirely by returning false, or
1468 just modify a few things using call-by-reference.
1470 &$title: Title object of the image
1471 &$file: File object, or false if it doesn't exist
1472 &$frameParams: Various parameters with special meanings; see documentation in
1473 includes/Linker.php for Linker::makeImageLink
1474 &$handlerParams: Various parameters with special meanings; see documentation in
1475 includes/Linker.php for Linker::makeImageLink
1476 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1477 &$res: Final HTML output, used if you return false
1480 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1481 the image on an image page.
1482 $imagePage: ImagePage object ($this)
1485 'ImagePageAfterImageLinks': Called after the image links section on an image
1487 $imagePage: ImagePage object ($this)
1488 &$html: HTML for the hook to add
1490 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1492 $line: the HTML of the history line
1493 $css: the line CSS class
1495 'ImagePageFindFile': Called when fetching the file associated with an image
1497 $page: ImagePage object
1499 &$displayFile: displayed File object
1501 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1502 $page: ImagePage object
1503 &$toc: Array of <li> strings
1505 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1507 &$title: the Title object of the file as it would appear for the upload page
1508 &$path: the original file and path name when img_auth was invoked by the web
1510 &$name: the name only component of the file
1511 &$result: The location to pass back results of the hook routine (only used if
1513 $result[0]=The index of the header message
1514 $result[1]=The index of the body text message
1515 $result[2 through n]=Parameters passed to body text message. Please note the
1516 header message cannot receive/use parameters.
1518 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1519 $reader: XMLReader object
1520 $logInfo: Array of information
1521 Return false to stop further processing of the tag
1523 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1524 $reader: XMLReader object
1525 $pageInfo: Array of information
1526 Return false to stop further processing of the tag
1528 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1529 $reader: XMLReader object
1530 $pageInfo: Array of page information
1531 $revisionInfo: Array of revision information
1532 Return false to stop further processing of the tag
1534 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1535 $reader: XMLReader object
1536 Return false to stop further processing of the tag
1538 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1539 $reader: XMLReader object
1540 $revisionInfo: Array of information
1541 Return false to stop further processing of the tag
1543 'InfoAction': When building information to display on the action=info page.
1544 $context: IContextSource object
1545 &$pageInfo: Array of information
1547 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1548 $title: Title object for the current page
1549 $request: WebRequest
1550 $ignoreRedirect: boolean to skip redirect check
1551 $target: Title/string of redirect target
1552 $article: Article object
1554 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1555 Return true without providing an interwiki to continue interwiki search.
1556 $prefix: interwiki prefix we are looking for.
1557 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1558 iw_trans and optionally iw_api and iw_wikiid.
1560 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1561 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1562 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1563 template/parser function execution which respect nowiki and HTML-comments.
1564 &$parser: Parser object
1565 &$text: string containing partially parsed text
1566 &$stripState: Parser's internal StripState object
1568 'InternalParseBeforeLinks': during Parser's internalParse method before links
1569 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1570 &$parser: Parser object
1571 &$text: string containing partially parsed text
1572 &$stripState: Parser's internal StripState object
1574 'InvalidateEmailComplete': Called after a user's email has been invalidated
1576 $user: user (object) whose email is being invalidated
1578 'IRCLineURL': When constructing the URL to use in an IRC notification.
1579 Callee may modify $url and $query, URL will be constructed as $url . $query
1580 &$url: URL to index.php
1581 &$query: Query string
1582 $rc: RecentChange object that triggered url generation
1584 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1585 $article: article (object) being checked
1587 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1589 $result: Change this value to override the result of wfIsTrustedProxy()
1591 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1592 $url: URL used to upload from
1593 &$allowed: Boolean indicating if uploading is allowed for given URL
1595 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1596 instance to return false if the domain name doesn't match your organization.
1597 $addr: The e-mail address entered by the user
1598 &$result: Set this and return false to override the internal checks
1600 'isValidPassword': Override the result of User::isValidPassword()
1601 $password: The password entered by the user
1602 &$result: Set this and return false to override the internal checks
1603 $user: User the password is being validated for
1605 'Language::getMessagesFileName':
1606 $code: The language code or the language we're looking for a messages file for
1607 &$file: The messages file path, you can override this to change the location.
1609 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1610 remove namespaces. Do not use this hook to add namespaces. Use
1611 CanonicalNamespaces for that.
1612 &$namespaces: Array of namespaces indexed by their numbers
1614 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1615 $wgExtensionMessagesFiles instead.
1616 Use this to define synonyms of magic words depending of the language
1617 $magicExtensions: associative array of magic words synonyms
1618 $lang: language code (string)
1620 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1621 listed in $wgExtensionMessagesFiles instead.
1622 Use to define aliases of special pages names depending of the language
1623 $specialPageAliases: associative array of magic words synonyms
1624 $lang: language code (string)
1626 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1627 &$names: array of language code => language name
1628 $code language of the preferred translations
1630 'LanguageLinks': Manipulate a page's language links. This is called
1631 in various places to allow extensions to define the effective language
1633 $title: The page's Title.
1634 &$links: Associative array mapping language codes to prefixed links of the
1635 form "language:title".
1636 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1637 Currently unused, but planned to provide support for marking individual
1638 language links in the UI, e.g. for featured articles.
1640 'LanguageSelector': Hook to change the language selector available on a page.
1641 $out: The output page.
1642 $cssClassName: CSS class name of the language selector.
1644 'LinkBegin': Used when generating internal and interwiki links in
1645 Linker::link(), before processing starts. Return false to skip default
1646 processing and return $ret. See documentation for Linker::link() for details on
1647 the expected meanings of parameters.
1648 $skin: the Skin object
1649 $target: the Title that the link is pointing to
1650 &$html: the contents that the <a> tag should have (raw HTML); null means
1652 &$customAttribs: the HTML attributes that the <a> tag should have, in
1653 associative array form, with keys and values unescaped. Should be merged with
1654 default values, with a value of false meaning to suppress the attribute.
1655 &$query: the query string to add to the generated URL (the bit after the "?"),
1656 in associative array form, with keys and values unescaped.
1657 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1658 &$ret: the value to return if your hook returns false.
1660 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1661 just before the function returns a value. If you return true, an <a> element
1662 with HTML attributes $attribs and contents $html will be returned. If you
1663 return false, $ret will be returned.
1664 $skin: the Skin object
1665 $target: the Title object that the link is pointing to
1666 $options: the options. Will always include either 'known' or 'broken', and may
1667 include 'noclasses'.
1668 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1669 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1670 associative array form.
1671 &$ret: the value to return if your hook returns false.
1673 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1675 &$url: the image url
1676 &$alt: the image's alt text
1677 &$img: the new image HTML (if returning false)
1679 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1682 &$text: the link text
1683 &$link: the new link HTML (if returning false)
1684 &$attribs: the attributes to be applied.
1685 $linkType: The external link type
1687 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1689 $title: the Title object that the link is pointing to
1690 $file: the File object or false if broken link
1691 &$html: the link text
1692 &$attribs: the attributes to be applied
1693 &$ret: the value to return if your hook returns false
1695 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1697 &$linksUpdate: the LinksUpdate object
1699 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1700 each link table insert. For example, pagelinks, imagelinks, externallinks.
1701 $linksUpdate: LinksUpdate object
1702 $table: the table to insert links to
1703 $insertions: an array of links to insert
1705 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1706 including delete and insert, has completed for all link tables
1707 &$linksUpdate: the LinksUpdate object
1709 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1710 &$linksUpdate: the LinksUpdate object
1712 'ListDefinedTags': When trying to find all defined tags.
1713 &$tags: The list of tags.
1715 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1716 &updater: A DatabaseUpdater subclass
1718 'LocalFile::getHistory': Called before file history query performed.
1719 $file: the File object
1721 $fields: select fields
1723 $opts: query options
1724 $join_conds: JOIN conditions
1726 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1727 $file: the File object
1728 $archiveName: name of an old file version or false if it's the current one
1730 'LocalisationCacheRecache': Called when loading the localisation data into
1732 $cache: The LocalisationCache object
1733 $code: language code
1734 &$alldata: The localisation data from core and extensions
1735 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1737 'LocalisationCacheRecacheFallback': Called for each language when merging
1738 fallback data into the cache.
1739 $cache: The LocalisationCache object
1740 $code: language code
1741 &$alldata: The localisation data from core and extensions. Note some keys may
1742 be omitted if they won't be merged into the final result.
1744 'LocalisationChecksBlacklist': When fetching the blacklist of
1745 localisation checks.
1746 &$blacklist: array of checks to blacklist. See the bottom of
1747 maintenance/language/checkLanguage.inc for the format of this variable.
1749 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1750 optional localisation messages
1751 &$ignored Array of ignored message keys
1752 &$optional Array of optional message keys
1754 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1755 for a specific log type
1756 $type: String of log type being displayed
1757 $logEventsList: LogEventsList object for context and access to the WebRequest
1758 &$input: string HTML of an input element
1761 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1762 Returning false will prevent the string from being added to the OutputPage.
1763 &$s: html string to show for the log extract
1764 $types: String or Array Log types to show
1765 $page: String or Title The page title to show log entries for
1766 $user: String The user who made the log entries
1767 $param: Associative Array with the following additional options:
1768 - lim Integer Limit of items to show, default is 50
1769 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1770 - showIfEmpty boolean Set to false if you don't want any output in case the
1771 loglist is empty if set to true (default), "No matching items in log" is
1772 displayed if loglist is empty
1773 - msgKey Array If you want a nice box with a message, set this to the key of
1774 the message. First element is the message key, additional optional elements
1775 are parameters for the key that are processed with
1776 wfMessage()->params()->parseAsBlock()
1777 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1779 - wrap String Wrap the message in html (usually something like
1780 "<div ...>$1</div>").
1781 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1783 'LoginAuthenticateAudit': A login attempt for a valid user account either
1784 succeeded or failed. No return data is accepted; this hook is for auditing only.
1785 $user: the User object being authenticated against
1786 $password: the password being submitted and found wanting
1787 $retval: a LoginForm class constant with authenticateUserData() return
1788 value (SUCCESS, WRONG_PASS, etc.).
1790 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1791 Use this hook to change the Message that will be output on Special:ChangePassword.
1792 &$msg: Message object that will be shown to the user
1793 $username: Username of the user who's password was expired.
1795 'LogLine': Processes a single log entry on Special:Log.
1796 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1797 logging.log_type database field.
1798 $log_action: string for the type of log action (e.g. 'delete', 'block',
1799 'create2'). Corresponds to logging.log_action database field.
1800 $title: Title object that corresponds to logging.log_namespace and
1801 logging.log_title database fields.
1802 $paramArray: Array of parameters that corresponds to logging.log_params field.
1803 Note that only $paramArray[0] appears to contain anything.
1804 &$comment: string that corresponds to logging.log_comment database field, and
1805 which is displayed in the UI.
1806 &$revert: string that is displayed in the UI, similar to $comment.
1807 $time: timestamp of the log entry (added in 1.12)
1809 'LonelyPagesQuery': Allow extensions to modify the query used by
1810 Special:LonelyPages.
1811 &$tables: tables to join in the query
1812 &$conds: conditions for the query
1813 &$joinConds: join conditions for the query
1815 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1817 $refreshLinks: RefreshLinks object
1819 'MagicWordwgVariableIDs': When defining new magic words IDs.
1820 $variableIDs: array of strings
1822 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1823 Ideally, this hook should only be used to add variables that depend on
1824 the current page/request; static configuration should be added through
1825 ResourceLoaderGetConfigVars instead.
1826 &$vars: variable (or multiple variables) to be added into the output of
1827 Skin::makeVariablesScript
1828 $out: The OutputPage which called the hook, can be used to get the real title.
1830 'MarkPatrolled': Before an edit is marked patrolled.
1831 $rcid: ID of the revision to be marked patrolled
1832 $user: the user (object) marking the revision as patrolled
1833 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1834 sysop in order to mark an edit patrolled.
1836 'MarkPatrolledComplete': After an edit is marked patrolled.
1837 $rcid: ID of the revision marked as patrolled
1838 $user: user (object) who marked the edit patrolled
1839 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1840 sysop to patrol the edit.
1842 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1843 something completely different, after the basic globals have been set up, but
1844 before ordinary actions take place.
1846 $article: Article on which the action will be performed
1847 $title: Title on which the action will be performed
1849 $request: $wgRequest
1850 $mediaWiki: The $mediawiki object
1852 'MessagesPreLoad': When loading a message from the database.
1853 $title: title of the message (string)
1854 $message: value (string), change it to the message you want to define
1856 'MessageCache::get': When fetching a message. Can be used to override the key
1857 for customisations. Given and returned message key must be in special format:
1858 1) first letter must be in lower case according to the content language.
1859 2) spaces must be replaced with underscores
1860 &$key: message key (string)
1862 'MessageCacheReplace': When a message page is changed. Useful for updating
1864 $title: name of the page changed.
1865 $text: new contents of the page.
1867 'MimeMagicInit': Before processing the list mapping MIME types to media types
1868 and the list mapping MIME types to file extensions.
1869 As an extension author, you are encouraged to submit patches to MediaWiki's
1870 core to add new MIME types to mime.types.
1871 $mimeMagic: Instance of MimeMagic.
1872 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1873 for adding new MIME info to the list.
1874 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1875 for adding new MIME types to the list.
1877 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1878 MIME type detected by considering the file extension.
1879 $mimeMagic: Instance of MimeMagic.
1880 $ext: File extension.
1881 &$mime: MIME type (in/out).
1883 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1884 $mimeMagic: Instance of MimeMagic.
1885 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1886 &$tail: More or equal than last 65558 bytes of the file in a string
1887 (in - Do not alter!).
1889 &$mime: MIME type (out).
1891 'ModifyExportQuery': Modify the query used by the exporter.
1892 $db: The database object to be queried.
1893 &$tables: Tables in the query.
1894 &$conds: Conditions in the query.
1895 &$opts: Options for the query.
1896 &$join_conds: Join conditions for the query.
1898 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1899 $oldTitle: Title object of the current (old) location
1900 $newTitle: Title object of the new location
1901 $user: User making the move
1902 $reason: string of the reason provided by the user
1903 $status: Status object to pass error messages to
1905 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1906 $oldTitle: Title object of the current (old) location
1907 $newTitle: Title object of the new location
1908 $status: Status object to pass error messages to
1910 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1911 and returning it for the skin to output. You can add items to the toolbox while
1912 still letting the skin make final decisions on skin-specific markup conventions
1914 &$sk: The BaseTemplate base skin template
1915 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1916 BaseTemplate::makeListItem for details on the format of individual items
1917 inside of this array.
1919 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1921 $index: Integer; the index of the namespace being checked.
1922 $result: Boolean; whether MediaWiki currently thinks that pages in this
1923 namespace are movable. Hooks may change this value to override the return
1924 value of MWNamespace::isMovable().
1926 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1928 $wikiPage: the WikiPage edited
1929 $rev: the new revision
1930 $baseID: the revision ID this was based off, if any
1931 $user: the editing user
1933 'NormalizeMessageKey': Called before the software gets the text of a message
1934 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1936 &$key: the message being looked up. Change this to something else to change
1937 what message gets displayed (string)
1938 &$useDB: whether or not to look up the message in the database (bool)
1939 &$langCode: the language code to get the message for (string) - or -
1940 whether to use the content language (true) or site language (false) (bool)
1941 &$transform: whether or not to expand variables and templates
1942 in the message (bool)
1944 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1945 return false to omit the line from RecentChanges and Watchlist special pages.
1946 &$changeslist: The OldChangesList instance.
1947 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1948 &$rc: The RecentChange object.
1949 &$classes: array of css classes for the <li> element
1951 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1952 can alter or append to the array of URLs for search & suggestion formats.
1953 &$urls: array of associative arrays with Url element attributes
1955 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1956 users and/or IP addresses too.
1957 $otherBlockLink: An array with links to other block logs
1958 $ip: The requested IP address or username
1960 'OutputPageBeforeHTML': A page has been processed by the parser and the
1961 resulting HTML is about to be displayed.
1962 $parserOutput: the parserOutput (object) that corresponds to the page
1963 $text: the text that will be displayed, in HTML (string)
1965 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1966 body tag to allow for extensions to add attributes to the body of the page they
1967 might need. Or to allow building extensions to add body classes that aren't of
1968 high enough demand to be included in core.
1969 $out: The OutputPage which called the hook, can be used to get the real title
1970 $sk: The Skin that called OutputPage::headElement
1971 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1973 'OutputPageCheckLastModified': when checking if the page has been modified
1974 since the last visit.
1975 &$modifiedTimes: array of timestamps.
1976 The following keys are set: page, user, epoch
1978 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1979 $out: OutputPage instance (object)
1980 $parserOutput: parserOutput instance being added in $out
1982 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1983 categories. Implementations should return false if they generate the category
1984 links, so the default link generation is skipped.
1985 $out: OutputPage instance (object)
1986 $categories: associative array, keys are category names, values are category
1987 types ("normal" or "hidden")
1988 $links: array, intended to hold the result. Must be an associative array with
1989 category types as keys and arrays of HTML links as values.
1991 'PageContentInsertComplete': After a new article is created.
1992 $wikiPage: WikiPage created
1993 $user: User creating the article
1994 $content: New content as a Content object
1995 $summary: Edit summary/comment
1996 $isMinor: Whether or not the edit was marked as minor
1997 $isWatch: (No longer used)
1998 $section: (No longer used)
1999 $flags: Flags passed to WikiPage::doEditContent()
2000 $revision: New Revision of the article
2002 'PageContentLanguage': Allows changing the language in which the content of a
2003 page is written. Defaults to the wiki content language ($wgContLang).
2004 $title: Title object
2005 &$pageLang: the page content language (either an object or a language code)
2006 $wgLang: the user language
2008 'PageContentSave': Before an article is saved.
2009 $wikiPage: the WikiPage (object) being saved
2010 $user: the user (object) saving the article
2011 $content: the new article content, as a Content object
2012 $summary: the article summary (comment)
2013 $isminor: minor flag
2014 $iswatch: watch flag
2017 'PageContentSaveComplete': After an article has been updated.
2018 $wikiPage: WikiPage modified
2019 $user: User performing the modification
2020 $content: New content, as a Content object
2021 $summary: Edit summary/comment
2022 $isMinor: Whether or not the edit was marked as minor
2023 $isWatch: (No longer used)
2024 $section: (No longer used)
2025 $flags: Flags passed to WikiPage::doEditContent()
2026 $revision: New Revision of the article (can be null for edits that change nothing)
2027 $status: Status object about to be returned by doEditContent()
2028 $baseRevId: the rev ID (or false) this edit was based on
2030 'PageHistoryBeforeList': When a history page list is about to be constructed.
2031 $article: the article that the history is loading for
2032 $context: RequestContext object
2034 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2035 $row: the revision row for this line
2036 $s: the string representing this parsed line
2037 $classes: array containing the <li> element classes
2039 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2042 $queryInfo: the query parameters
2044 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2045 which depends on user options should install this hook and append its values to
2047 &$confstr: reference to a hash key string which can be modified
2048 $user: User (object) requesting the page
2050 'ParserAfterParse': Called from Parser::parse() just after the call to
2051 Parser::internalParse() returns.
2052 $parser: parser object
2053 $text: text being parsed
2054 $stripState: stripState used (object)
2056 'ParserAfterStrip': Called at end of parsing time.
2057 TODO: No more strip, deprecated ?
2058 $parser: parser object
2059 $text: text being parsed
2060 $stripState: stripState used (object)
2062 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2063 $parser: Parser object being used
2064 $text: text that will be returned
2066 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2067 $parser: Parser object
2068 $text: text to parse
2069 $stripState: StripState instance being used
2071 'ParserBeforeStrip': Called at start of parsing time.
2072 TODO: No more strip, deprecated ?
2073 $parser: parser object
2074 $text: text being parsed
2075 $stripState: stripState used (object)
2077 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2078 $parser: Parser object being used
2081 'ParserClearState': Called at the end of Parser::clearState().
2082 $parser: Parser object being cleared
2084 'ParserCloned': Called when the parser is cloned.
2085 $parser: Newly-cloned Parser object
2087 'ParserFirstCallInit': Called when the parser initialises for the first time.
2088 &$parser: Parser object being cleared
2090 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2092 $parser: Parser object
2093 $varCache: array to store the value in case of multiples calls of the
2095 $index: index (string) of the magic
2096 $ret: value of the magic word (the hook should set it)
2097 $frame: PPFrame object to use for expanding any template variables
2099 'ParserGetVariableValueTs': Use this to change the value of the time for the
2100 {{LOCAL...}} magic word.
2101 $parser: Parser object
2102 $time: actual time (timestamp)
2104 'ParserGetVariableValueVarCache': use this to change the value of the variable
2105 cache or return false to not use it.
2106 $parser: Parser object
2107 $varCache: variable cache (array)
2109 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2110 ParserLimitReportFormat instead.
2111 Called at the end of Parser:parse() when the parser will
2112 include comments about size of the text parsed.
2113 $parser: Parser object
2114 &$limitReport: text that will be included (without comment tags)
2116 'ParserLimitReportFormat': Called for each row in the parser limit report that
2117 needs formatting. If nothing handles this hook, the default is to use "$key" to
2118 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2120 $key: Key for the limit report item (string)
2121 &$value: Value of the limit report item
2122 &$report: String onto which to append the data
2123 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2124 text intended for display in a monospaced font.
2125 $localize: If false, $report should be output in English.
2127 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2128 include comments about size of the text parsed. Hooks should use
2129 $output->setLimitReportData() to populate data. Functions for this hook should
2130 not use $wgLang; do that in ParserLimitReportFormat instead.
2131 $parser: Parser object
2132 $output: ParserOutput object
2134 'ParserMakeImageParams': Called before the parser make an image link, use this
2135 to modify the parameters of the image.
2136 $title: title object representing the file
2137 $file: file object that will be used to create the image
2138 &$params: 2-D array of parameters
2139 $parser: Parser object that called the hook
2141 'ParserSectionCreate': Called each time the parser creates a document section
2142 from wikitext. Use this to apply per-section modifications to HTML (like
2143 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2144 can begin in one section and end in another. Make sure your code can handle
2145 that case gracefully. See the EditSectionClearerLink extension for an example.
2146 $parser: the calling Parser instance
2147 $section: the section number, zero-based, but section 0 is usually empty
2148 &$sectionContent: ref to the content of the section. modify this.
2149 $showEditLinks: boolean describing whether this section has an edit link
2151 'ParserTestParser': Called when creating a new instance of Parser in
2152 tests/parser/parserTest.inc.
2153 $parser: Parser object created
2155 'ParserTestGlobals': Allows to define globals for parser tests.
2156 &$globals: Array with all the globals which should be set for parser tests.
2157 The arrays keys serve as the globals names, its values are the globals values.
2159 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2160 run. Use when page save hooks require the presence of custom tables to ensure
2161 that tests continue to run properly.
2162 &$tables: array of table names
2164 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2165 my talk page, my contributions" etc).
2166 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2167 &$title: Title object representing the current page
2168 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2170 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2171 &$user : User performing the action
2172 $action : Action being performed
2173 &$result : Whether or not the action should be prevented
2174 Change $result and return false to give a definitive answer, otherwise
2175 the built-in rate limiting checks are used, if enabled.
2176 $incrBy: Amount to increment counter by
2178 'PlaceNewSection': Override placement of new sections. Return false and put the
2179 merged text into $text to override the default behavior.
2180 $wikipage : WikiPage object
2181 $oldtext : the text of the article before editing
2182 $subject : subject of the new section
2183 &$text : text of the new section
2185 'PostLoginRedirect': Modify the post login redirect behavior.
2186 Occurs after signing up or logging in, allows for interception of redirect.
2187 &$returnTo: The page name to return to, as a string
2188 &$returnToQuery: array of url parameters, mapping parameter names to values
2189 &$type: type of login redirect as string;
2190 error: display a return to link ignoring $wgRedirectOnLogin
2191 signup: display a return to link using $wgRedirectOnLogin if needed
2192 success: display a return to link using $wgRedirectOnLogin if needed
2193 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2195 'PreferencesGetLegend': Override the text used for the <legend> of a
2196 preferences section.
2197 $form: the PreferencesForm object. This is a ContextSource as well
2198 $key: the section name
2199 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2201 'PreferencesFormPreSave': Override preferences being saved
2202 $formData: array of user submitted data
2203 $form: PreferencesForm object, also a ContextSource
2204 $user: User object with preferences to be saved set
2205 &$result: boolean indicating success
2207 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2208 AJAX search suggestions. Put results into &$results outparam and return false.
2209 $ns : array of int namespace keys to search in
2210 $search : search term (not guaranteed to be conveniently normalized)
2211 $limit : maximum number of results to return
2212 &$results : out param: array of page names (strings)
2213 $offset : number of results to offset from the beginning
2215 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2216 namespace from the search string so that extensions can attempt it.
2217 $namespaces : array of int namespace keys to search in (change this if you can
2219 $search : search term (replace this with term without the namespace if you can
2222 'PrefsEmailAudit': Called when user changes their email address.
2223 $user: User (object) changing his email address
2224 $oldaddr: old email address (string)
2225 $newaddr: new email address (string)
2227 'PrefsPasswordAudit': Called when user changes his password.
2228 $user: User (object) changing his password
2229 $newPass: new password
2230 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2232 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2234 $article: the title being (un)protected
2235 $output: a string of the form HTML so far
2237 'ProtectionForm::save': Called when a protection form is submitted.
2238 $article: the Page being (un)protected
2239 &$errorMsg: an html message string of an error or an array of message name and
2241 $reasonstr: a string describing the reason page protection level is altered
2243 'ProtectionForm::showLogExtract': Called after the protection log extract is
2245 $article: the page the form is shown for
2246 $out: OutputPage object
2248 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2249 &$obj: RawAction object
2250 &$text: The text that's going to be the output
2252 'RecentChange_save': Called at the end of RecentChange::save().
2253 $recentChange: RecentChange object
2255 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2256 names such as "oldid" that are preserved when using redirecting special pages
2257 such as Special:MyPage and Special:MyTalk.
2258 &$redirectParams: An array of parameters preserved by redirecting special pages.
2260 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2261 instance. Can be used by an extension override what skin is used in certain
2263 IContextSource $context: The RequestContext the skin is being created for.
2264 &$skin: A variable reference you may set a Skin instance or string key on to
2265 override the skin that will be used for the context.
2267 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2268 $user: The user having their password expiration reset
2269 &$newExpire: The new expiration date
2271 'ResetSessionID': Called from wfResetSessionID
2272 $oldSessionID: old session id
2273 $newSessionID: new session id
2275 'ResourceLoaderGetConfigVars': Called at the end of
2276 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2277 configuration variables to JavaScript. Things that depend on the current page
2278 or request state must be added through MakeGlobalVariablesScript instead.
2279 &$vars: array( variable name => value )
2281 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after variables
2282 from $wgResourceLoaderLESSVars are added. Can be used to add context-based variables.
2283 &$lessVars: array of variables already added
2285 'ResourceLoaderRegisterModules': Right before modules information is required,
2286 such as when responding to a resource
2287 loader request or generating HTML output.
2288 &$resourceLoader: ResourceLoader object
2290 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2291 called after the addition of 'qunit' and MediaWiki testing resources.
2292 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2293 included in core, is fed using tests/qunit/QUnitTestResources.php.
2294 &ResourceLoader object
2296 To add a new qunit module named 'myext.tests':
2297 testModules['qunit']['myext.tests'] = array(
2298 'script' => 'extension/myext/tests.js',
2299 'dependencies' => <any module dependency you might have>
2301 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2302 added to any module.
2304 'RevisionInsertComplete': Called after a revision is inserted into the database.
2305 &$revision: the Revision
2306 $data: the data stored in old_text. The meaning depends on $flags: if external
2307 is set, it's the URL of the revision text in external storage; otherwise,
2308 it's the revision text itself. In either case, if gzip is set, the revision
2310 $flags: a comma-delimited list of strings representing the options used. May
2311 include: utf8 (this will always be set for new revisions); gzip; external.
2313 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2314 the normal operations.
2315 $allSearchTerms : Array of the search terms in all content languages
2316 &$titleResult : Outparam; the value to return. A Title object or null.
2318 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2319 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2321 $term : Search term string
2322 &$title : Outparam; set to $title object and return false for a match
2324 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2325 if nothing was found.
2326 $term : Search term string
2327 &$title : Outparam; set to $title object and return false for a match
2329 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2331 $term : Search term string
2332 &$title : Current Title object that is being returned (null if none found).
2334 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2336 $title : Current Title object being displayed in search results.
2337 &$id: Revision ID (default is false, for latest)
2339 'SearchableNamespaces': An option to modify which namespaces are searchable.
2340 &$arr : Array of namespaces ($nsId => $name) which will be used.
2342 'SelfLinkBegin': Called before a link to the current article is displayed to
2343 allow the display of the link to be customized.
2344 $nt: the Title object
2345 &$html: html to display for the link
2346 &$trail: optional text to display before $html
2347 &$prefix: optional text to display after $html
2348 &$ret: the value to return if your hook returns false
2350 'SetupAfterCache': Called in Setup.php, after cache objects are set
2352 'ShowMissingArticle': Called when generating the output for a non-existent page.
2353 $article: The article object corresponding to the page
2355 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2356 DEPRECATED, use the ContentGetParserOutput hook instead!
2357 $text: Text being shown
2358 $title: Title of the custom script/stylesheet page
2359 $output: Current OutputPage object
2361 'ShowSearchHitTitle': Customise display of search hit title/link.
2362 &$title: Title to link to
2363 &$text: Text to use for the link
2364 $result: The search result
2365 $terms: The search terms entered
2366 $page: The SpecialSearch object.
2368 'ShowSearchHit': Customize display of search hit.
2369 $searchPage: The SpecialSearch instance.
2370 $result: The SearchResult to show
2371 $terms: Search terms, for highlighting
2372 &$link: HTML of link to the matching page. May be modified.
2373 &$redirect: HTML of redirect info. May be modified.
2374 &$section: HTML of matching section. May be modified.
2375 &$extract: HTML of content extract. May be modified.
2376 &$score: HTML of score. May be modified.
2377 &$size: HTML of page size. May be modified.
2378 &$date: HTML of of page modification date. May be modified.
2379 &$related: HTML of additional info for the matching page. May be modified.
2380 &$html: May be set to the full HTML that should be used to represent the search
2381 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2382 function returned false.
2384 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2385 allow the normal method of notice selection/rendering to work, or change the
2386 value of $siteNotice and return false to alter it.
2387 &$siteNotice: HTML returned as the sitenotice
2390 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2391 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2392 the sitenotice/anonnotice.
2395 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2397 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2398 the stock bottom scripts.
2400 'SkinAfterContent': Allows extensions to add text after the page content and
2401 article metadata. This hook should work in all skins. Set the &$data variable to
2402 the text you're going to add.
2403 &$data: (string) Text to be printed out directly (without parsing)
2406 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2408 &$bar: Sidebar contents
2409 Modify $bar to add or modify sidebar portlets.
2411 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2413 &$bar: Sidebar content
2414 Modify $bar to add or modify sidebar portlets.
2415 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2417 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2419 $title: displayed page title
2420 $type: 'normal' or 'history' for old/diff views
2421 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2422 message must be in HTML format, not wikitext!
2423 &$link: overridable HTML link to be passed into the message as $1
2424 &$forContent: overridable flag if copyright footer is shown in content language.
2425 This parameter is deprecated.
2427 'SkinEditSectionLinks': Modify the section edit links
2428 $skin: Skin object rendering the UI
2429 $title: Title object for the title being linked to (may not be the same as
2430 the page title, if the section is included from a template)
2431 $section: The designation of the section being pointed to, to be included in
2432 the link, like "§ion=$section"
2433 $tooltip: The default tooltip. Escape before using.
2434 By default, this is wrapped in the 'editsectionhint' message.
2435 &$result: Array containing all link detail arrays. Each link detail array should contain
2437 * targetTitle - Target Title object
2438 * text - String for the text
2439 * attribs - Array of attributes
2440 * query - Array of query parameters to add to the URL
2441 * options - Array of options for Linker::link
2442 $lang: The language code to use for the link in the wfMessage function
2444 'SkinGetPoweredBy': TODO
2445 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2446 the MediaWiki icon but plain text instead.
2449 'SkinPreloadExistence': Supply titles that should be added to link existence
2450 cache before the page is rendered.
2451 &$titles: Array of Title objects
2454 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2455 &$subpages: Subpage links HTML
2457 $out: OutputPage object
2458 If false is returned $subpages will be used instead of the HTML
2459 subPageSubtitle() generates.
2460 If true is returned, $subpages will be ignored and the rest of
2461 subPageSubtitle() will run.
2463 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2465 $sktemplate: SkinTemplate object
2466 $nav_urls: array of tabs
2468 'SkinTemplateGetLanguageLink': After building the data for a language link from
2469 which the actual html is constructed.
2470 &$languageLink: array containing data about the link. The following keys can be
2471 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2472 $languageLinkTitle: Title object belonging to the external language link.
2473 $title: Title object of the page the link belongs to.
2474 $outputPage: The OutputPage object the links are built from.
2476 To alter the structured navigation links in SkinTemplates, there are three
2477 hooks called in different spots:
2479 'SkinTemplateNavigation': Called on content pages after the tabs have been
2480 added, but before variants have been added.
2481 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2482 tab is added but before variants have been added.
2483 'SkinTemplateNavigation::Universal': Called on both content and special pages
2484 after variants have been added.
2485 &$sktemplate: SkinTemplate object
2486 &$links: Structured navigation links. This is used to alter the navigation for
2487 skins which use buildNavigationUrls such as Vector.
2489 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2491 &$sktemplate: SkinTemplate object
2492 &$tpl: QuickTemplate engine object
2494 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2495 $sktemplate: SkinTemplate object
2496 $res: set to true to prevent active tabs
2498 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2499 You can either create your own array, or alter the parameters for
2501 &$sktemplate: The SkinTemplate instance.
2502 $title: Title instance for the page.
2503 $message: Visible label of tab.
2504 $selected: Whether this is a selected tab.
2505 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2506 &$classes: Array of CSS classes to apply.
2507 &$query: Query string to add to link.
2509 &$result: Complete assoc. array if you want to return true.
2511 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2512 been rendered (useful for adding more).
2513 $sk: The QuickTemplate based skin template running the hook.
2514 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2515 extensions that add support for BaseTemplateToolbox should watch for this
2516 dummy parameter with "$dummy=false" in their code and return without echoing
2517 any HTML to avoid creating duplicate toolbox items.
2519 'SoftwareInfo': Called by Special:Version for returning information about the
2521 $software: The array of software in format 'name' => 'version'. See
2522 SpecialVersion::softwareInformation().
2524 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2525 $name: name of the special page
2526 &$form: HTMLForm object
2528 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2529 $sp: SpecialPage object, for context
2530 &$fields: Current HTMLForm fields
2532 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2533 $id: User id number, only provided for backwards-compatibility
2534 $user: User object representing user contributions are being fetched for
2535 $sp: SpecialPage instance, providing context
2537 'SpecialListusersDefaultQuery': Called right before the end of
2538 UsersPager::getDefaultQuery().
2539 $pager: The UsersPager instance
2540 $query: The query array to be returned
2542 'SpecialListusersFormatRow': Called right before the end of
2543 UsersPager::formatRow().
2544 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2545 $row: Database row object
2547 'SpecialListusersHeader': Called before closing the <fieldset> in
2548 UsersPager::getPageHeader().
2549 $pager: The UsersPager instance
2550 $out: The header HTML
2552 'SpecialListusersHeaderForm': Called before adding the submit button in
2553 UsersPager::getPageHeader().
2554 $pager: The UsersPager instance
2555 $out: The header HTML
2557 'SpecialListusersQueryInfo': Called right before the end of.
2558 UsersPager::getQueryInfo()
2559 $pager: The UsersPager instance
2560 $query: The query array to be returned
2562 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2563 $type: String of the log type
2564 $request: WebRequest object for getting the value provided by the current user
2565 &$qc: Array for query conditions to add
2567 'SpecialMovepageAfterMove': Called after moving a page.
2568 $movePage: MovePageForm object
2569 $oldTitle: old title (object)
2570 $newTitle: new title (object)
2572 'SpecialNewpagesConditions': Called when building sql query for
2574 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2575 $opts: FormOptions object containing special page options
2576 &$conds: array of WHERE conditionals for query
2577 &tables: array of tables to be queried
2578 &$fields: array of columns to select
2579 &$join_conds: join conditions for the tables
2581 'SpecialNewPagesFilters': Called after building form options at NewPages.
2582 $special: the special page object
2583 &$filters: associative array of filter definitions. The keys are the HTML
2584 name/URL parameters. Each key maps to an associative array with a 'msg'
2585 (message key) and a 'default' value.
2587 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2588 hook to remove a core special page.
2589 $list: list (array) of core special pages
2591 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2592 $special: the SpecialPage object
2593 $subPage: the subpage string or null if no subpage was specified
2595 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2596 $special: the SpecialPage object
2597 $subPage: the subpage string or null if no subpage was specified
2599 'SpecialPasswordResetOnSubmit': When executing a form submission on
2600 Special:PasswordReset.
2601 $users: array of User objects.
2602 $data: array of data submitted by the user
2603 &$error: string, error code (message key) used to describe to error (out
2604 parameter). The hook needs to return false when setting this, otherwise it
2605 will have no effect.
2607 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2608 use this to change some selection criteria or substitute a different title.
2609 &$randstr: The random number from wfRandom()
2610 &$isRedir: Boolean, whether to select a redirect or non-redirect
2611 &$namespaces: An array of namespace indexes to get the title from
2612 &$extra: An array of extra SQL statements
2613 &$title: If the hook returns false, a Title object to use instead of the
2614 result from the normal query
2616 'SpecialRecentChangesFilters': Called after building form options at
2617 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2618 $special: the special page object
2619 &$filters: associative array of filter definitions. The keys are the HTML
2620 name/URL parameters. Each key maps to an associative array with a 'msg'
2621 (message key) and a 'default' value.
2623 'SpecialRecentChangesPanel': Called when building form options in
2624 SpecialRecentChanges.
2625 &$extraOpts: array of added items, to which can be added
2626 $opts: FormOptions for this request
2628 'SpecialRecentChangesQuery': Called when building SQL query for
2629 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2630 ChangesListSpecialPageQuery instead.
2631 &$conds: array of WHERE conditionals for query
2632 &$tables: array of tables to be queried
2633 &$join_conds: join conditions for the tables
2634 $opts: FormOptions for this request
2635 &$query_options: array of options for the database request
2636 &$select: Array of columns to select
2638 'SpecialResetTokensTokens': Called when building token list for
2640 &$tokens: array of token information arrays in the format of
2641 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2643 'SpecialSearchCreateLink': Called when making the message to create a page or
2644 go to the existing page.
2645 $t: title object searched for
2646 &$params: an array of the default message name and page title (as parameter)
2648 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2649 target doesn't exist.
2650 &$title: title object generated from the text entered by the user
2652 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2653 the advanced form, a.k.a. power search box.
2654 &$showSections: an array to add values with more options to
2655 $term: the search term (not a title object)
2656 $opts: an array of hidden options (containing 'redirs' and 'profile')
2658 'SpecialSearchProfiles': Allows modification of search profiles.
2659 &$profiles: profiles, which can be modified.
2661 'SpecialSearchProfileForm': Allows modification of search profile forms.
2662 $search: special page object
2663 &$form: String: form html
2664 $profile: String: current search profile
2665 $term: String: search term
2666 $opts: Array: key => value of hidden options for inclusion in custom forms
2668 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2669 $search: SpecialSearch special page object
2670 $profile: String: current search profile
2671 $engine: the search engine
2673 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2674 on the search results page. Useful for including an external search
2675 provider. To disable the output of MediaWiki search output, return
2677 $specialSearch: SpecialSearch object ($this)
2679 $term: Search term specified by the user
2681 'SpecialSearchResults': Called before search result display
2682 $term: string of search term
2683 &$titleMatches: empty or SearchResultSet object
2684 &$textMatches: empty or SearchResultSet object
2686 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2687 &$extraStats: Array to save the new stats
2688 ( $extraStats['<name of statistic>'] => <value>; )
2690 'SpecialUploadComplete': Called after successfully uploading a file from
2692 $form: The SpecialUpload object
2694 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2695 $wgVersion: Current $wgVersion for you to use
2696 &$versionUrl: Raw url to link to (eg: release notes)
2698 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2699 Deprecated, use ChangesListSpecialPageFilters instead.
2700 $special: the special page object
2701 &$filters: associative array of filter definitions. The keys are the HTML
2702 name/URL parameters. Each key maps to an associative array with a 'msg'
2703 (message key) and a 'default' value.
2705 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2706 Deprecated, use ChangesListSpecialPageQuery instead.
2707 &$conds: array of WHERE conditionals for query
2708 &$tables: array of tables to be queried
2709 &$join_conds: join conditions for the tables
2710 &$fields: array of query fields
2711 $opts: A FormOptions object with watchlist options for the current request
2713 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2714 SpecialWatchlist. Allows extensions to register custom values they have
2715 inserted to rc_type so they can be returned as part of the watchlist.
2716 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2718 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2719 URL for a title when we have no other parameters on the URL. Gives a chance for
2720 extensions that alter page view behavior radically to abort that redirect or
2722 $request: WebRequest
2723 $title: Title of the currently found title obj
2724 $output: OutputPage object
2726 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2727 rendered (by ThumbnailImage:toHtml method).
2728 $thumbnail: the ThumbnailImage object
2729 &$attribs: image attribute array
2730 &$linkAttribs: image link attribute array
2732 'TitleArrayFromResult': Called when creating an TitleArray object from a
2734 &$titleArray: set this to an object to override the default object returned
2735 $res: database result used to create the object
2737 'TitleExists': Called when determining whether a page exists at a given title.
2738 $title: The title being tested.
2739 &$exists: Whether the title exists.
2741 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2742 or override the quick permissions check.
2743 $title: The Title object being accessed
2744 $user: The User performing the action
2745 $action: Action being performed
2746 &$errors: Array of errors
2747 $doExpensiveQueries: Whether to do expensive DB queries
2748 $short: Whether to return immediately on first error
2750 'TitleGetEditNotices': Allows extensions to add edit notices
2751 $title: The Title object for the page the edit notices are for
2752 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2753 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2755 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2756 that can be applied.
2757 $title: The title in question.
2758 &$types: The types of protection available.
2760 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2761 Called when determining if a page is a CSS or JS page.
2762 $title: Title object that is being checked
2763 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2764 Hooks may change this value to override the return value of
2765 Title::isCssOrJsPage().
2767 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2768 overriding default behavior for determining if a page exists. If $isKnown is
2769 kept as null, regular checks happen. If it's a boolean, this value is returned
2770 by the isKnown method.
2771 $title: Title object that is being checked
2772 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2774 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2775 that this hook is not called for interwiki pages or pages in immovable
2776 namespaces: for these, isMovable() always returns false.
2777 $title: Title object that is being checked
2778 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2779 Hooks may change this value to override the return value of
2782 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2783 Called when determining if a page is a wikitext or should
2784 be handled by separate handler (via ArticleViewCustom).
2785 $title: Title object that is being checked
2786 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2787 Hooks may change this value to override the return value of
2788 Title::isWikitextPage()
2790 'TitleMove': Before moving an article (title).
2793 $user: user who does the move
2795 'TitleMoveComplete': After moving an article (title).
2798 $user: user who did the move
2799 $pageid: database ID of the page that's been moved
2800 $redirid: database ID of the created redirect
2801 $reason: reason for the move
2803 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2804 adding the default error message if nothing allows the user to read the page. If
2805 a handler wants a title to *not* be whitelisted, it should also return false.
2806 $title: Title object being checked against
2807 $user: Current user object
2808 &$whitelisted: Boolean value of whether this title is whitelisted
2810 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2811 $title: Title object to purge
2812 &$urls: An array of URLs to purge from the caches, to be manipulated.
2814 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2815 PageArchive object has been created but before any further processing is done.
2816 &$archive: PageArchive object
2817 $title: Title object of the page that we're viewing
2819 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2820 PageArchive object has been created but before any further processing is done.
2821 &$archive: PageArchive object
2822 $title: Title object of the page that we're viewing
2824 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2825 the site is not in read-only mode, that the Title object is not null and after
2826 a PageArchive object has been constructed but before performing any further
2828 &$archive: PageArchive object
2829 $title: Title object of the page that we're about to undelete
2831 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2832 $title: title object related to the revision
2833 $rev: revision (object) that will be viewed
2835 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2837 $action: action name
2838 $article: article "acted on"
2840 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2841 Since 1.24: Paths pointing to a directory will be recursively scanned for
2842 test case files matching the suffix "Test.php".
2843 &$paths: list of test cases and directories to search.
2845 'UnwatchArticle': Before a watch is removed from an article.
2846 $user: user watching
2847 $page: WikiPage object to be removed
2848 &$status: Status object to be returned if the hook returns false
2850 'UnwatchArticleComplete': After a watch is removed from an article.
2851 $user: user that watched
2852 $page: WikiPage object that was watched
2854 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2855 $formattedPageStatus: list of valid page states
2857 'UploadForm:initial': Before the upload form is generated. You might set the
2858 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2859 text (HTML) either before or after the editform.
2860 $form: UploadForm object
2862 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2863 poke at member variables like $mUploadDescription before the file is saved. Do
2864 not use this hook to break upload processing. This will return the user to a
2865 blank form with no error message; use UploadVerification and UploadVerifyFile
2867 $form: UploadForm object
2869 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2870 $type: (string) the requested upload type
2871 &$className: the class name of the Upload instance to be created
2873 'UploadComplete': when Upload completes an upload.
2874 &$upload: an UploadBase child instance
2876 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2878 $descriptor: (array) the HTMLForm descriptor
2880 'UploadFormSourceDescriptors': after the standard source inputs have been
2881 added to the descriptor
2882 $descriptor: (array) the HTMLForm descriptor
2884 'UploadVerification': Additional chances to reject an uploaded file. Consider
2885 using UploadVerifyFile instead.
2886 string $saveName: destination file name
2887 string $tempName: filesystem path to the temporary file for checks
2888 string &$error: output: message key for message to show if upload canceled by
2889 returning false. May also be an array, where the first element is the message
2890 key and the remaining elements are used as parameters to the message.
2892 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2893 in most cases over UploadVerification.
2894 object $upload: an instance of UploadBase, with all info about the upload
2895 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2896 will typically only apply for specific MIME types.
2897 object &$error: output: true if the file is valid. Otherwise, an indexed array
2898 representing the problem with the file, where the first element is the message
2899 key and the remaining elements are used as parameters to the message.
2901 'UploadComplete': Upon completion of a file upload.
2902 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2903 $uploadBase->getLocalFile().
2905 'User::mailPasswordInternal': before creation and mailing of a user's new
2907 $user: the user who sent the message out
2908 $ip: IP of the user who sent the message out
2909 $u: the account whose new password will be set
2911 'UserAddGroup': Called when adding a group; return false to override
2912 stock group addition.
2913 $user: the user object that is to have a group added
2914 &$group: the group to add, can be modified
2916 'UserArrayFromResult': Called when creating an UserArray object from a database
2918 &$userArray: set this to an object to override the default object returned
2919 $res: database result used to create the object
2921 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2922 want to display an error message, try getUserPermissionsErrors.
2923 $title: Title object being checked against
2924 $user : Current user object
2925 $action: Action being checked
2926 $result: Pointer to result returned if hook returns false. If null is returned,
2927 userCan checks are continued by internal code.
2929 'UserCanSendEmail': To override User::canSendEmail() permission check.
2930 $user: User (object) whose permission is being checked
2931 &$canSend: bool set on input, can override on output
2933 'UserClearNewTalkNotification': Called when clearing the "You have new
2934 messages!" message, return false to not delete it.
2935 $user: User (object) that will clear the message
2936 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2938 'UserCreateForm': change to manipulate the login form
2939 $template: SimpleTemplate instance for the form
2941 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2942 $user: User to get groups for
2943 &$groups: Current effective groups
2945 'UserGetAllRights': After calculating a list of all available rights.
2946 &$rights: Array of rights, which may be added to.
2948 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2949 before returning the options to the caller. Warning: This hook is called for
2950 every call to User::getDefaultOptions(), which means it's potentially called
2951 dozens or hundreds of times. You may want to cache the results of non-trivial
2952 operations in your hook function for this reason.
2953 &$defaultOptions: Array of preference keys and their default values.
2955 'UserGetEmail': Called when getting an user email address.
2957 &$email: email, change this to override local email
2959 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2960 email authentication.
2962 &$timestamp: timestamp, change this to override local email authentication
2965 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
2966 &$groups: List of implicit (automatically-assigned) groups
2968 'UserGetLanguageObject': Called when getting user's interface language object.
2970 &$code: Language code that will be used to create the object
2971 $context: IContextSource object
2973 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2974 &$reservedUsernames: $wgReservedUsernames
2976 'UserGetRights': Called in User::getRights().
2977 $user: User to get rights for
2978 &$rights: Current rights
2980 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2981 specific block exemptions).
2982 $user: User in question
2983 $title: Title of the page in question
2984 &$blocked: Out-param, whether or not the user is blocked from that page.
2985 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2986 to edit their own user talk pages.
2988 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2990 $ip: User's IP address
2991 &$blocked: Whether the user is blocked, to be modified by the hook
2993 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2994 false if a UserGetRights hook might remove the named right.
2995 $right: The user right being checked
2997 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2998 environmental means; occurs after session is loaded.
2999 $user: user object being loaded
3001 'UserLoadDefaults': Called when loading a default user.
3005 'UserLoadFromDatabase': Called when loading a user from the database.
3007 &$s: database query object
3009 'UserLoadFromSession': Called to authenticate users on external/environmental
3010 means; occurs before session is loaded.
3011 $user: user object being loaded
3012 &$result: set this to a boolean value to abort the normal authentication
3015 'UserLoadOptions': When user options/preferences are being loaded from the
3018 &$options: Options, can be modified.
3020 'UserLoginComplete': After a user has logged in.
3021 $user: the user object that was created on login
3022 $inject_html: Any HTML to inject after the "logged in" message.
3024 'UserLoginForm': change to manipulate the login form
3025 $template: SimpleTemplate instance for the form
3027 'UserLogout': Before a user logs out.
3028 $user: the user object that is about to be logged out
3030 'UserLogoutComplete': After a user has logged out.
3031 $user: the user object _after_ logout (won't have name, ID, etc.)
3032 $inject_html: Any HTML to inject after the "logged out" message.
3033 $oldName: name of the user before logout (string)
3035 'UserRemoveGroup': Called when removing a group; return false to override stock
3037 $user: the user object that is to have a group removed
3038 &$group: the group to be removed, can be modified
3040 'UserRights': After a user's group memberships are changed.
3041 $user : User object that was changed
3042 $add : Array of strings corresponding to groups added
3043 $remove: Array of strings corresponding to groups removed
3045 'UserRequiresHTTPS': Called to determine whether a user needs
3046 to be switched to HTTPS.
3047 $user: User in question.
3048 &$https: Boolean whether $user should be switched to HTTPS.
3050 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3051 have been requested to be reset. This hook can be used to exclude certain
3052 options from being reset even when the user has requested all prefs to be reset,
3053 because certain options might be stored in the user_properties database table
3054 despite not being visible and editable via Special:Preferences.
3055 $user: the User (object) whose preferences are being reset
3056 &$newOptions: array of new (site default) preferences
3057 $options: array of the user's old preferences
3058 $resetKinds: array containing the kinds of preferences to reset
3060 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3062 $user: user retrieving new talks messages
3063 $talks: array of new talks page(s)
3065 'UserSaveSettings': Called when saving user settings.
3068 'UserSaveOptions': Called just before saving user preferences/options.
3070 &$options: Options, modifiable
3072 'UserSetCookies': Called when setting user cookies.
3074 &$session: session array, will be added to $_SESSION
3075 &$cookies: cookies array mapping cookie name to its value
3077 'UserSetEmail': Called when changing user email address.
3079 &$email: new email, change this to override new email address
3081 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3082 email authentication.
3084 &$timestamp: new timestamp, change this to override local email
3085 authentication timestamp
3087 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3088 "Foobar (Talk | Contribs | Block)".
3089 $userId: User id of the current user
3090 $userText: User name of the current user
3091 &$items: Array of user tool links as HTML fragments
3093 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3094 FormatMetadata::getExtendedMeta (return false means cache will be
3095 invalidated and GetExtendedMetadata hook called again).
3096 $timestamp: The timestamp metadata was generated
3097 $file: The file the metadata is for
3099 'UserMailerChangeReturnPath': Called to generate a VERP return address
3100 when UserMailer sends an email, with a bounce handling extension.
3101 $to: Array of MailAddress objects for the recipients
3102 &$returnPath: The return address string
3104 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3105 messages. Allows to add additional error messages (except messages already in
3106 LoginForm::$validErrorMessages).
3107 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3109 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3110 used to alter the SQL query which gets the list of wanted pages.
3111 &$wantedPages: WantedPagesPage object
3112 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3114 'WatchArticle': Before a watch is added to an article.
3115 $user: user that will watch
3116 $page: WikiPage object to be watched
3117 &$status: Status object to be returned if the hook returns false
3119 'WatchArticleComplete': After a watch is added to an article.
3120 $user: user that watched
3121 $page: WikiPage object watched
3123 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3124 form, used to manipulate the list of pages or preload data based on that list.
3125 &$watchlistInfo: array of watchlisted pages in
3126 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3128 'WatchlistEditorBuildRemoveLine': when building remove lines in
3129 Special:Watchlist/edit.
3130 &$tools: array of extra links
3131 $title: Title object
3132 $redirect: whether the page is a redirect
3134 &$link: HTML link to title
3136 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3138 $router: The PathRouter instance
3140 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3141 Return false to prevent setting of the cookie.
3142 &$name: Cookie name passed to WebResponse::setcookie()
3143 &$value: Cookie value passed to WebResponse::setcookie()
3144 &$expire: Cookie expiration, as for PHP's setcookie()
3145 $options: Options passed to WebResponse::setcookie()
3147 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3148 $row: The DB row of the entry.
3149 $title: The Title of the page where the link comes FROM
3150 $target: The Title of the page where the link goes TO
3151 &$props: Array of HTML strings to display after the title.
3153 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3154 dumps. One, and only one hook should set this, and return false.
3155 &$tables: Database tables to use in the SELECT query
3156 &$opts: Options to use for the query
3157 &$join: Join conditions
3159 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3160 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3161 specific to a content model should be provided by the respective Content's
3162 getDeletionUpdates() method.
3164 $content: the Content to generate updates for
3165 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3167 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3168 run a MediaWiki cli script.
3169 &$script: MediaWiki cli script path
3170 &$parameters: Array of arguments and options to the script
3171 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3174 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3175 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3176 $qp: The list of QueryPages
3178 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3179 extra metadata to be added.
3180 $obj: The XmlDumpWriter object.
3181 &$out: The output string.
3182 $row: The database row for the page.
3183 $title: The title of the page.
3185 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3187 $obj: The XmlDumpWriter object.
3188 &$out: The text being output.
3189 $row: The database row for the revision.
3190 $text: The revision text.
3192 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3193 to add additional tags to extract.
3194 &$items: Array containing information on which items to extract. See XMPInfo for
3195 details on the format.
3197 'XMPGetResults': Called just before returning the results array of parsing xmp
3198 data. Can be used to post-process the results.
3199 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3200 is an array of metadata tags returned (each tag is either a value, or an array
3203 More hooks might be available but undocumented, you can execute
3204 "php maintenance/findHooks.php" to find hidden ones.