The Badges add-on in WishList Member allows you to award Badges to users based on criteria you create. This means you could set a special Badge to be given to users when they post their first comment on your site. Another Badge could be issued when they reach the 10, 25, 50 (or more) comments mark. How about an exclusive Badge based on the amount of times a user logs into the site? You can create Badges that handle it all.

These types of Badges are easy to set up and they help to promote member interaction while also encouraging them to return and check our your site regularly. All of this is possible and its just scratching the surface when it comes to using the Badges add-on in WishList Member.

You can select from the library of professionally designed Badges or you can create your own unique set of Badges. You also have the option to incorporate additional Add-ons with Badges like Quizzes, Points and Courses.

Details on installing and enabling Add-ons are available Right Here.

This Knowledge base entry includes details and examples of the available Badges features and functionality within WishList Member. The table of contents on the right can be used to jump to any section.

—

Badges Setup

Badge Rules are used to setup automation for adding Badges to a user account or removing Badges from a user account. A Badge Rule can be created in the Badges > Setup section of WishList Member. You will see a list of any existing Badge Rules and can create new ones.

—

Each Badge Rule will either add a set Badge to a user account or remove a set Badge from a user account based on how the Trigger is configured.

A Trigger basically means “When this happens”… “Then do this”

The green plus icon on the top of the Badge Rules section can be clicked to begin the Badge creation process.

—

The first step is to set a Name for the Badge Rule and click the green Apply button.

—

Once the Badge Rule has a Name, the Edit Setup Rules section will appear and the available settings can be configured for that specific Badge Rule.

—

There are a variety of different Triggers in the “When this happens” dropdown. The list of Triggers is populated based on the standard WishList Member Triggers and the additional Triggers related to any other WishList Member Add-ons you might have installed on your site.

—

Selecting a specific Trigger from the dropdown will result in showing the specific options for that Trigger.

Triggers can range from user login and user comments to a user completing a Quiz or Course. There is a wide selection of Triggers for you to choose from.

In the example shown below, users will be issued a Badge when they post their 25th comment on the site. There is a range of included Badges available for you to select or you can create your own Badges. (More information on creating Badges can be found in the Badges Library section below).

The blue Save or green Save & Close button can be clicked once all settings are configured.

—

Badges Library

A large library of Badges is included in the Badges > Library section of WishList Member and they come in different colors and designs. These Badge are ready to use or you can create your own Badges.

—

A new Badge can be created by clicking the green plus button.

—

The Upload Badge(s) pop up will appear and the WordPress Media section will be displayed. Any existing image can be selected as a Badge or a new image can be uploaded using the typical WordPress Media method.

—

Upload or select the desired image and the Edit Badge section will appear.

—

The Drag tool can be used to crop the image and set the Badge how you want it to be displayed. The blue Crop button needs to be clicked once the dimensions are set.

Name. The name of the Badge. This name will appear on the list of Badges in WishList Member.

Description. The description of the Badge. This is an optional field and can be used to include a brief description of the Badge.

Redeemable by Points. If enabled, the Badge can be redeemed by a user with Points. The WishList Member Points Add-on would need to be installed and enabled on the site to use this option. This option would allow a user to redeem the set number of Points to be issued the Badge. Only users with enough Points would be able to redeem those Points for the Badge.

The blue Save or green Save & Close button can be clicked once all settings are configured.

—

The newly created Badge will now appear on the list in the Library.

—

Badges Mass Add/Remove

The option to add or remove a Badge for all members in a level can be done in the Badges > Mass Add/Remove section of WishList Member.

The desired Badge can be selected using the corresponding dropdown and the green Add or red Remove button can be used to Add/Remove the Badge for all members within that specific level.

—

The screenshot example below shows the Badge named “Member Platinum” has been selected for the Platinum level and clicking the Add button will add that Badge to all members in the Platinum level.

—

The Mass Add/Remove Badge popup will appear and you will be asked if you want to proceed with the selected action.

—

Once you confirm the action, a progress message will appear.

You will need to keep the page open while the action is processed.

—

A final message stating the action is “Done” will be displayed and the Mass Add/Remove action for the selected level and Badge is complete.

—

Badges Logs

The Badges > Logs section in WishList Member displays a list of users and their Badges history. This includes a record of Badges that were added to their account or Badges that were removed from their account.

—

An advanced search is available with options to Select the Trigger type and/or Select How the Badge was Processed (Added or Removed).

