Manual:Hooks/SetupUserMessageArticle

From MediaWiki.org
Jump to navigation Jump to search
SetupUserMessageArticle
Available from version 1.17.0
Removed in version 1.18.0
Called in User::leaveUserMessage() before anything has been posted to the article.
Define function:
public static function onSetupUserMessageArticle( $user, &$article, $subject, $text, $signature, $summary, $editor ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"SetupUserMessageArticle": "MyExtensionHooks::onSetupUserMessageArticle"
	}
}

For MediaWiki ≤1.25:

$wgHooks['SetupUserMessageArticle'][] = 'MyExtensionHooks::onSetupUserMessageArticle';
Called from:File(s): User.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:SetupUserMessageArticle extensions.

Details[edit]

  • $user: The user who we left the message for.
  • &$article: The article that will be posted to.
  • $subject: The subject of the message
  • $text: The text of the message.
  • $signature: The signature we used.
  • $summary: The edit summary.
  • $editor: The editor that performed the edit.