Ultimate Member - myCRED Extension

Overview

myCRED is an adaptive points management system that lets you award/charge your users for interacting with your WordPress powered website. In this documentation, we will provide instructions on the following features of myCRED extension:

Contents

Settings #

Main extension's settings are placed at the page [Ultimate Member > Settings > Extensions > myCRED]

  • Account Tab - Show or hide an account tab "My Points" that shows the user balance
  • Show user affiliate link in account page - Show or hide My Referral Link in the Account page. Note: Requires the “Points for referrals” hook to be enabled.
  • Choose point types to show in account page - Select what point types you want to see and manage in the tab "My points". You should choose at least one point type.
  • Width / height of badge in pixels - Badges appearing in profile tab
  • Show user badges in profile header?
  • Show user badges in Member Directories?
  • Hide bbPress Role?
  • Show user rank in bbPress replies
  • Show user balance in bbPress replies
  • Show user progress in bbPress replies

Transferring Points #

Please go to the user role at the page [Ultimate Member > User Roles] and find myCRED section, then enable points transfer.

Once the option "Can transfer points to other members?" is enabled you'll see the "Transfer Balance" section in the "My Points" tab under the Account page.

Referral Link #

My Referral Link is shown in the "My Points" tab under the Account page if "Points for referrals" hook is enabled. You can manage hooks at the page [Points > Hooks]

The referral link can be shown or hidden by setting "Show user affiliate link in account page". Once the setting is enabled you'll see the  "My Referral Link" link in the "My Points" tab under the Account page.

Show Badges in User Header #

myCRED has the add-on "Badges" that gives your users badges on their interaction in your website.

Once you have activated the Badges add-on, you can now add Badges in the admin page [myCRED > Badges]

You can show Badges in user profile headers. Just turn option 'Show user badges in profile header?' in the [Ultimate Member > Settings > Extensions > myCRED]

User Ranking #

myCRED also offers users ranking based on their total accumulated- or their current balance. To reward your users with total or current points based ranks, you need to activate the "Ranks" add-on via admin page [myCRED > Add-ons]

Once the add-on is activated, navigate to the [myCRED > Settings] page and click on the "Ranks" title in the list. Set what features you want to enable for each rank. Click on 'Update Settings' to save changes. To specify the minimum and maximum points to reach a specific rank and upload the rank logo, go to the page [MyCRED > Ranks]. Click the Edit link under the specific rank you want to modify. 

The extension adds field types "myCRED Progress" and "myCRED Rank". You may add these fields into the profile form, profile header, member's card in the members directory.

Display Balance, Progress or Rank in Profile header #

To display rank, progress or balance on the profile field, you need to select 'myCRED Rank', 'myCRED Progress' or 'myCRED Balance'  in user meta widget on the admin page [Ultimate Member > Forms >  Profile Form]

Limit the number of rewards/charges on specific action #

You can manage which specific actions are to be rewarded or charged on by adding the specific hook on the admin page [myCRED > Hooks]

Once a specific hook is added, you can limit the points to be rewarded/charged in total, per week/month/year or no limit at all.

Notifications #

The add-on "Notifications" displays popup notifications to inform the users when they have earned/spent or lost points on your website. To activate this add-on, please navigate to the admin page [myCRED > Add-ons] and click on "Activate" button under the "Notifications".

To customize the notification styling and template, go to the admin page [myCRED > Settings]. You can also set the number of days a users notification is saved before being automatically deleted or the 'Transient Lifespan' as well as the duration of the notification after being shown to the user.

The users are shown the amount they gained or lost on their profile.

Email Notifications #

Aside from Notification pop-ups, myCRED also offers you to send an email confirmation when a user pays using points or when they gain or lose points. To add this to your website, you need to activate the "Email Notifications" add-on via the admin page [myCRED > Add-ons]

Once the add-on is activated, the "Email Notifications" link appears in the admin menu. This is where you can add new notices.

Look at the article " Creating Notifications" for instructions on creating new email notice. See an example:

To edit the email format and settings, go to the admin page [myCRED > Settings > Email Notices]. Don't forget to click on 'Update Settings' to save changes.