Extension:NewUserMessage

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
NewUserMessage

Release status: stable

Implementation User activity, Hook
Description Add a message to newly created user's talk pages
Author(s) Nad, Siebrand
Latest version 3.5.0 (2014-03-28)
MediaWiki 1.19+
PHP 5.3+
Database changes No
License GPL-2.0+
Download
Parameters
  • $wgNewUserSuppressRC
  • $wgNewUserMinorEdit
  • $wgNewUserMessageOnAutoCreate
Hooks used
AddNewAccount

AuthPluginAutoCreate
UserGetReservedNames

Translate the NewUserMessage extension if it is available at translatewiki.net

Check usage and version matrix; code metrics
Bugs: list open list all report

The NewUserMessage extension adds a message to the talk pages of newly created wiki accounts.

Usually after a new user registers on a wiki powered by MediaWiki, the message in MediaWiki:Welcomecreation is displayed. This extensions allows a message in a specified template to be added into the new users talk page instead.

In case LiquidThreads is installed, this extension will create a new thread on the user talk page. See In-wiki configuration for details.

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called NewUserMessage in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/NewUserMessage/NewUserMessage.php";
  • Configure as required
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration[edit | edit source]

Global variables[edit | edit source]

There are some global variables which affect the operation of the extension. These should be set in your LocalSettings file after the require_once of the NewUserMessage.php script.

Variable Default value Meaning
$wgNewUserSuppressRC false Specify whether or not the new user message creation should show up in recent changes. If set to true, those edits won't be displayed even if "show bot edits" is selected on RecentChanges or Watchlist.
$wgNewUserMinorEdit true Should the new user message creation be a minor edit?
$wgNewUserMessageOnAutoCreate false Should auto creation (CentralAuth) trigger a new user message?

In-wiki configuration[edit | edit source]

Other settings of the extension can be made in the MediaWiki: namespace.

Article title Default value Meaning
MediaWiki:Newusermessage-template Template:Welcome Specify a template to wrap the new user message within. You can create translations (e.g. MediaWiki:Newusermessage-template/es) that will be used when the registered user has set a different interface language on registration (this is possible through &uselang parameter or more easily through login language links).
MediaWiki:Newusermessage-template-subject Template:Welcome-subject Specify a template to wrap the new user message thread subject within. Only used when LiquidThreads is installed and active on user talk pages. Always preprocessed and substituted by the parser.
MediaWiki:Newusermessage-template-body Template:Welcome-body Specify a template to wrap the new user message thread body within. Only used when LiquidThreads is installed and active on user talk pages.
MediaWiki:Newuseredit-summary Adding [[welcome message]] to new user's talk page Edit summary for the recent changes entry of a new users message. Always in content language.
MediaWiki:Newusermessage-editor New user message Set the username of the user that makes the edit on user talk pages. If this user does not exist, "MediaWiki default" will show up as editing user. The user set here is marked as reserved and won't be able to login!
MediaWiki:Newusermessage-signatures None Optional feature. if it exists and contains a list of user names (* signature newline * etc...), these user names will be added after the template (randomly) along with the date and time. This feature is inactive when LiquidThreads is installed and new user messages are posted as threads.
MediaWiki:Newusermessage-substitute‎ None Optional feature. If the page exists and contains any text (but spaces or a single dash ("-")), the welcome template will be substituted in the talk page.

Note that these items are articles, to edit them go to the article in your browser and edit the text accordingly.

Example NewUserMessage page[edit | edit source]

A very simple example of the page you should create as Template:Welcome:

== Hello {{{name}}} ==
Welcome to our Wiki

Possible template parameters[edit | edit source]

  • {{{name}}}: User name
  • {{{realName}}}: Real name (can be empty)

Example NewUserMessage pages with LiquidThreads[edit | edit source]

Subject[edit | edit source]

A very simple example of the page you should create as Template:Welcome-subject:

Hello {{{name}}}

This message will be used as the thread subject - preprocessed and substituted. If this page is empty, this extension will not do anything when LiquidThreads is installed.

Template parameter
name: User name (user real name if used at registration)

Body[edit | edit source]

A very simple example of the page you should create as Template:Welcome-body:

Welcome to our Wiki, {{{realName|{{{name}}}}}}

This message will be used as the thread body. It will be substituted if MediaWiki:Newusermessage-substitute‎ has contents. If this page is empty, this extension will not do anything when LiquidThreads is installed.

Template parameters
name: User name
realName: User real name

Hooks[edit | edit source]

This extension adds one new hook: