Extension:SignupAPI

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear app error.png
SignupAPI

Release status:Extension status unstable

ImplementationTemplate:Extension#type User activity, Ajax, Special page, API, Hook, Database
DescriptionTemplate:Extension#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)Template:Extension#username (Akshay.agarwaltalk)
Latest versionTemplate:Extension#version 1.0
MediaWikiTemplate:Extension#mediawiki 1.19
PHPTemplate:Extension#php 5.0
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license GPL
Download

Note: no localisation updates provided by translatewiki.net.

ParametersTemplate:Extension#parameters

$wgSignupAPIUseAjax, $wgSignupAPISourceCreation

Hooks usedTemplate:Extension#hook
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
SignupForm

Translate the SignupAPI extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

What can this extension do?[edit]

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]

  • 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.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

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

SignupAPI-Extension.png

See also[edit]