Extension:CustomUserSignup

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

Release status: stable

Description Modify user interface messages relevant to the login/sign-up flow through a campaign identifier
Author(s) Nimish Gautam
License GPLv2
Download Download snapshot
Subversion [Help]

Browse source code
View code changes

README

Hooks used
UserCreateForm

UserLoginForm
BeforeWelcomeCreation
BeforePageDisplay
AddNewAccount

Check usage (experimental)

Contents

[edit] Purpose

This extension lets you customize the messages seen in the user login process based on passing a "campaign" variable in to the Special:UserLogin page. This campaign variable sticks with the user throughout the account creation process, and changes the messages the user sees throughout the process. Because user messages can be edited from the MediaWiki namespace, this effectively allows administrators of a wiki to customize the new account creation process.

The messages that can be overridden are the ones found in includes/templates/Userlogin.php, overridden by a message of the format

customusertemplate-{campaign}-{message}

[edit] Installation

To install this extension, add the following to LocalSettings.php:

require_once("$IP/extensions/CustomUserSignup/CustomUserSignup.php");

[edit] Example

The text at the end of the signup page is generated by a message called 'signupend'.

If you wanted users in the "foo" campaign to see something different, you would append &campaign=foo to the Special:UserLogin URL.

Now, you would edit MediaWiki:customusertemplate-foo-signupend to say whatever you'd like, and this message will only be shown to user in campaign "foo".


[edit] ClickTracking Dependency

Using the ClickTracking extension and its bucketing capabilities, one can set up buckets and add campaigns to test how different account creation flows perform, depending on the goals of the account creation. This is the goal of the Account Creation Improvement Project but can also be useful to customize the login/account creation flow for specific outreach initiatives, e.g. a workshop or e-mail invitation.


Personal tools
Namespaces

Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox