Smart Members Subscription Pro

Introduction

Smart Members Subscription PRO plugin is use to all member profile addition, view or modifications.
This plugin gives user friendly environment to user as well as easy to use methods that increases the quality of plugin as well.

The plugin contains module like Register member, Edit profile, Forgot password, Reset password, View profile, delete profile etc.

Note:This addon is an extended version of the Smart Member PRO addon. We have added a subscription feature in this addon. Rest of the other feature is same like in Smart Member PRO addon. If you are using Smart Member PRO already and want the subscription feature you can install this addon but do not remove the Smart Member PRO addon after installation of this addon because this addon does not create database table if Smart Member PRO is already installed. It will use the same table created by the Smart Member PRO that’s why we are not recommending uninstalling the Smart Member PRO after the installation of the SMSP addon. If you are not using Smart Member PRO then you can install this addon only.

Modules

• Registration / Edit Profile
• Login
• Forgot Password
• Reset Password
• View Profile
• Delete Profile
• Hooks

Registration / Edit profile

1. Contains in-built static fields and custom fields created by user.
2. Captcha facility
3. Google Re-captcha v2 facility.
4. Accept term as required field.
5. Can choose email as username.
6. Extra validations on email and username to identify uniqueness on same screen instead of EE gray screen.
7. Errors can display in site as inline or outline both.
8. All validation rules of codeigniter applied for field validation.
9. All 3 static image upload facility i.e., Avatar Image, Signature Image, Photo File
10. Instant mail as per users requirement and fields with extra EE code that will support by template parser. Email will send after convert full page from EE to HTML.
11. If user put down into Pending mode, the email will sent after user activate.
12. Inline errors to put error on same screen without loosing POST data.
13. Extra XID and CSRF token field in hidden in all forms to not loose basic dependency for EE 2.X.
14. Parameters to control form ID, Class, Attributes etc.
15. Parameter to control form to submit and/or return to secure URL.

Login

1. Can login with email or username.
2. Remember me option to remember user.
3. In page rules to check the username and password availability so it will not redirect default EE gray screen.
4. Parameters, Attributes, secure action/return same as registration.
5. Login to give 3rd optional parameter with username and password (Group ID). Sometimes useful to login when a specific member group needs to login from selection method.

Forgot Password

1. Check existence of email.
2. Email Reset URL with Key to user.
3. Can set expiration time of key from backend.
4. Set Reset password template, Forgot password email template, subject, message, reset URL from backend as well as frontend.
5. Can use any EE tags with email template to send mail from frontend as well as backend.
6. Parameters, Attributes, secure action/return same as registration.

Reset Password

1. Reset the password from Key.
2. Parameters, Attributes, secure action/return same as registration.

View Profile

1. Tags name with field name to display values i.e.,{first_name}
2. Tags name append with “_label” to display labels defined in backend i.e.,{first_name_label}
3. List total field variable to view every field that is entered by user. (Used in email template).

Delete Profile

1. Delete member profile by entering his/her password.
2. All data of member entered in site will also delete with profile.
3. Parameters, Attributes, secure action/return same as registration.

Hooks

We have created 13 hooks all over the module to control the functionality and flow by any extension developer without modifying core code of plugin.

Installation

Follow below steps to install Smart Members Subscription Pro version:EE5-EE6:

1. Download and Extract ZIP file of the module. (We recommend to use the latest version.)
2. Copy Smart_Members_Subscription_Pro > EE5-EE6 > system > user > addons > smsp folder to “Your Site > system > user > addons” Folder
3. Copy Smart_Members_Subscription_Pro > EE5-EE6 > themes> user > smsp folder to “Your Site > themes > user” Folder.
4. Login to backend panel with Super admin credentials.
5. Go to “Developer > Add-Ons” and Install Smart Members Subscription PRO module.

Note: If you purchased the addon from Devot:ee then you can get the license key from the licenses tab in your profile.

Note:This addon is an extended version of the Smart Member PRO addon. We have added a subscription feature in this addon. Rest of the other feature is same like in Smart Member PRO addon. If you are using Smart Member PRO already and want the subscription feature you can install this addon but do not remove the Smart Member PRO addon after installation of this addon because this addon does not create database table if Smart Member PRO is already installed. It will use the same table created by the Smart Member PRO that’s why we are not recommending uninstalling the Smart Member PRO after the installation of the SMSP addon. If you are not using Smart Member PRO then you can install this addon only.

Validation Rules

To submit any form you need some rules to give inputs.

This is the list of rules you can use for fields.

1. required
   • Returns FALSE if the form field is empty.
2. valid_email
   • Returns FALSE if the form field does not contain a valid email address.
3. valid_emails
   • Returns FALSE if any value provided in a comma separated list is not a valid email.
4. min_length
   • Returns FALSE if the form field is shorter than the parameter value.
   • Example: min_length[5]. Where 5 is a parameter of length.
5. max_length
   • Returns FALSE if the form field is longer than the parameter value.
   • Example: max_length[10]. Where 10 is a parameter of length.
6. exact_length
   • Returns FALSE if the form field is not exactly the parameter value.
   • Example: exact_length[10]. Where 10 is a parameter of length.
7. matches
   • Returns FALSE if the form field does not match the defined value of parameter.
   • Example: matches[field]. Where field is parameter name of field to match with.
8. Alpha
   • Returns FALSE if the form field contains anything other than alphabetical characters.
9. alpha_numeric
   • Returns FALSE if the form field contains anything other than alpha-numeric characters.
10. alpha_dash
    • Returns FALSE if the field contains anything other than alpha-numeric characters, underscores or dashes.
11. numeric
    • Returns FALSE if the form field contains anything other than numeric characters.
12. integer
    • Returns FALSE if the form field contains anything other than an integer.
13. decimal
    • Returns FALSE if the form field contains anything other than a decimal number.
14. is_natural
    • Returns FALSE if the form field contains anything other than a natural number.
15. is_natural_no_zero
    • Returns FALSE if the form field contains anything other than a natural number, but not zero.
16. valid_ip
    • Returns FALSE if the supplied IP is not valid.
17. sm_captcha_validate
    • Returns FALSE if the EE Captcha is not valid. (Default for EE captcha field.)
18. is_unique
    • Returns FALSE id the field value match with the field in database table.
    • Example: is_unique[members.email]. Where “members” is table name and “email” is field of that table.
19. exists_email
    • Returns FALSE if email field entered by user is not exists in members table.
    • Used in forgot password form email field by default.
20. auth_password
    • Returns FALSE if user entered wrong password.
    • Use in edit profile form to validate current password.

Hooks

Hooks are use to modify the data or writing your own flow on plugin without changing the core code of plugin. List of hooks given in smart members are listed below:

1. Build form starts:
   1. sm_build_form_start
   2. sm_before_logout_link
2. Build forms ends:
   1. sm_build_form_end
3. Start submit forms:
   1. sm_submit_form_start
   2. sm_logout_start
4. End submit forms:
   1. sm_submit_form_end
5. If errors found in forms:
   1. sm_error_in_form
   2. sm_outer_error
6. Initialize validation rules:
   1. sm_init_validation
7. View profile start
   1. sm_view_profile_start
   2. sm_view_profile_end
8. Before send email:
   1. sm_before_send_email
9. Total fields listed (Constructor Hook)
   1. sm_total_fields
10. Social Media login (Pro Feature)
    1. sm_before_social_login
    2. sm_after_social_login
11. Import member Hooks (Pro Feature [EE4 only])
    1. sm_element_before_import
    2. sm_element_after_import
12. You can also use ExpressionEngine default hooks given below:
    1. member_member_register_start
    2. member_member_register_errors
    3. member_member_register
    4. member_member_logout
    5. member_delete
    6. member_update_start
    7. member_update_end
    8. cp_members_validate_members
    9. member_register_validate_members

sm_build_form_start

This hook will call every time a forms build start. This hook let user to modify data before form generates.

sm_before_logout_link

This hook will call when generates logout url from {exp:smsp:logout}.
It has Logout URL in parameter of hook function.

sm_build_form_end

This hook will call every time a forms ends build. This hook will call before replace the actual data with tagdata. The parameter contains Source and the Variable array of form.

sm_submit_form_start

This hook will call when user submits a form. This hook will call before validation hook.

sm_logout_start

This hook will call when a user click on logout URL. The data passed in parameter is the GET array which can secure action parameter or return url.

sm_submit_form_end

This hook will call when we submits a form without any error and it update the form data into database.

sm_error_in_form

This hook will call when we found errors in our forms submitted data.

sm_outer_error

It is possible that error occurs in the form of the field of some xyz field and you forgot to add {error:xyz} in form. In that case error will show in ee default gray screen.
(Only called if error_reporting=”inline” is passed as parameter in form)

sm_init_validation

This hook will call before initialization of validation array to field. So you can control rules of fields before assign rules to fields.

sm_view_profile_start

This hook will call when you trigger {exp:smsp:profile} tag.

sm_view_profile_end

This hook will call before the actual profile data will replace with tagdata.
It will pass member data array in parameter and accept the same as return.

sm_before_send_email

This hook will call before any email sends with smart members. i.e., Registration email, forgot password email.

sm_total_fields

This is constructor hook. All possible fields that can exists in form or profile can contains. Array of this field is parameter of this hook.

sm_before_social_login (Pro Feature)

This hook will call before social login API call.

sm_after_social_login (Pro Feature)

This is constructor hook. All possible fields that can exists in form or profile can contains. Array of this field is parameter of this hook.

sm_element_before_import (Pro Feature [EE4 >= v2.0.3])

This hook will call just before member will insert or update in database. Hook has one parameter that contains array that going to be insert/update so one can modify member data before insert it into the database.

sm_element_after_import (Pro Feature [EE4 >= v2.0.3])

This hook will call just after member will save in database. Hook has one parameter that contains array that just saved into the database and second parameter as member_id which holds the data.

Dashboard - New

Here the Dashboard have all the initial setup links and some other essencial links.

Dashboard also come with some reports Ex. Sales and Revenue, Membership Stats, Visits, View and Login and Recent Orders.

Dashboard

Orders - New

Here we have all the orders list with tha basic operation of Edit,Copy,Delete and Email.
You can add new order here and export all the orders data into CSV file.

Orders

Add New Order

Click on “Add New Order” button to add an order.

1. ID
   • The ID will be generated when you save.
2. Code
   • This will be generated randomly.
3. Membership Level ID
   • Membership level ID generated when level created.
4. Fill the following fields to complete Billing details.
   • Billing Name
   • Billing Street
   • Billing City
   • Billing State
   • Billing Postal Code
   • Billing Country
   • Billing Phone
5. Sub Total
   • Total amount without tax and coupon amount.
