Jump to content

Extension:InviteSignup: Difference between revisions

From mediawiki.org
Content deleted Content added
Marked this version for translation
 
(39 intermediate revisions by 18 users not shown)
Line 1: Line 1:
<languages/>
{{Extension
{{Extension
|name = InviteSignup
|name = InviteSignup
Line 4: Line 5:
|username = Nikerabbit
|username = Nikerabbit
|author = Niklas Laxström
|author = Niklas Laxström
|description = Allows to invite users to signup to a closed wiki
|description = <translate><!--T:1--> Allows to invite users to signup to a closed wiki</translate>
|version = 2012-12-26
|image = InviteSignup.png
|update =
|version =
|mediawiki =
|mediawiki =
|download = {{WikimediaDownload}}
|needs-updatephp = no
|php = 5.3+
|composer = mediawiki/invite-signup
|license = GPL
|download = {{WikimediaDownload|server=gerrit}}
|needs-updatephp = no
|parameters = $wgInviteSignupHash
|example =
|example =
|type1 = user identity
|type1 = user identity
|type2 = special
|type2 = special
|phabricator = MediaWiki-extensions-InviteSignup
|hook1 = BeforeInitialize
|table1 = invitesignup
|hook2 = UserGetRights
|hook3 = UserCreateForm
|hook4 = AddNewAccount
}}
}}
<translate>
The '''InviteSignup''' extensions allows account creation to be offered to a user on a closed wiki where it's restricted.
<!--T:2-->
The <tvar name=1>'''InviteSignup'''</tvar> extensions allows account creation to be offered to a user on a closed wiki where it's restricted.


<!--T:3-->
The extension adds a Special:InviteSignup special page, available to users with <code>invitesignup</code> permission.
The extension adds a "Special:InviteSignup" special page, available to users with <tvar name=1><code>invitesignup</code></tvar> 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.
</translate>
* 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.


* <translate><!--T:4--> 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.</translate>
== Download ==
* <translate><!--T:5--> The person can then set a username and password, confirming the creation of the account, which is logged; until then, no account is created.</translate>
{{ExtensionGitDownload}}
* <translate><!--T:6--> The inviter can optionally set additional user groups to which the account will be added automatically after creation.</translate>


<translate>
==Installation==
==Installation== <!--T:7-->
{{ExtensionInstall}}
</translate>
* You will also have to create a new variable <code>$wgISGroups</code> containing an array of groups where the user can be setup:
{{ExtensionInstall
<syntaxhighlight lang="php">$wgISGroups = array( 'user' );</syntaxhighlight>
|repo-name=InviteSignup
|registration=required
|db-update=Yes
|custom-steps=
* <translate><!--T:11--> You will need to give the <tvar name=1><code>invitesignup</code></tvar> permission to at least one user group.</translate> To have administrators be able to do the inviting, for instance, add the following to LocalSettings.php:
: <syntaxhighlight lang="php">
$wgGroupPermissions['sysop']['invitesignup'] = true;
</syntaxhighlight>
* <translate><!--T:12--> You can also set the variable <tvar name=1><code>$wgISGroups</code></tvar> to an array of user groups.</translate> <translate><!--T:13--> When inviting, you can mark to which groups the invited user will be added automatically.</translate> <translate><!--T:14--> For example, with the following setting, you are able to invite 1) normal users 2) translators 3) sysops.</translate>
: <syntaxhighlight lang="php">$wgISGroups = [ 'translator', 'sysop' ];</syntaxhighlight>
}}

<translate>
== See also == <!--T:8-->
</translate>
* {{ll|Extension:ConfirmAccount}} <translate><!--T:9--> where the account is requested by the user rather than offered.</translate>
* {{ll|Help:Logging in#Creating an account}}<translate><!--T:10--> <tvar name=1>[[Special:CreateAccount]]</tvar> allows creation by e-mail, but requires a username to be set because creation is immediate.</translate>
* {{ll|Extension:UserVerification}} - <translate><!--T:15--> Manages signups by enforcing email authentication to edit the wiki plus other methods</translate>


{{Used by}}
== 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.
* Some other extensions focus on mass account creation, for instance [[Extension:Education Program]] among several.

Latest revision as of 11:56, 1 June 2025

MediaWiki extensions manual
InviteSignup
Release status: stable
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.46.0
Database changes Yes
Composer mediawiki/invite-signup
  • $wgInviteSignupHash
  • $wgISGroups
  • invitesignup
Licence GNU General Public License 2.0 or later
Download
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

[edit | edit source]
  • Download and move the extracted InviteSignup 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/InviteSignup
    
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'InviteSignup' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • 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' ];
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also

[edit | edit source]