Extension:CustomLogs

MediaWiki extensions manual

CustomLogs Release status: stable
Description	Allows the user to add custom log types by editing LocalSettings.php and the MediaWiki namespace
Author(s)	Megan Cutrofello (RheingoldRivertalk)
Latest version	1.1.1 (2023-04-21)
MediaWiki	1.25+
Database changes	No
Parameters $wgCustomLogsLogs $wgCustomLogsMaxCustomParams
Added rights writecustomlogs
Licence	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL commit history Note: No localisation updates are provided by translatewiki.net . readme

Installation

• Download and move the extracted CustomLogs folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CustomLogs
  

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'CustomLogs' );
  

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

$wgCustomLogsLogs - A list of the log types to add to the wiki. For example:

$wgCustomLogsLogs = ["ro-news","ro-tournament"]

$wgCustomLogsMaxCustomParams - The maximum number of custom params you will be allowed to specify when writing a custom log. Default is 3.

Writing logs

This is governed by the user right writecustomlogs. By default all logged-in users have this right, but you can configure it like any user right. The API action is customlogswrite. Parameters include:

• logtype - the type of log, as specified in wgCustomLogsLogs
• title - the title of the page associated with the action (cannot be used with pageid)
• pageid - the pageid of the page associated with the action (cannot be used with title)
• summary - a text summary, which may have custom parameters substituted into it. Custom parameters are sent to the summary in order beginning with $4. See the readme on GitHub for additional documentation. If blank, the default summary for the log will be used.
• tags - a list of tags (these must actually exist on the wiki)
• publish - whether or not to publish in recent changes
• custom1 - etc as many as specified by $wgCustomLogsLogs