—

A brief description of how the Badge was added/removed is displayed in the Transaction Details column. The screenshot example below shows a member named Tara Tester with a Badge added to their account when they completed a course.

—

Another member named Walter Tester had a Badge added to their account when they posted a comment.

—

You can hover your mouse over a Badge to see its name displayed.

—

Badges Settings

The Badges > Settings section in WishList Member includes general settings for Badges.

—

Display Badges on User Comments Profile. If enabled, Badges will be displayed on the User Comment Profile on the live site.

Default# of Badges to Display. Set the default number of Badges to display for a user on the live site. Note that if a user earns more than the default number of Badges a “More” option will appear which can be clicked to view the additional Badges.

Size of the Badges in Pixels. Set the size of the Badges (in pixels) that will be displayed on the User Comment Profile on the live site.

Location of the Badges in the Comment Section. Select the section the Badges will be displayed on the User Comment Profile on the live site.

—

API Key. The “Click here to view instructions…” API KEY link directs to a page on your site with more details on using the WishList Member Badges API. An example screenshot of that page is included below.

—

You can use the Badges add-on in WishList Member to encourage member engagement and interaction. Use the included selection of Badges or create your own to customize the experience for your community. You have the power to add Badges or remove Badges based on the actions of your members. So, you only have to set a Badge Rule once and the Badges Add-on will handle the rest.

Additional Add-ons like Quizzes, Points and Courses can also be used with Badges.

We are going to address the following question:

How Do I Create a Badge?

—

A Badge can be added in the Badges > Library section.

This will allow you to use that Badge just like any other Badge.

—

A new Badge can be created by clicking the green Plus button.

—

That will bring up the Upload Badge(s) pop up. This will display the WordPress Media section and a new image can be uploaded in the Upload files tab.

Click the Select Files button to find the image file on your computer or simply drag and drop the image file to upload.

—

Once the file is uploaded, you can now click the image and then click the blue Select an Image button.

—

The Edit Badge section will now appear.

—

The Name and Description can be set for the Badge. The Description will appear on the list of Badges in the Library section.

The Drag tool can be used to crop the image and set the Badge how you want it to be displayed. You can select the entire image or only a portion using the crop tool. The blue Crop button needs to be clicked once the dimensions are set.

The four dimension examples show how the Badge will appear in those set sizes.

If the “Redeemable by Points” option is enabled, the Badge can be redeemed by Users with Points.

The blue Save or green Save & Close button can be clicked once all settings are configured.

—

The newly created Badge will now appear on the list.

—

The Badge can now be used like any other Badge.

—

More details on using Badges can be found in the Badges Setup Overview article.

—

Back to Top

We are going to address the following question:

How Do I Assign a Badge to a User when a Course is Completed?

Related: Click Here for info on assigning Points to a User when a Course is Completed.

—

WishList Member provides the ability to add a Badge to a User based on Triggers. In this example, we are going to run through the steps to assign a “Night Sky” Badge to a User who completes the “Learning to Skydive” Course.

The first step is to create a Course. (Details on Course creation can be found in the Course Setup Overview and Course Builder articles)

—

Once you have your Course created, you can set it to assign a Badge to Users when they complete that Course. This will be done by setting up a Badge Rule in the Badges > Setup section.

The Points Rule will handle the adding of the Points.

—

The green plus icon on the top of the Points Rules section can be clicked to begin the Points creation process.

—

Set a Name for the Badge Rule and click the green Apply button.

—

We have set the Rule name as “Night Sky Badge for Completing Course” in this case.

The Badge Rule has a Name so the Edit Setup Rules section will appear and the various settings can be configured for this specific Badge Rule.

We want this rule to assign the “Night Sky” Badge when a Course is completed, so the settings can be adjusted accordingly.

In the example shown below, Users will be issued “Night Sky” Badge when they mark the “Learning to Skydive” Course as complete.

The blue Save or green Save & Close button can be clicked once all settings are configured.

—

The Badge Rule has now been created and any Users who complete the “Learning to Skydive” Course will be issued the “Night Sky” Badge.

—

More details on Badges can be found in the Badges – Setup Overview article.

—

Back to Top

This allows for even more opportunities for user engagement and interaction.

Points and Badges can be issued to users based on set Triggers and Actions. Additional Triggers will be available for Points and Badges if any of the plugins listed below are installed and activated on the same site.

There is a variety of available Triggers available in the “When this happens” dropdown for both Points and Badges. Selecting a specific Trigger from the dropdown will result in showing the specific options for that Trigger.

This can be found in the following sections:

WishList Member > Badges > Setup > *Click Rule Name* (or Create a New Rule)

—

OR

WishList Member > Points > Setup > *Click Rule Name* (or Create a New Rule)

—

Related: Additional info on setting up Triggers (“When this happens”) and Actions for Points and Badges.

—

The available Integration options and their Triggers:

• bbPress
• BuddyBoss
• LearnDash
• Lifter LMS
• Presto Player
• SimplePress
• Tutor LMS
• WishList Member
• WooCommerce

—

bbPress

• User creates a discussion
• User replies to a discussion
• User subscribes to a forum
• User subscribes to a topic

—

BuddyBoss

• User creates a discussion
• User replies to a discussion
• User subscribes to a forum
• User subscribes to a topic

—

LearnDash

• Completed a Course
• Completed a Lesson
• Completed a Quiz
• Enrolled in a Course

—

Lifter LMS

• Completed a Course
• Completed a Lesson
• Completed a Quiz
• Enrolled in a Course

—

Presto Player

• Completed a Video

—

SimplePress

• Creating a Forum Thread
• Replying to a Forum Thread

—

Tutor LMS

• Completed a Course
• Completed a Lesson
• Completed a Quiz
• Enrolled in a Course

—

WishList Member

• Added to Level
• Cancelled from Level
• Removed from Level
• Uncancelled from Level
• Added to Pay Per Post

—

WooCommerce

• Purchased a Product
• Refunded a Purchase

—

Back to Top

Maybe you'd like to issue a specific badge when a user posts their 100th comment. Or perhaps you want to remove a badge if a user takes a quiz.

These are only a couple examples. They are a number of reasons to create a badge rule and many options to customize the process.

We are going to address the following question:

Badges – How Do I Setup a Badge Rule?

Related: Click Here for info on assigning Badges to a User when a Course is Completed.
Related: Click Here for more details in the Badges Overview.

—

Badges can be created in the Setup > Badge Rules section.

—

Each Rule will add/remove the set Badge based on how the Trigger is configured. “When this happens” “Then do this”

The green plus icon on the top of the Badges > Badge Rules section can be clicked to begin the Badge creation process.

—

Set a Name for the Badge Rule and click the green Apply button.

—

Once the Badge Rule has a Name, the Edit Setup Rules section will appear and the various settings can be configured for that specific Badge Rule.

There is a variety of available Triggers available in the “When this happens” dropdown. Selecting a specific Trigger from the dropdown will result in showing the specific options for that Trigger.

Triggers can range from user login and comments to completing a Quiz or Course. There is a wide selection of available Triggers.

The Screenshot below displays a configuration for a Badge Rule named “Next Level Badge” that will remove the New Member Badge from users who complete the “What to Expect” Lesson in “The Basics” Module in the “Learning to Skydive” Course.

The blue Save or green Save & Close button can be clicked once all settings are configured.

—

The above is just one example of a Badge Rule. There are various triggers that can be set to apply actions. We recommend checking out the “When this happens” dropdown to see the various options available. Selecting a trigger will show even more actions that can be used.

—

Back to Top

CourseCure includes a number of helpful shortcodes that can be used to display various pieces of information to users. These shortcodes cover a variety of topics ranging from Quiz Results and Point Totals to Course Details, Badge Lists and much more. You can easily insert a shortcode onto any page of your site and the corresponding information will be automatically displayed to your members.

—

The CourseCure Shortcode Inserter can be easily accessed using either of the following Gutenberg Blocks:

• Paragraph Block
• Shortcode Block

You can also create and access any WishList Member or CourseCure shortcodes using the Shortcode Creator.

CourseCure Shortcode Inserter – Gutenberg Paragraph Block

The Paragraph Block can be added to any page or post using the Gutenberg editor.

—

Once the Paragraph Block is inserted, the CourseCure icon can be used to access the library of CourseCure shortcodes.

—

The CourseCure Shortcodes selector appears and you can choose any available shortcode to insert into the page.

—

The shortcodes for each of the Add-ons that have been activated on the site will appear in the categorized list. The screenshot example below shows the Courses, Points, Badges and Quizzes Add-ons are activated.

