Extension:NewUserMessage
|
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.23+ | ||
| PHP | 5.3+ | ||
| Database changes | No | ||
| License | GNU General Public License 2.0 or later | ||
| Download | |||
|
|||
|
|||
|
|||
|
Translate the NewUserMessage extension if it is available at translatewiki.net |
|||
| Check usage and version matrix. | |||
| Open tasks · Report a bug | |||
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.
Contents
Installation[edit]
- Download and place the file(s) in a directory called
NewUserMessagein yourextensions/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]
Global variables[edit]
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]
Other settings of the extension can be made in the MediaWiki: namespace.
| Page 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]
A very simple example of the page you should create as Template:Welcome:
== Welcome to our Wiki ==
Hello {{{name}}} ...
- Template parameters
- {{{name}}}: User name
- {{{realName}}}: Real name (can be empty)
Example NewUserMessage pages with LiquidThreads[edit]
Subject[edit]
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]
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.
Note: Please note that the {{{realName|{{{name}}}}}} syntax currently does not work. As a workaround {{#if: {{{realName|}}} | {{{realName}}} | {{{name}}} }} may be used if the ParserFunctions extension is available.
- Template parameters
- name: User name
- realName: User real name
Hooks[edit]
This extension adds one new hook:
| This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
- GPL licensed extensions
- Stable extensions
- Extensions without an image
- User activity extensions
- Hook extensions
- Extensions in Wikimedia version control
- AddNewAccount extensions
- AuthPluginAutoCreate extensions
- UserGetReservedNames extensions
- LocalUserCreated extensions
- All extensions
- Extensions used on Wikimedia