Extension:SignupAPI

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

Release status: experimental

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

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; code metrics

Phabricator:

Open tasks · Report a bug

What can this extension do?[edit | edit source]

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[edit | edit source]

To install this extension, copy the entire SignupAPI directory to your extensions directory

Add the following to LocalSettings.php:

$IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holds LocalSettings.php, index.php etc..
$wgUseAjax = true; 
$wgSignupAPIUseAjax = true;
$wgSignupAPISourceTracking = true;
$wgUseCombinedLoginLink = false;
require_once("$IP/extensions/SignupAPI/SignupAPI.php");

Finally, take a backup of your existing database & run update.php to create the sourcetracking table.

Configuration parameters[edit | edit source]

$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 paramaters 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[edit | edit source]

SignupAPI-Extension.png

See also[edit | edit source]