The desired shortcode(s) can be selected and inserted from the list.

—

The example below shows the Lifetime Points shortcode has been selected. The shortcode is displayed in the Preview section and the blue Insert button can be clicked to insert the shortcode into the page.

—

The Lifetime Points shortcode has now been inserted into the page. Once the page has been saved, the corresponding information for that shortcode will appear on the live site.

—

CourseCure Shortcode Inserter – Gutenberg Shortcode Block

The Shortcode Block can be added to any page or post using the Gutenberg editor.

—

A shortcode can be manually pasted into the field. You can also use the CourseCure icon to view the list of available CourseCure shortcodes and select one from the list.

—

The CourseCure shortcodes option will appear.

—

The shortcodes for each of the Add-ons that have been activated on the site will appear. In the screenshot example below, the Courses, Points, Badges and Quizzes Add-ons are activated.

The desired shortcode(s) can be selected and inserted from the list.

—

The example below shows the Quiz Score shortcode has been selected. The shortcode is displayed in the Preview section and the blue Insert button can be clicked to insert the shortcode into the page.

—

The Quiz Score shortcode has now been inserted into the page. Once the page has been saved, the corresponding information for that shortcode will appear on the live site.

—

More details on each shortcode can be found in the Summary of CourseCure Shortcodes article.

Back to Top

Each CourseCure Add-on has it's own set of shortcodes and corresponding functionality. These shortcodes convert simple text codes into dynamic content and you don't need to be a coder to use them. This article will run through a brief summary of available shortcodes to help show what can be done when using CourseCure on your site. These shortcodes provide you with an easy and effective way to customize your site for your members to experience.

Additional details on how to insert a shortcode using the CourseCure Shortcode Inserter can be found in the Shortcode Inserter article.

—

There are 4 Add-ons that will be the focus of this article and you can jump to more info on any of the following at any time.

• The Courses Add-on
• The Quizzes Add-on
• The Badges Add-on
• The Points Add-on

—

All the available shortcodes can be accessed by clicking the CourseCure icon in the Gutenberg editor. The CourseCure Shortcodes dropdown appears and you can select any one to get started.

—

Courses Shortcodes

• Course Library Shortcode. Displays the library of courses on the site. There is also a variety of additional settings that can be configured using the available dropdowns within the Shortcode Creator once Course Library has been selected. Those settings include the following:
  
  
  • Course Access. Select if All users can view the course library or only users with Access to the courses can view the course library.
  • Course Category. Select if courses within All Categories are displayed or only courses within the selected Category are displayed.
  • Course Difficulty. Select if courses within All Difficulties are displayed or only courses within the selected Difficulty are displayed.
  • Columns. Select the number of Columns to be displayed. This will control the appearance of the list of courses displayed on the page. If Default is selected, the number of Columns is 3.
  • Display Search Bar. Select if the Search Bar should or should not be displayed on the library. If Default is selected, the setting in the Courses > Settings > Layout section will determine if the Search Bar is displayed or not.
  • Preview. The shortcode is automatically adjusted and a preview is displayed in real time based on the selected settings.

Shortcode: [wishlist_courses_archive access="all" category="0" difficulty="0" column="default" searchbar="default"]

—

The example screenshot below shows the Course Library shortcode configured to display to all users. It will only display the courses within the Overall category and with the Beginner difficulty. 5 columns and the search bar will also be displayed.

Shortcode: [wishlist_courses_archive access="all" category="65" difficulty="68" column="5" searchbar="yes"]

—

Quizzes Shortcodes

• Quiz Codes. Displays the selected quiz on the page or post.
  
  • Select Quiz. Select the desired quiz to insert. The fully configured quiz will be inserted and displayed on the live site.

Shortcode: [WLQuiz id="1"]

—

• Quiz Name. Displays the name of the quiz on the page or post. The name you gave the quiz will be displayed on the live site.

Shortcode: [WLQuiz_Name]

—

• Quiz Score. Displays the quiz score to the user. The specific quiz score for the specific user viewing the page or post will be displayed on the live site. This can be helpful as the user can easily view their score for the quiz they completed.

Shortcode: [WLQuiz_Score]

—

• Passing Score. Displays the score needed to pass the quiz. The set quiz score required to pass the quiz will be displayed on the live site. This can be helpful to display before users take the quiz so they can see what score they need to achieve in order to pass the quiz.

Shortcode: [WLQuiz_Passing_Score]

—

• Perfect Score. Displays the perfect score for the quiz. The perfect score that has been set for the quiz will be displayed on the live site. This can be helpful if you want to show what score is needed to achieve a perfect score for the quiz.

Shortcode: [WLQuiz_Perfect_Score]

—

• Total Questions. Displays the total number of questions for the quiz. The set total number of questions within the quiz will be displayed on the live site. This can be helpful if you want users to know how many questions they can expect within the quiz. The users would be able to estimate the time they will need to complete the quiz if they have an idea of the amount of questions they will be answering.

Shortcode: [WLQuiz_Total_Questions]

—

• Total Correct Answers. Displays the total number of correct answers to the user. The set total number of correct answers from the quiz will be displayed on the live site. This can be helpful as it can encourage and motivate users based on the number of questions they got correct.

Shortcode: [WLQuiz_Total_Correct_Answers]

—

• Total Incorrect Answers. Displays the total number of incorrect answers to the user. The set total number of incorrect answers from the quiz will be displayed on the live site. Similar to displaying the total correct answers, displaying the total incorrect answers can also be helpful as it can encourage and motivate users based on the number of questions they got wrong.

Shortcode: [WLQuiz_Total_Incorrect_Answers]

—

Badges Shortcodes

• Badges. Displays the list of badges on the page or post.
  
  • Badge Size: Select the desired size of the badges
  • Sort Badges by: Select if badges should be Sorted by Newest or Oldest earned
  • Type of Badge: Select if displayed badges are Earned or Unearned (or Combined)
  • Badges Column #: Set the number of Columns to be displayed.
  • Preview. The shortcode is automatically adjusted and a preview is displayed in real time based on the selected settings.

Shortcode: [wl_badges size="medium" sort="newest" type="showall" col="3"]

—

The example screenshot below shows the Badges shortcode configured to display a list of badges sorted by the Oldest and showing badges using the Small size format. It will only display the badges that have been Earned by the user and the badges will be displayed in 4 columns.

Shortcode: [wl_badges size="small" sort="oldest" type="earned" col="4"]

—

Points Shortcodes

• Lifetime Points. Displays the total number of all points ever earned by the user. This includes any points that have been redeemed.

Shortcode: [wlpts_lifetime_points]

—

• Remaining Points. Displays the number of available points the user has remaining. As an example, if the user had 10 points and redeemed 3 points, they would have 7 remaining points.

Shortcode: [wlpts_remaining_points]

—

• Redeemed Points. Displays the total number of points ever redeemed by the user. As an example, if the user has redeemed 5 points today and had redeemed 10 points the week before and redeemed 15 points a month ago, the redeemed points would be 30.

Shortcode: [wlpts_redeemed_points]

—

• User Points Logs. Displays a table showing the full logs of points transactions by the user. This includes points earned and points redeemed.

Shortcode: [wlpts_user_logs]

—

• Redemption Buttons. Create and insert a button that can be used to redeem points.
  
  • Select Redemption Rule. Select the desired redemption rule for the button. The dropdown is populated by redemption rules that have been created in the Points Add-on.
  • Preview. The shortcode is automatically adjusted and a preview is displayed in real time based on the selected settings.

Shortcode: [points_addon_redeem id="4"]

—

The example screenshot below shows the Redemption Button shortcode configured to display a button to redeem the Bonus Post for a cost of 5 points.

The cost of the Bonus Post is set in the Points Rule.

Shortcode: [points_addon_redeem id="3"]

—

You can use any of the available shortcodes to easily display specific info to your members. This can include everything from their individual quiz results to their collected badges or points totals. This type of information can be used to help encourage member interaction within your membership. You can start using CourseCure shortcodes to keep members engaged and up to date within your site.

==========

/**
* Fires after a badge has been successfully added to a user
*
* @param integer $user_id – User Id
* @param integer $badge_id – ID of the badge added.
*/
do_action( ‘wishlistbadge_add_user_badge', $user_id, $badge_id );

/**
* Fires after a badge has been successfully removed from a user
*
* @param integer $user_id – User Id
* @param integer $badge_id – ID of the badge removed.
*/
do_action( ‘wishlistbadge_remove_user_badge', $user_id, $badge_id );

—

More info on Hooks can be found in the following articles:

Hooks – Courses
Hooks – Quizzes
Hooks – Points

—

Back to Top