Manual:Logging to Special:Log

• Deutsch
• English
• dansk
• español
• français
• polski
• português
• português do Brasil
• čeština
• русский
• 日本語

Example

In your extension setup file

{
"LogTypes":["foo"],
"LogNames":{
"foo":"foo-name"
},
"LogHeaders":{
"foo":"foo-header"
},
"LogActionsHandlers":{
"foo/*":"LogFormatter"
}
}

In i18n/en.json file

{
"log-name-foo":"Foo log",
"log-description-foo":"These events track when Foo events happen in the system.",
"logentry-foo-bar":"1ドル {{GENDER:2ドル|did bar}} to page 3ドル"
}

{
"log-name-foo":"The Special:Log log name that appears in the drop-down on the Special:Log page",
"log-description-foo":"The Special:Log description that appears on the Special:Log page when you filter logs on this specific log name",
"logentry-foo-bar":"The template of the log entry message"
}

In the extension code

// Anywhere in your code where you want to generate a log entry
$logEntry = new ManualLogEntry( 'foo', 'bar' ); // Log action 'bar' in the Special:Log for 'foo'
$logEntry->setPerformer( $user ); // User object, the user who performed this action
$logEntry->setTarget( $this ); // The page that this log entry affects, a Title object
$logEntry->setComment( $reason ); // Optional, user provided comment
// Optionally, add additional parameters for use in the log entry’s i18n message.
// Numbering should start from 4 and can be used in the message as 4,ドル 5ドル and so on.
//
// Indexes 1,ドル 2,ドル and 3ドル are reserved and provide the username and target page parameters for the messages.
// 1ドル is a reference to the user page and user talk page in the wiki
// 2ドル is used to determine the gender of the user for any gender specific messages
// 3ドル is a reference to the page on which the action took place
//
// If you want to store stuff that should not be available in messages, don’t prefix the array key with a number and don’t use the colons.
// 
// The format is index:formatspecifier:name.
// Format specifier is currently unused, but in future you could say for example
// that this param is a number, format it according to the user language.
// Name is just for giving identifier for the value, and helps to debug issues
// versus unindexed list of parameters.
$logEntry->setParameters( [
	'4::paramname' => 'customparam',
	'hiddenparam' => 'ugly stuff',
] );
// We're not done yet, we need to insert the log entry into the database.
// Insert adds it to the logging table and returns the id of that log entry.
$logid = $logEntry->insert();
// Optionally, publish the log entry in recent changes and the UDP feed of recent changes
// if we want. UDP feed is mainly used for echoing the recent change items into IRC.
// publish() takes second param with values 'rcandudp' (default), 'rc' and 'udp'.
$logEntry->publish( $logid );

Adding links

See also