A free points management plugin for WordPress.
myCRED Logo
myCRED Logo
  • Membership New
  • Chapters
    • Chapter I – Introduction
    • Chapter II – Getting Started
    • Chapter III – Add-ons
    • Chapter IV – Premium Add-ons
    • Chapter V – For Developers
    • Chapter VI – Reference Guides
  • Categories
    • Actions
    • Classes
    • Constants
    • Filters
    • Functions
    • Objects
    • Shortcodes
    • Hooks
    • Template Tags
  • Packages
    • mycred/api
    • mycred/badge
    • mycred/balance
    • mycred/banking
    • mycred/content
    • mycred/core
    • mycred/coupon
    • mycred/email
    • mycred/game
    • mycred/log
    • mycred/notice
    • mycred/payment
    • mycred/purchase
    • mycred/rank
    • mycred/transfer
  • Store
  • Download
    Navigation
    • Loading navigation ...
    All Shortcodes
    myCRED shortcodes
    1. mycred_affiliate_id
    2. mycred_affiliate_link
    3. mycred_all_scratch_cards
    4. mycred_badges
    5. mycred_badges_list
    6. mycred_badges_progress
    7. mycred_best_user
    8. mycred_buy
    9. mycred_buy_form
    10. mycred_buy_pending
    11. mycred_cashcred
    12. mycred_chart_balance_history
    13. mycred_chart_circulation
    14. mycred_chart_gain_loss
    15. mycred_chart_history
    16. mycred_chart_instance_history
    17. mycred_chart_top_balances
    18. mycred_chart_top_instances
    19. mycred_content_buyer_avatars
    20. mycred_content_buyer_count
    21. mycred_content_sale_count
    22. mycred_email_subscriptions
    23. mycred_exchange
    24. mycred_give
    25. mycred_hide_if
    26. mycred_history
    27. mycred_hook_table
    28. mycred_leaderboard
    29. mycred_link
    30. mycred_list_ranks
    31. mycred_load_coupon
    32. mycred_lotteries
    33. mycred_lottery
    34. mycred_lottery_jackpot
    35. mycred_lottery_quickpick
    36. mycred_lottery_results
    37. mycred_lottery_winnings
    38. mycred_my_badges
    39. mycred_my_balance
    40. mycred_my_balance_converted
    41. mycred_my_rank
    42. mycred_my_ranking
    43. mycred_my_ranks
    44. mycred_my_ranks_progress
    45. mycred_my_transfer_fee
    46. mycred_paymentwall
    47. mycred_pending_transfers
    48. mycred_rank_progress
    49. mycred_referral_stats
    50. mycred_sales_history
    51. mycred_scratch_cards
    52. mycred_scratch_cards_remaining
    53. mycred_scratch_history
    54. mycred_sell_this
    55. mycred_sell_this_ajax
    56. mycred_send
    57. mycred_show_if
    58. mycred_stripe_buy
    59. mycred_stripe_subscribe
    60. mycred_stripe_subscription
    61. mycred_total_balance
    62. mycred_total_points
    63. mycred_total_since
    64. mycred_transfer
    65. mycred_users_of_all_ranks
    66. mycred_users_of_rank
    67. mycred_video
    Categories
    Filter by category
    1. Actions
    2. Classes
    3. Filters
    4. Functions
    5. Hooks
    6. Objects
    7. Shortcodes
    8. Template Tags
    Chapters
    Documentation
    1. Chapter I - Introduction
    2. Chapter II - Getting Started
    3. Chapter III - Add-ons
    4. Chapter IV - Premium Add-ons
    5. Chapter V - For Developers
    6. Chapter VI - Reference Guides
mycred_leaderboard

Codex / mycred/log / Shortcodes / mycred_leaderboard

Description

This shortcode allows you to create leaderboards that are based on either your users current / total balances or based on events in the log, e.g. a leaderboard showing who gained most points from approved comment or published content.

Available since version 1.3

Shortcode Attributes
Attribute Type Required Default Description
number int No 25 The number of users to show in the leaderboard.
order string No DESC Order of the leaderboard. Accepts "DESC" for descending and "ASC" for ascending.
offset int No 0 Option to offset the leaderboard from the first position.
type string No mycred_default The point type to base the leaderboard on. Should not be used if you only have one point type installed.
based_on string No balance Option to base the leaderboard on users balance (balance) or a particular reference. For example basing a leaderboard on who got most points for approved comments.
total int No 0 When showing a leaderboard based on balances, you can select to use users total balance (1) instead of their current balance (0). Added in 1.7.5.
wrap string No li The wrapping element to use for the list. By default the leaderboard renders an organized list (ol) and each item uses a list element (li).
template string No #%position% %user_profile_link% %cred_f% The template used for each row in the leaderboard. Accepts user related template tags and amount related template tags.
nothing string No Leaderboard is empty The message to show users when the leaderboard is empty.
current int No 0 Option to append the current users position to the bottom of the leaderboard if the user is not in the list. Use 1 to show the user or 0 to skip.
exclude_zero int No 1 Option to filter out users with zero balances / results. Use 1 to enable and 0 to disable.
timeframe string No - If the leaderboard is based on references, you can set a timeframe for the leaderboard. Accepts the keywords "today" for todays leaderboard, "this-week" for this weeks leaderboard, "this-month" for this months leaderboard or a well formatted date to start from.
CSS Styling
// Organized list leaderboards
ol.myCRED-leaderboard { }

// First user row
ol.myCRED-leaderboard li.first { }

// Alternating row
ol.myCRED-leaderboard li.alt { }

// If leaderboard is empty
p.mycred-leaderboard-none { }
Examples

Example 1: Show a leaderboard based on balances with the top 10 users.

[mycred_leaderboard number=10]

Example 2: Show bottom 10 users with the lowest balance first.

[mycred_leaderboard number=10 order="ASC"]

Example 3: First show the top 3 users then in a new shortcode we show the next 10 users down the list.

Top 3 Users:
[mycred_leaderboard number=3]

Next 10:
[mycred_leaderboard number=10 offset=3]

Example 4: Show top 3 users without the profile link just showing their display name.

[mycred_leaderboard number=3 template="#%position% %display_name% %cred_f%"]

Example 5: Use HTML in your row template

[mycred_leaderboard number=3]
#%position% <strong>%display_name%</strong>
[/mycred_leaderboard]

Example 6: Instead of an organized list, create a table. (requires myCRED 1.1.2)

<table>
	<thead>
		<tr>
			<th>Position</th>
			<th>Name</th>
			<th>Points</th>
		</tr>
	</thead>
	<tbody>
	[mycred_leaderboard wrap=""]
		<tr>
			<td>%position%</td>
			<td>%display_name%</td>
			<td>%cred_f%</td>
		</tr>
	[/mycred_leaderboard]
	</tbody>
</table>

Example 7: Show a leaderboard for users who have spent most points in your WooCommerce store.

[mycred_leaderboard based_on="woocommerce_payment" order="ASC"]

About myCRED

myCRED is a free, open-source and developer friendly points management tool for WordPress powered websites.

Download Rate Plugin

Documentation

  • Add-ons
  • Core Shortcodes
  • F.A.Q.
  • Tutorials
  • Third Party Plugins
  • Code Snippets

Support

  • Product Licenses
  • Customization
  • Support Forums
  • Plugin Changelog
  • Contact

Copyright 2013 - 2022 byWPExperts; All rights reserved. myCRED is licensed under GPL 2.0

Terms & Conditions • Use of Cookies • Store Policy • Community Rules

Suggest Codex Example

You can submit suggestions for codex examples that you have available as a public gist. If you are a member on the mycred.me website, you can earn Tokens for each submission. To claim these Tokens, make sure you provide your mycred.me username.

Please make sure the example you submit is relevant and if you include documentation, it's provided in English.

logo
  • Membership New
  • Chapters
    • Chapter I – Introduction
    • Chapter II – Getting Started
    • Chapter III – Add-ons
    • Chapter IV – Premium Add-ons
    • Chapter V – For Developers
    • Chapter VI – Reference Guides
  • Categories
    • Actions
    • Classes
    • Constants
    • Filters
    • Functions
    • Objects
    • Shortcodes
    • Hooks
    • Template Tags
  • Packages
    • mycred/api
    • mycred/badge
    • mycred/balance
    • mycred/banking
    • mycred/content
    • mycred/core
    • mycred/coupon
    • mycred/email
    • mycred/game
    • mycred/log
    • mycred/notice
    • mycred/payment
    • mycred/purchase
    • mycred/rank
    • mycred/transfer
  • Store
  • Download