Notice: There is no legacy documentation available for this item, so you are seeing the current documentation.
The Leaderboard addon for AffiliateWP allows you to display a ranked list of your top-performing affiliates. You can showcase your affiliates’ referrals, earnings, and visits, creating a competitive atmosphere to encourage more engagement and performance.
In this guide, we’ll walk you through the installation and usage of the Leaderboard addon for AffiliateWP.
The Leaderboard addon is available with all license levels of AffiliateWP.
Installing the Leaderboard Addon
Before we get started, be sure to install and activate AffiliateWP on your WordPress site.
Once you’ve got AffiliateWP installed and your license is verified, you’ll be able to quickly install and activate the Leaderboard addon.
Using the Leaderboard Addon
With the Leaderboard addon installed and activated, you can add a leaderboard to any WordPress page using the [affiliate_leaderboard] shortcode. By default, the leaderboard displays the top 10 affiliates, ranked by their referral count.
To customize the leaderboard and display specific information, such as showing the top 5 affiliates, the number of referrals, and order affiliates by referral count, you can use the following shortcode:
[affiliate_leaderboard number="5" referrals="yes" orderby="referrals"]
This shortcode will show each affiliate’s referral count and rank them accordingly.
You can also customize the leaderboard to show additional information, such as the number of referrals, earnings, and visits for each affiliate. To display this information, use the following parameters within the shortcode:
- To show referrals:
[affiliate_leaderboard referrals="yes"] - To show paid earnings:
[affiliate_leaderboard earnings="yes"] - To show visits:
[affiliate_leaderboard visits="yes"]
You can combine multiple parameters to display more data. For example, to show all three metrics (referrals, earnings, and visits), use this shortcode:
[affiliate_leaderboard referrals="yes" earnings="yes" visits="yes"]
Only referrals with a status of Paid are included in the referral counts displayed on the leaderboard. Pending or unpaid referrals will not be counted.
By default, affiliates are ranked by the number of referrals. You can change the order by using the orderby parameter. For example, to rank affiliates by earnings instead, use the following shortcode:
[affiliate_leaderboard orderby="earnings"]
Similarly, you can rank affiliates by visits with this shortcode:
[affiliate_leaderboard orderby="visits"]
Feel free to combine parameters. For instance, to show the referral count and order affiliates by referrals, you can use this shortcode:
[affiliate_leaderboard referrals="yes" orderby="referrals"]
Frequently Asked Questions
What is the purpose of the Leaderboard addon?
The Leaderboard addon allows you to showcase your top-performing affiliates based on metrics like referrals, earnings, and visits. It helps motivate affiliates by creating a competitive environment where they can track their performance against others.
How often is the leaderboard updated?
The leaderboard is updated in real-time as affiliates generate referrals, earnings, and visits. Affiliates’ stats will be automatically reflected in the leaderboard as their activity occurs.
Can I change the order of the leaderboard?
Yes, you can change the order of the leaderboard by using the orderby parameter in the shortcode. For example, to order affiliates by earnings, use:[affiliate_leaderboard orderby="earnings"]
Can I customize the design of the leaderboard?
The design of the leaderboard can be customized through CSS within your WordPress theme. However, the basic functionality and data display are controlled by the parameters within the shortcode.
How do I display the top-performing affiliates?
To display the top-performing affiliates, simply use the following shortcode:[affiliate_leaderboard number="5"] This will display the top 5 affiliates by default, ranked by referrals.
That’s it! The Leaderboard addon allows you to display a ranked list of your top affiliates, motivating them through healthy competition. With flexible options to customize the displayed metrics and the number of affiliates shown, you can easily tailor the leaderboard to meet your program’s needs and engage your affiliates effectively.