6. Tax
   • Tax amount that you charge depends on locations or any other circumstances.
7. Total
   • Total amount should be subtotal + tax – couponamount.
8. Payment Type
   • Insert payment type here e.g. PayPal Express, PayPal Standard, Credit Card.
9. Card Type
   • Insert card type here e.g. Visa, MasterCard, AMEX, etc
10. Account Number
    • Insert Bank account number.(Obscure all but last 4 digits)
11. Expiration Month
    • Expiration Month of card
12. Expiration Year
    • Expiration Year of card
13. Status
    • Set status of order e.g. Cancelled,Error,Pending,Refunded,Review,Success,Token
14. Gateway
    • Select payment gateway that you made payment through e.g. stripe, paypal, authorize.net etc
15. Gateway Environment
    • Select payment gateway environment, either Testing or Sandbox.
16. Payment Transaction ID
    • Payment Transaction ID generated by the gateway. Useful to cross reference orders.
17. Subscription Transaction ID
    • Subscription Transaction ID generated by the gateway. Useful to cross reference subscriptions.
18. Date
    • Generated by the gateway. Useful to cross reference subscriptions.
19. Notes
    • Any notes generated through gateway or others.
20. And save the order

Subscribed Users - New

Subscribed Users

Here you can see all the users who have purchased the subscription.

If you want to see the detailed information of the subscription, click on the eye icon in manage column of the table.

Subscription Settings - New

Subscription settings allows you to customize settings for Subscription Plan, Discount Codes,Payment Gateway, Email and some other advance setting as per your requirements.

Under this setting you can create subscription, discount code and can manage as well. Payment Gateway allows to setup payment environment, payment method and SSL settings.

Subscription Settings

1. Plan

• • All the plans list created by site owner for users. List can be manage by edit, copy and delete operations.

Add New Plan

Click on “Add New” button to add new plan. And fill the following details

1. Name
   • The name of your Membership level (public).
2. Description
   • Optional content shown on the checkout page.
3. Confirmation Message
   • Optional content shown on the checkout confirmation page.
