User Registration Add-On

Revision as of 16:15, 17 February 2011

The Gravity Forms User Registration Add-On integrates with any Gravity form to allow you to register users on your website. If you are familiar with the MailChimp, Campaign Monitor and FreshBooks Add-Ons you should have no problems getting started with the User Registration Add-On.The User Registration Add-on requires Gravity Forms v1.5+ and will not work with older versions of Gravity Forms. The User Registration Add-On also requires a valid Gravity Forms Developer License to recieve access to automatic upgrades and documentation.

Installing the User Registration Add-On

• Download the add-on plugin from the Add-Ons download page.
• Upload the plugin folder and files via FTP to your wp-content/plugins folder OR upload the plugin zip file via the “Add New” plugin menu in WordPress.
• Activate the “Gravity Forms PayPal Add-On” plugin you just uploaded.

Setup the User Registration Add-On

After you have installed and activated the User Registration Add-On, you are now ready to setup a User Registration Feed. A User Registration feed allows you to integrate the User Registration Add-On functionality with a Gravity Form to register users using the specified form.

Creating a User Registration compatible Gravity Form

The only required fields a Gravity form must contain to be compatible with the User Registration Add-On are the Username and Email fields. With that said, here are the steps used to create an optimal User Registration form.

• Username (required)

  Add a Single Line Text field (under Standard Fields); used to map the Username for user registration.

• First Name & Last Name

  Add a Name field (under Advanced Fields). This will be used to map both the first and last name for user registration.

• Email (required)

  Add an Email field (under Advanced Fields); used to map the Email Address for user registration.

• Password

  Add a Password field (under Advanced Fields). This field will only be available after the User Registration Add-on is installed and activated. This field will be mapped to the Password field for user registration.

• Additional Fields

  You can add as many additional fields as you require. These fields can then be mapped to various User Meta fields available in the User Registration feed.

Setup a User Registration Feed

1. Click on the User Registration navigation item on the Forms menu.
2. Click on the “Add New” button to add a new User Registration Feed.
3. Select the Gravity Form you would like to integrate with.
4. Map the User Registration Fields to your available Form Fields. This is used to populate the user registration fields with the appropriate form fields when the form is submitted. For more information on available User Registration fields see #Standard Fields and #User Meta Fields.
5. Under Additional Options, use the Send Email? option to specify whether you would like to send the password to the new user by email. This option is enabled by default.
6. If desired, specify a Registration Condition. A Registration Condition allows you to conditionally register a user when the specified condition is met.

Standard Fields

• Username (required)

  specify a form field to be used to populate the new user’s username.

• First Name

  specify a form field to be used to populate the new user’s name.

• Last Name

  specify a form field to be used to populate the new user’s last name.

• Email Address (required)

  specify a form field to be used to populate the new user’s email address.

• Password

  specify a form field to be used to populate the new user’s password. If no form field is specified, the default option to Auto Generate Password will be used.

• Role

  specify the role the new user should be assigned. The default role is Subscriber.

User Meta Fields

The User Meta section of the User Registration Feed can be used to assign additional user meta to new users registered through the feed’s form. By default, most standard WordPress user meta fields available to be mapped.

There is also an option to Add Custom user meta. Adding customer user meta will allow you to map any available form field to any custom user meta option you require. Simply select the Add Custom option from the Select Meta Option drop down. The drop down will become an input field. Enter your desire custom meta name and select the form field it should be mapped to.

Limitations

• The User Registration Add-on v1.0 does not automatically add custom meta fields to the WordPress user profile page.

PayPal Integration

The User Registration Add-On integrates with the Gravity Forms PayPal Add-On to provide the following options:

• Register user only when a payment is received.

  When this option is enabled, the user will not be registered until the PayPal payment has been received.

• Update user when subscription is canceled.

  When this option is enabled, the user’s role will be adjusted based on the drop down selected to the right.

BuddyPress Integration

The User Registration Add-On integrates with the BuddyPress (BP) Plugin allowing you to populate BP profile fields from Gravity Form fields. The BP Meta section functions almost identically to the Custom Meta section with the exception of not having an Add Custom option. To add new BP meta options, you must add additionl BP profile fields on the BP Profile Field Setup page.

The User Registration Add-On is designed to work with BP v1.2.7.

Mapping BuddyPress Profile Fields

Some BuddyPress fields require special consideration when mapping to Gravity Form fields on your User Registration Feed. Below is a list of these fields and the requirements for mapping them correctly.

• Checkboxes

  A BP checkboxes field must be mapped to a checkbox field. Mapping to other field types will have varied results.

• Multi Select Box

  A BP Multi Select Box field must be mapped to a checkbox field. Mapping to other fields types will have varied results.