Login.ConfirmRegister

\\

{toc}

h2. What is ConfirmRegister?

ConfirmRegister is a simple snippet that confirms a registration by a User from the [Register|Login.Register] snippet, when 'activation' in that snippet is set to 1 (the default). It is placed on a separate, "Registration Activated" page.

h2. Usage

[Register|Login.Register] by default requires the User to activate their account before logging in. The Snippet creates the modUser object and sets its "active" field to 0. The User then gets an email with a URL to activate their account with. Once the User visits the page, their account is set to "active=1", and they can then login.

To enable this, you will need to create an Activation page by creating a new Resource, and putting this [ConfirmRegister|Login.ConfirmRegister] snippet inside of it:

{code}
[[!ConfirmRegister]]
{code}

An example [Register|Login.Register] snippet call with activation would look like this:

{code}
[[!Register?
&activationEmailTpl=`myActivationEmailTpl`
&activationEmailSubject=`Please activate your account!`
&activationResourceId=`26`
]]
{code}

ConfirmRegister also fires the [OnUserActivate|revolution20:OnUserActivate] plugin event after the User is activated, and passes in a 'user' parameter, which contains the newly-activated modUser object.

h2. See Also

{pagetree:root=Login}

{scrollbar}