Extension:SignupAPI

MediaWiki extensions manual

SignupAPI Release status: unstable
Implementation	User activity, Ajax, Special page, API, Hook, Database
Description	It creates a special page that cleans up SpecialUserLogin from signup related stuff, adds an API for signup, adds sourcetracking for account creation & AJAX-ifies the signup form
Author(s)	(Akshay.agarwaltalk)
Latest version	1.0
MediaWiki	1.19
PHP	5.0
Database changes	Yes
License	GPL
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history Note: no localisation updates provided by translatewiki.net.
Parameters $wgSignupAPIUseAjax, $wgSignupAPISourceCreation
Hooks used LoadExtensionSchemaUpdates SignupForm
Translate the SignupAPI extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

What can this extension do?

It creates a special page that cleans up SpecialUserLogin from signup related stuff, adds an API for signup, adds sourcetracking for account creation & AJAX-ifies the signup form.

Installation

• Download and place the file(s) in a directory called SignupAPI in your extensions/ folder.

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

  require_once "$IP/extensions/SignupAPI/SignupAPI.php";
  $wgUseAjax = true; 
  $wgSignupAPIUseAjax = true;
  $wgSignupAPISourceTracking = true;
  $wgUseCombinedLoginLink = false;
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

$wgUseAjax

This parameter is required to use AJAX & is set to true by default in MediaWiki 1.17 & above

$wgSignupAPIUseAjax

If set to true, the extension will AJAX-ify the signup form & facilitate the validation of username, password, retype & email dynamically before submitting the form

$wgSignupAPISourceCreation

If set to true, the extension will add the source tracking parameters to the "Create account" link & on successful signup will store them inside the sourcetracking table

$wgUseCombinedLoginLink

This parameter is used to display separate links for Login & Create account instead of the combined "Login/Create account" link.

Screenshot

See also

• Requests for comment/Account_creation
• Extension:E3Experiments improves the signup form "account creation user experience", also using AJAX validation.
• Gerrit change 18127 adds an account creation API to MediaWiki core