Extension:InviteSignup

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg InviteSignup Release status: stable
File:InviteSignup.png
Implementation	User identity , Special page
Description	Allows to invite users to signup to a closed wiki
Author(s)	Niklas Laxström (Nikerabbittalk)
Latest version	1.0.0+2021-09-01
MediaWiki	>= 1.39.0
Database changes	Yes
Composer	mediawiki/invite-signup
Tables	invitesignup
License	GNU General Public License 2.0 or later
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate>
Parameters $wgInviteSignupHash $wgISGroups
Added rights invitesignup
Hooks used AddNewAccount BeforeInitialize LoadExtensionSchemaUpdates UserCreateForm UserGetRights
Quarterly downloads
Public wikis using
Translate the InviteSignup extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The InviteSignup extensions allows account creation to be offered to a user on a closed wiki where it's restricted.

The extension adds a "Special:InviteSignup" special page, available to users with invitesignup permission.

• The inviter, from this page, by entering just an e-mail address, can quickly invite a single person to create an account on the wiki.
• The person can then set a username and password, confirming the creation of the account, which is logged; until then, no account is created.
• The inviter can optionally set additional user groups to which the account will be added automatically after creation.

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/InviteSignup</tvar>|Download]] and move the extracted <tvar name=name>InviteSignup</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/InviteSignup
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'InviteSignup' );
  

• <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
• You will need to give the invitesignup permission to at least one user group. To have administrators be able to do the inviting, for instance, add the following to LocalSettings.php:

$wgGroupPermissions['sysop']['invitesignup'] = true;

• You can also set the variable $wgISGroups to an array of user groups. When inviting, you can mark to which groups the invited user will be added automatically. For example, with the following setting, you are able to invite 1) normal users 2) translators 3) sysops.

$wgISGroups = [ 'translator', 'sysop' ];

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

See also

• Extension:ConfirmAccount – where the account is requested by the user rather than offered.
• m:Help:Logging in#Creating an account – Special:CreateAccount allows creation by e-mail, but requires a username to be set because creation is immediate.