4. Billing Details:
   1. Initial Payment
      • This is what is charged at checkout. E.g. $10.
   2. Recurring Subscription
      • Check if your level has a recurring payment.
   3. Billing Amount
      • The amount to be billed one cycle (day(s), week(s), month(s), year(s)) after the initial payment.
   4. Billing Cycle
      • The total number of recurring billing cycles for this level, including the trial period (if applicable) but not including the initial payment. Set to zero if membership is indefinite. At the end of the last cycle, billing will stop, but the user will still have their membership level access unless you also set an expiration below.
   5. Custom Trial
      • Check if your level has a custom trial period. (Optional; Trial Payment and Trial Period.
   6. Trial Billing Amount
      • The amount (can be zero for free trial) and number of cycles to be billed (day(s), week(s), month(s), year(s)) after the initial payment.
5. Other Settings
   1. Disable New Signups
      • Disables new signups and hides the level from default page.
6. Content Settings
   1. Channels
      • Select the channels for which this plan has been created.
   2. Member groups
      • Select the Member groups for which this plan has been created.
   3. Categories
      • Select the Categories for which this plan has been created.
7. Save Plan

2. Discount Codes

All the discount code list created by site owner for users. List can be manage by edit, copy and delete operations.

Add New Discount Code

Click on “Add New Discount Code” button to add new discount code. And fill the following details

1. ID
   • This is the auto-generated ID, internally tracked (not public).
2. Code
   • The value of the code members can enter at checkout (public).
3. Start Date
   • The date you want the code to begin working.
4. End Date
   • The date you want the code to expire / stop working.
5. Uses
   • How many times the code can be used (leave blank for unlimited uses).
6. And Save.

Setting the Discount Code Pricing for a Plan

In section “Which Levels Will This Code Apply To?” check the available plans and fill the following details.

1. Initial Payment
   • The initial amount collected at registration.
2. Recurring Subscription
   • Check if this level has a recurring subscription payment.
3. Billing Amount
   • The amount to be billed one cycle after the initial payment.
4. Billing Cycle Limit
   • The total number of recurring billing cycles for this level, including the trial period (if applicable) but not including the initial payment. (Set to zero if membership is indefinite.)
5. Custom Trial
   • Check to add a custom trial period.
6. Membership Expiration
   • Check this to set when membership access expires.
7. Expires In
   • Set the duration of membership access. Note that the member’s recurring subscription (if any) will be cancelled when the membership expires.

3. Payment Gateway & Security

Payment Setting setup is simple just select a gateway and paste the appropriate API information into the Payment Gateway. Further you can setup for Currency,Tax and SSL.

Here is the detailed information about fields to be fill on this page.

1. Payment Gateway
   • Click the drop-down and select one of the payment options available.
2. Gateway Environment
   • Choose the test or live gateway.
3. Complete the fields for your chosen Gateway
   • Complete the fields for your chosen Gateway. For Stripe, enter your Stripe secret key and publishable key. Other payment methods will have different processes.
4. Sales Tax
   • For this example, we are not charging Sales Tax. Always check with your accountant or your state tax office to see if tax is required and the tax rate for your memberships. More Information: Non-US Taxes | VAT Tax.
5. Force SSL
   • An SSL certificate can be purchased and setup by your website hosting provider. If you are unsure, GoDaddy is a good SSL provider where you can get a cheap SSL to use no matter where your site is used.
6. SSL Seal Code
   • Display an image and link so users can validate your site’s SSL Certificate validity on membership checkout. (Note: if your provider’s seal graphic displays via a script tag, you must use custom code to display the seal.) This is different from the “SSL Certificate”, which is the private key certificate that must be installed by your web host.
7. Extra HTTPS URL filters
   • Check this if you are using SSL and have warnings on your checkout pages.
8. Save Settings

4. Email

Email Setting page allows you to control emails sent by your site.

Here is the detailed information about fields to be fill on this page.

1. From Email and From Name
   • Use these fields to change the email address and name used ExpressionEngine sends email communications to your members.
2. Send the site admin emails
   • Keep all boxes checked so you receive email confirmations about membership activity on your site.
3. Save Setting

5. Advanced Setting

Advanced Settings admin page allows you to control other customization settings for your site.

Here are the field description and its uses.

1. Use reCAPTCHA?
   • Requiring a credit card is the best spam prevention. But if you have a free level, you can turn on reCAPTCHA to add to the plugin’s built-in spam prevention.

Basic Settings

Basic settings allows you to customize plugin settings as per your requirements. Form is easy to understand and settings will effect in every module we use in frontend.

Setting form allows you to mark username as password, override screen name field, set registration email template and forgot password email template, set reset password template etc.

Basic setting form (Default view)

There are multiple fields that can change as per your requirements. Details about those fields are given below:

1. Use email address as username:

This field can be use to have same value for both username and email field. Checking this to YES will no longer need email field in registration page. You only need to use username field and put the type as email so one can not enter the text input rather then email address.

Example:

Note “type” of input is “email” and “name” of input is “username”. Same will follow in edit profile module.

2. Email template for new registrations:

You have 2 options here. You can either put every code of email templates for registrations and forgot password in backend setting form or you can generate template to frontend.

Select “Default” if you want to use backend setting form email templates for send emails.

Select front end template if you want to generate your own templates to send emails to user. Select the templates from front end is necessary for this option.

3. Screen name override:

This option allows you to use any custom field as Screen name. That will took the field on registration process and override screen name.

As screen name field must be unique, If one take a field name and that name is already in screen name field of any other user, the default screen name will use instead of override.

4. Enable Re-captcha ?

Enabling this will ask you recaptcha key and secret. You can generate recaptcha key and secret from google recaptcha site.
URL: https://www.google.com/recaptcha/admin#list

Enter your domain and generate key and secret. You can then use google recapthca in your front end module by entering enable_recaptcha=”yes” in parameter and code of google recaptcha in template:

Captcha and recaptcha to use in if else condition is helpful in case if you pass enable_recaptcha=”yes” in parameter and not give API key and Secret in backend setting form. In such case it will display normal captcha in place of recaptcha.

5. Email template setting:

If you choose Email template for new registrations to default, You need to pass the email settings in form at down otherwise you only need to select the email templates.

Basic Settings (Email template view)

Member Preferences

Member preferences setting form is only developed for EE3 users as static images such as Photo file and Signature Image fields settings of path, height, width etc. Settings are available in member preferences in EE2, But such setting forms are not available for EE3 right now.

You can simply adjust the settings for photo file, avatar and signature image settings from this module.

Member Preferences setting form

Social Settings

Social Login provides users to login with their social accounts. User can use login with Facebook, Twitter, Google and 20 more Social sites to login.

Social Settings List page

Every Social login API will ask for a callback URL. You can found a Callback URL at social Settings List page.

Callback URL:

Test the link is working or not by clicking TEST button at right. If link is not working please do check the link path is correct or not.

If Test goes success, You will see this page:

Social Settings Form:

Available Social sites:

• Facebook
• Twitter
• Google
• Live
• Yahoo
• Foursquare
• GitHub
• px500
• BitBucket
• Disqus
• Dribbble
• Dropbox
• GitLab
• Instagram
• LastFM
• MailChimp
• Slack
• SoundCloud
• Vimeo
• Tumblr

Facebook

To activate Facebook method in Social Login settings:

1. Generate Application ID and Application Secret From this link: https://developers.facebook.com/quickstarts/?platform=web
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need. Facebook API need exact callback URL. So you need to enter the callback URL with done parameter. ( EX: if your callback URL is http://www.example.com/?ACT=85, Your callback URL for facebook will be http://www.example.com/?ACT=85&hauth.done=Facebook
3. Once you generate Application ID and Application Secret, Go to social settings page in Smart Members Subscription Pro and Edit Facebook settings.
4. Put your Application ID and Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Twitter

To activate Twitter method in Social Login settings:

1. Generate Consumer key and Consumer Secret From this link: https://apps.twitter.com/app/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Consumer key and Consumer Secret, Go to social settings page in Smart Members Subscription Pro and Edit Twitter settings.
4. Put your Consumer key and Consumer Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Google

To activate Google method in Social Login settings:

1. Generate Client ID andClient Secret From this link: https://console.developers.google.com/
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need. Google API need exact callback URL. So you need to enter the callback URL with done parameter. ( EX: if your callback URL is http://www.example.com/?ACT=85, Your callback URL for Google will be http://www.example.com/?ACT=85&hauth.done=Google
3. Once you generate Client ID andClient Secret, Go to social settings page in Smart Members Subscription Pro and Edit Google settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Live

To activate Live method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://apps.dev.microsoft.com/#/appList/create/sapi
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Live settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Yahoo

To activate Yahoo method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://developer.yahoo.com/apps/create/
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Yahoo settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Foursquare

To activate Foursquare method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://foursquare.com/developers/apps
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Foursquare settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

GitHub

To activate GitHub method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://github.com/settings/applications/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit GitHub settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

px500

To activate px500 method in Social Login settings:

1. Generate Customer ID and Customer Secret From this link: https://500px.com/settings/applications
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Customer ID and Customer Secret, Go to social settings page in Smart Members Subscription Pro and Edit px500 settings.
4. Put your Customer ID and Customer Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

BitBucket

To activate BitBucket method in Social Login settings:

1. Generate Customer Key and Customer Secret From this link: https://bitbucket.org/account/user/testing_eecms/api
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Customer Key and Customer Secret, Go to social settings page in Smart Members Subscription Pro and Edit BitBucket settings.
4. Put your Customer Key and Customer Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Disqus

To activate Disqus method in Social Login settings:

1. Generate Public Key and Secret Key From this link: https://disqus.com/api/applications/register/
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Public Key and Secret Key, Go to social settings page in Smart Members Subscription Pro and Edit Disqus settings.
4. Put your Public Key and Secret Key in their fields. Select the callback URL you have put in API.
5. Save the settings.

Dribbble

To activate Dribbble method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://dribbble.com/account/applications/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Dribbble settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Dropbox

To activate Dropbox method in Social Login settings:

1. Generate App Key and App Secret From this link: https://www.dropbox.com/developers/apps/create
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate App Key and App Secret, Go to social settings page in Smart Members Subscription Pro and Edit Dropbox settings.
4. Put your App Key and App Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

GitLab

To activate GitLab method in Social Login settings:

1. Generate Application ID and Application Secret From this link: https://gitlab.com/oauth/applications
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Application ID and Application Secret, Go to social settings page in Smart Members Subscription Pro and Edit GitLab settings.
4. Put your Application ID and Application Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Instagram

To activate Instagram method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://www.instagram.com/developer/clients/register/
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Instagram settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

LastFM

To activate LastFM method in Social Login settings:

1. Generate API key and Shared Secret From this link: http://www.last.fm/api/account/create
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate API key and Shared Secret, Go to social settings page in Smart Members Subscription Pro and Edit LastFM settings.
4. Put your API key and Shared Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

MailChimp

To activate MailChimp method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://us14.admin.mailchimp.com/account/oauth2/client/
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit MailChimp settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Slack

To activate Slack method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://api.slack.com/apps/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Slack settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

SoundCloud

To activate SoundCloud method in Social Login settings:

1. Generate Client ID and Client Secret From this link: http://soundcloud.com/you/apps/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit SoundCloud settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Vimeo

To activate Vimeo method in Social Login settings:

1. Generate Client ID and Client Secret From this link: https://developer.vimeo.com/apps/new
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate Client ID and Client Secret, Go to social settings page in Smart Members Subscription Pro and Edit Vimeo settings.
4. Put your Client ID and Client Secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Tumblr

To activate Tumblr method in Social Login settings:

1. Generate OAuth consumer key and OAuth consumer secret From this link: https://www.tumblr.com/oauth/register
2. Enter Callback URL in API form. You can enter Default callback URL or Custom Callback URL as per your need.
3. Once you generate OAuth consumer key and OAuth consumer secret, Go to social settings page in Smart Members Subscription Pro and Edit Tumblr settings.
4. Put your OAuth consumer key and OAuth consumer secret in their fields. Select the callback URL you have put in API.
5. Save the settings.

Member Fields

ExpressionEngine has limit for member field types. One can only select Text Input, Textarea and select dropdown as custom member fields. We introduce Multi select box, Radio buttons, Checkboxes and File fields to use as custom member fields.

Member Fields setting List Page:

Create Field form:

Export Members

You can now export members with selected fields filtered by Groups. Exports are available to download in both CSV and XML format. You can save the exports to use it in future. Export can also made by out side of admin panel with auto generated links.

Export member List page:

You can download, edit or Delete the exports from here. URL link is will popup the external URL to download export from outsite of EE. There is some security to download exports from outside of EE. If you make export private, No once can download it without login with your account. Public exports can download from outside of EE with anyone who logged in. If you want to download export from outside of EE without login, set “Access export URL without Login ?” to YES.

Popup URL to download export outside of EE:

Generate Export Form 1:

Generate Export Form 2:

Import Members

One can import members with selected fields with filtration. Filtration is done on many basis such as same email, same member ID, same screen name, Sanitize the unique fields or not etc. Import can done from both CSV and XML files at path of both server path or URL. You can save the imports to use it in future. Imports can also done by out side of admin panel with auto generated links.

Import Members List page:

You can run, edit or Delete the imports from here. URL link is will popup the external URL to run export from outsite of EE. There is some security to run imports from outside of EE. If you make import private, No once can run it without login with your account. Public imports can run from outside of EE with anyone who logged in. If you want to run import from outside of EE without login, set “Access import URL without Login ?” to YES.

Popup URL to run import outside of EE:

Import Member Choose fields:

Import Member setup Configurations:

Run Import page inside EE:

Run Import page outside EE:

Registration

Registration module is use for register a user with your site. A registration module will process and react as per settings we have passed in member preferences and plugin setting form.

Tag for registration module will look like this.

Parameters

1. group_id
2. allowed_groups
3. rule:FIELD_NAME
4. attr:ATTRIBUTES
5. return
6. error_reporting
7. wrap_errors
8. on_submit
9. secure_action
10. secure_return
11. enable_recaptcha

Fields

1. group_id
2. username
3. email
4. password
5. password_confirm
6. avatar_filename
7. photo_filename
8. sig_img_filename
9. yahoo_im
10. url
11. location
12. occupation
13. interests
14. aol_im
15. msn_im
16. icq
17. bio
18. signature
19. captcha
20. CUSTOM_FIELD
21. CUSTOM_CHECKBOX_FIELD (Pro Feature)
22. CUSTOM_RADIO_FIELD (Pro Feature)
23. CUSTOM_MULTI_SELECT_FIELD (Pro Feature)
24. CUSTOM_FILE_FIELD (Pro Feature)

Following Parameters can be use in Registration form

group_id

Group id of member groups to put the member in any specific group.

Example:

allowed_groups

Allowed groups parameter is used to give options to member for select any group from them. Use input field of group_id to enter the group id from defined allowed groups.

Example:

rule:FIELD_NAME

Rule parameter is use to give custom rules to fields separate by pipe ( | ).

Example:

attr:ATTRIBUTES

Parameter to add attributes in form. We can add classes, ids etc.

Example:

return

Return to any specific page after successful submission of form.

Example:

error_reporting

Error reporting format is defined by this parameter. It can be either “inline” or “outline”.

“Inline” error reporting will show the error in same page.
“outline” error reporting will show error in EE gray box in new page.

Example:

wrap_errors

Use this parameter to wrap forms error in any span or div if set error_reporting=”inline”.

Example:

on_submit

This parameter allows us to call any Javascript function on submit of form

Example:

secure_action

Secure action will post the data on secure site i.e., https

Example:

secure_return

Secure return will return the page after submit of form on secure site i.e., https

Example:

enable_recaptcha

This parameter enables recaptcha instead of normal captcha.

1. Scenario EE2:
   1. If this parameter is set and API key and SECRET is not passed for recaptcha in backend, The normal captcha will show.
   2. If recaptcha API key and SECRET is passed in backend and this parameter not set:
      1. If the page is registration page and you have set captcha as required from member preferences, normal captcha will show.
      2. If the page is not registration page, neither captcha or recaptcha will show.
   3. If recaptcha API key and SECRET is passed in backend and this parameter is set:
      1. If the page is registration page and you have set captcha as required from member preferences, The normal captcha will not show and recaptcha will override the settings.
      2. If the page is not registration page, recaptcha will show.
2. Scenario EE3:
   1. Same scenario like EE2. Only change is, there is backend member preference settings in EE3 that allows to not enter any captcha if member is logged in. So if you set this parameter and API key and SECRET is also passed, If you are logged in this recaptcha or captcha will not show until you set “Require CAPTCHA while logged in?” to “Yes” from backend member settings > captcha settings.

Example:

Different methods that can be use by user are given below.

Login

Login module is use for login the registered member. ExpressionEngine also provides default Login module. We are giving the Login module to provide the additional features the plugin provides such as Inline error reporting, Recaptcha, Login with wither Username or Email address etc.

Tag for Login module will look like this.

Parameters

1. allowed_groups
2. rule:FIELD_NAME
3. attr:ATTRIBUTES
4. return
5. error_reporting
6. wrap_errors
7. on_submit
8. secure_action
9. secure_return
10. enable_recaptcha

Fields

1. group_id
2. username
3. email
4. password
5. auto_login
6. captcha

Following Parameters can be use in Login form

allowed_groups

Allowed groups parameter is used to give options to member for select any group from them. Use input field of group_id to enter the group id from defined allowed groups.

Example:

rule:FIELD_NAME

Rule parameter is use to give custom rules to fields separate by pipe ( | ).

Example:

attr:ATTRIBUTES

Parameter to add attributes in form. We can add classes, ids etc.

Example:

return

Return to any specific page after successful submission of form.

Example:

error_reporting

Error reporting format is defined by this parameter. It can be either “inline” or “outline”.

“Inline” error reporting will show the error in same page.
“outline” error reporting will show error in EE gray box in new page.

Example:

wrap_errors

Use this parameter to wrap forms error in any span or div if set error_reporting=”inline”.

Example:

on_submit

This parameter allows us to call any Javascript function on submit of form

Example:

secure_action

Secure action will post the data on secure site i.e., https

Example:

secure_return

Secure return will return the page after submit of form on secure site i.e., https

Example:

enable_recaptcha

This parameter enables recaptcha instead of normal captcha.

1. Scenario EE2:
   1. If this parameter is set and API key and SECRET is not passed for recaptcha in backend, The normal captcha will show.
   2. If recaptcha API key and SECRET is passed in backend and this parameter not set:
      1. If the page is registration page and you have set captcha as required from member preferences, normal captcha will show.
      2. If the page is not registration page, neither captcha or recaptcha will show.
   3. If recaptcha API key and SECRET is passed in backend and this parameter is set:
      1. If the page is registration page and you have set captcha as required from member preferences, The normal captcha will not show and recaptcha will override the settings.
      2. If the page is not registration page, recaptcha will show.
2. Scenario EE3:
   1. Same scenario like EE2. Only change is, there is backend member preference settings in EE3 that allows to not enter any captcha if member is logged in. So if you set this parameter and API key and SECRET is also passed, If you are logged in this recaptcha or captcha will not show until you set “Require CAPTCHA while logged in?” to “Yes” from backend member settings > captcha settings.

Example:

Different methods that can be use by user are given below.

Input

Select Dropdown: (For member group)

Captcha

Auto Login

Example:

Social Login

Social Login module is use for login/register a member with your site. A Social login module will react as per settings you have made in backend.

Tag for Social Login module will look like this.

Parameters

1. rule:FIELD_NAME
2. attr:ATTRIBUTES
3. return
4. no_email_return
5. error_reporting
6. wrap_errors
7. on_submit
8. secure_action
9. secure_return
10. enable_recaptcha
11. popup
12. remember_me
13. providers

Fields

1. providers

Following Parameters can be use in Social Login form

Edit Profile

Edit profile form is used to update the member static data as well as custom data. A member can also edit their profile username, email and password with this form.

Normal static fields and custom fields doesn’t require current password to update the data.

Dependent fields for login and email such as username, email and password fields needs current password to be entered to update the fields.

Tag for Edit profile module will look like this.

Parameters

1. allowed_groups
2. rule:FIELD_NAME
3. attr:ATTRIBUTES
4. return
5. error_reporting
6. wrap_errors
7. on_submit
8. secure_action
9. secure_return
10. enable_recaptcha
11. member_id
12. allowed_admin_groups

Fields

1. group_id
2. username
3. email
4. password
5. password_confirm
6. avatar_filename
7. photo_filename
8. sig_img_filename
9. yahoo_im
10. url
11. location
12. occupation
13. interests
14. aol_im
15. msn_im
16. icq
17. bio
18. signature
19. captcha
20. CUSTOM_FIELD
21. CUSTOM_CHECKBOX_FIELD (Pro Feature)
22. CUSTOM_RADIO_FIELD (Pro Feature)
23. CUSTOM_MULTI_SELECT_FIELD (Pro Feature)
24. CUSTOM_FILE_FIELD (Pro Feature)

Following Parameters can be use in Edit Profile form

Remove Images

Member can remove their images from “Edit member form”. This section contains removing of default images i.e., “Avatar file, Photo fIle and Signature image file”.

You can remove these images in 2 way.

Parameters

1. By submit the form:
2. By input field:

By submit the form

You need to pass an submit button named the file.

Examples:

To remove Avatar file pass this “name” attribute in submit button: (You can pass anything in “value” according to your form.)

To remove Photo file pass this “name” attribute in submit button: (You can pass anything in “value” according to your form.)

To remove Signature file pass this “name” attribute in submit button: (You can pass anything in “value” according to your form.)

View Profile

View profile module is to list the member(s) data. You can access each and every data except password with this module.

Tag for View profile module will look like this.

Parameters

1. member_id
2. group_id
3. not_member_id
4. not_group_id
5. limit
6. order_by
7. sort

Fields

1. aol_im
2. avatar_url
3. avatar_filename
4. avatar_height
5. avatar_width
6. bday_d
7. bday_m
8. bday_y
9. bio
10. email
11. group_id
12. icq
13. interests
14. join_date
15. last_activity
16. last_bulletin_date
17. last_comment_date
18. last_entry_date
19. last_email_date
20. last_forum_post_date
21. last_view_bulletins
22. last_visit
23. location
24. member_id
25. msn_im
26. notepad
27. notepad_size
28. occupation
29. private_messages
30. photo_url
31. photo_filename
32. photo_height
33. photo_width
34. screen_name
35. signature
36. sig_img_url
37. sig_img_filename
38. sig_img_width
39. sig_img_height
40. total_comments
41. total_entries
42. total_forum_topics
43. total_forum_posts
44. username
45. url
46. yahoo_im
47. CUSTOM_FIELD

Labels

1. aol_im_label
2. avatar_filename_label
3. avatar_height_label
4. avatar_width_label
5. bday_d_label
6. bday_m_label
7. bday_y_label
8. bio_label
9. email_label
10. group_id_label
11. icq_label
12. interests_label
13. join_date_label
14. last_activity_label
15. last_bulletin_date_label
16. last_comment_date_label
17. last_entry_date_label
18. last_email_date_label
19. last_forum_post_date_label
20. last_view_bulletins_label
21. last_visit_label
22. location_label
23. member_id_label
24. msn_im_label
25. notepad_label
26. notepad_size_label
27. occupation_label
28. private_messages_label
29. photo_filename_label
30. photo_height_label
31. photo_width_label
32. screen_name_label
33. signature_label
34. sig_img_filename_label
35. sig_img_width_label
36. sig_img_height_label
37. total_comments_label
38. total_entries_label
39. total_forum_topics_label
40. total_forum_posts_label
41. username_label
42. url_label
43. yahoo_im_label
44. CUSTOM_FIELD_label

To list all the fields above there is single field. It will list all the static fields which is not empty as well as all the custom fields created by user.

1. sm_list_all_fields
   1. Parameters (It doesn’t contain any parameter)
   2. Fields
      1. field_label
      2. field_value
      3. field_sort_name
      4. field_db_name
      5. sm_list_all_fields:count
      6. sm_list_all_fields:total_results

Example:

Following Parameters can be use in View Profile page

Forgot Password

Forgot Password module is use to send URL of reset password with key to reset the password of user.
Parameter of reset password template as well as forgot password email settings can be sent from backend smart members setting or can pass in this tag as parameter.

Tag for View profile module will look like this.

Parameters

1. rule:FIELD_NAME
2. attr:ATTRIBUTES
3. return
4. error_reporting
5. wrap_errors
6. on_submit
7. secure_action
8. secure_return
9. reset_password_template
10. email:subject
11. email:template
12. email:word_wrap
13. email:mailtype
14. enable_recaptcha

Fields

1. email
2. captcha

Following Parameters can be use in Forgot Password form

Reset Password

Reset Password module is use to set new password with help of token send by user in mail through forgot password email.

Tag for Reset password module will look like this.

Parameters

1. rule:FIELD_NAME
2. attr:ATTRIBUTES
3. return
4. error_reporting
5. wrap_errors
6. on_submit
7. secure_action
8. secure_return
9. enable_recaptcha
10. reset_code

Fields

1. password
2. password_confirm
3. captcha

Following Parameters can be use in Forgot Password form

Delete Member

Delete member module is use to allow member to delete himself from membership account of site. If one will delete his/her account, all the entries or data he/she has entered in the site will also deletes.

Any one can delete his/her account from site except super admin.

To delete the member user only needs his/her account password.

Tag for Delete member module will look like this.

Parameters

1. rule:FIELD_NAME
2. attr:ATTRIBUTES
3. return
4. error_reporting
5. wrap_errors
6. on_submit
7. secure_action
8. secure_return
9. enable_recaptcha

Fields

1. password
2. captcha

Following Parameters can be use in Forgot Password form

Logout

Logout module provides a user to successfully destroy the session and logging out from the site.

Tag for logout created in 2 ways. One is with closing tag and another one is without closing tag.

With closing tag, content code will look something like this:

Without closing tag, content code will look like this:

Parameters

1. return
2. secure_return

Following Parameters can be use in Forgot Password form

Plan - New

The plan tag is used to show the plan list for a logged-in member.

Tag for Plan module will look like this.

Parameters

1. id
2. name

Fields

1. id
2. name
3. description
4. confirmation
5. initial_payment
6. billing_amount
7. cycle_number
8. cycle_period
9. billing_limit
10. trial_amount
11. trial_limit
12. allow_signups
13. expiration_number
14. expiration_period
15. recurring_subscription
16. custom_trial

The following Parameters can be used in the Plan tag.

Discount codes - New

A discount code tag is used to show the discount code list.

Tag for the Discount module will look like this.

Parameters

1. id
2. code
3. start_date
4. expiry_date

Fields

1. id
2. code
3. start_date
4. expiry_date
5. uses

If you want to access the plan associated with this discount code. You can access it this way.

The following parameters can be used in the Discount tag.

Order list - New

The order list tag is used to show the all order list for a logged-in member.

Tag for Order list will look like this.

Parameters

1. id
2. code
3. user_id
4. membership_id
5. status
6. timestamp

Fields

1. id
2. code
3. user_id
4. membership_id
5. billing_name
6. billing_street
7. billing_city
8. billing_state
9. billing_zip
10. billing_country
11. billing_phone
12. subtotal
13. tax
14. couponamount
15. total
16. payment_type
17. cardtype
18. accountnumber
19. expirationmonth
20. expirationyear
21. status
22. gateway
23. gateway_environment
24. payment_transaction_id
25. subscription_transaction_id
26. timestamp
27. affiliate_id
28. affiliate_subid
29. notes

If you want to access the plan associated with this order. You can access it this way.

If you want to access the discount code applied to the order. You can access it this way.

The following parameters can be used in the Discount tag.

Get subscribed plan ID - New

To get the all subscribed plan ID for a logged-in member on the front side you can use below the example.

Example:

Output:

If you want to match the particular plan from the subscribed plan list of users, you can do it like this.

Cancel order - New

Tag for cancel the order will look like this.

Example:

Checkout - New

The checkout form tag will help you to checkout for a subscription plan.

Tag for checkout form will look like this.

Parameters

1. plan_id
2. prefix
3. return
4. payment_confirmation
5. cancel

Fields

Fields are categories into two parts. Plan fields and form fields. You can access the plan fields below. If you assign the prefix as “smsp” then you can access the fields this way. You can change the prefix as per your requirement. If no prefix is defined “smsp” will take by default.

Plan Fields

1. {smsp:plan:name}
2. {smsp:plan:description}
3. {smsp:plan:initial_payment}
4. {smsp:plan:billing_amount}
5. {smsp:plan:cycle_period}
6. {smsp:plan:cycle_number}
7. {smsp:plan:billing_limit}
8. {smsp:plan:trial_amount}
9. {smsp:plan:trial_limit}

Example:

Form Fields

1. {smsp:form:discount_code}
2. {smsp:form:first_name}
3. {smsp:form:last_name}
4. {smsp:form:email}
5. {smsp:form:address1}
6. {smsp:form:address2}
7. {smsp:form:city}
8. {smsp:form:state}
9. {smsp:form:postal_code}
10. {smsp:form:phone}
11. {smsp:form:country}
12. {smsp:form:card_number}
13. {smsp:form:expiry_month}
14. {smsp:form:expiry_year}
15. {smsp:form:cvc}
16. {smsp:form:captcha}
17. {smsp:checkout:error}

Example:

Show entries for the subscribed plan - New

If you want to restrict the channel entries based on the subscribed plan of a logged-in user, you can do this.

Switch plan - New

If a user wants to switch to another plan then he will cancel the last plan and subscribe to a new plan. this can be done with a single click. here is the example.

Changelog

V1.0.0

V1.0.0

• Initial Version