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. This document provides instructions on how to integrate myCRED with Ultimate Member using the myCRED extension.

Note: You have to install and activate plugins myCRED and Ultimate Member before activating the extension.

Contents

Settings #

Main extension's settings are placed on the page wp-admin > Ultimate Member > Settings > Extensions > myCRED

  • Account Tab - Show or hide an account tab "My Points" that shows the user's 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 "My points tab." You should choose at least one point type.
  • Width/height of badge in pixels - Badges appearing in the profile tab
  • Show user badges in profile header?
  • Show user badges in Member Directories?

Transferring Points #

Go to wp-admin > Ultimate Member > User Roles > Edit Role and find the "myCRED" section. Turn on the Can transfer points to other members? setting to enable point transfer.

You'll see the Transfer Balance section in the My Points account tab.

Use the Choose point types to show in account page setting on wp-admin > Ultimate Member > Settings > Extensions > myCRED to choose point types you wish to display in Account and transfer.

Referral Link #

My Referral Link is shown in the My Points account tab if the "Points for referrals" hook is enabled. You can manage hooks on wp-admin > Points > Hooks. Add the Points for referrals hook to "Active Hooks".

The referral link can be shown or hidden by configuring the "Show user affiliate link in account page" setting on wp-admin > Ultimate Member > Settings > Extensions > myCRED.

Once the setting is enabled, you'll see the My Referral Link link in the My Points account tab.

Show Badges in User Header #

myCRED has the add-on named Badges that gives your users badges on their interaction on your website. Go to wp-admin > myCred > Add-ons to activated the Badges add-on.

Once the add-on is activated, you can create or add new Badges on wp-admin > myCred > Badges.

The badges can be displayed in user profile headers. To enable this feature, go to wp-admin > Ultimate Member > Settings > Extensions > myCRED and turn on the Show user badges in profile header? setting.

Example:

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 the admin page wp-admin > myCred > Add-ons.

Once the add-on is activated, navigate to the wp-admin > Points > 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 wp-admin > Points > Ranks. Click the Edit link under the particular rank you want to modify.

Display Balance, Progress, or Rank in Profile header #

The extension adds field types myCRED Progress and myCRED Rank. These fields can be added to the profile form, profile header, and member's card.

To display rank, progress, or balance on the profile field, you need to select myCRED Rank, myCRED Progress, or myCRED Balance in the "User Meta" widget on the page wp-admin > Ultimate Member > Forms > Edit Form.

Example:

Limit the number of rewards/charges on specific action #

You can manage which particular actions are rewarded or charged by adding the hook on the admin page wp-admin > Points > Hooks. Once a specific hook is added, you can limit the points to be rewarded or charged in total, per week, month, or year, or there is no limit at all.

Notifications #

The add-on named Notifications displays pop-up 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 wp-admin > myCred > Add-ons.

To customize the notification styling and template, go to the page wp-admin > myCred > General Settings > Notifications. You can also set the number of days a user's notification is saved before being automatically deleted or the "Transient Lifespan" and the duration of the notification after being shown to the user.

The users are notified, showing the amount they gained or lost on their page.

Email Notifications #

Aside from Notification pop-ups, myCRED also offers you 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 page wp-admin > myCred > Add-ons.

Once the add-on is activated, the Email Notifications option is appears in wp-admin > myCred. This is where you can add new notices. For instructions on establishing a new email notification, see the article Creating Notifications.

Go to wp-admin > myCred > Email Notifications and click the "Add New" button. Configure the notification (see an example below). Don't forget to click the "Update" or "Publish" to save changes.

Member Directories Setting #

After activating the Ultimate Member - myCRED Extension, you can configure the sorting of users in the member directory by their myCRED points. This allows you to showcase users with the least or most points at the top of the directory.

Sorting Options

You can choose between two sorting options:

  • Least Points: This option will display users with the lowest myCRED points at the top of the directory.
  • Most Points: This option will display users with the highest myCRED points at the top of the directory.

To configure the sorting options:

  1. Go to wp-admin > Ultimate Member > Member Directories.
  2. Click on "Edit" for the member directory you want to configure.
  3. In the Sorting section, select your preferred sorting option from the dropdown menu.
  4. Save your changes.

Profile Card Options

Hide myCRED Badges Checkbox

You can also choose to hide myCRED badges in the member directory by enabling the Hide myCRED badges checkbox. This allows you to control the visibility of myCRED badges in the directory.

Display myCRED Badges/Balance/Progress/Rank Fields

In the Profile Card section of the member directory settings, you can add myCRED badges, balance, progress, and rank fields to be displayed in the extra user information section of the directory. This allows you to showcase additional myCRED information about users in the directory.

Search Options

Add myCRED Balance/Rank Meta Filter

You can also add the myCRED balance and rank meta filter to the member directory, allowing users to filter the directory based on myCRED balance and rank. In the Choose filter(s) meta to enable setting you can select "myCRED Balance" and "myCRED Rank".

Profile Menu Settings #

The extension adds the "Badges" tab to the profile page menu. Admins can hide/show this tab and set who can see this tab.

To configure the profile menu settings:

  1. Go to wp-admin > Ultimate Member > Settings > Appearance > Profile Menu.
  2. Toggle the "Badges Tab" setting to hide or show the badges tab in the profile menu.
  3. Set the visibility of the tab based on user roles.