A free points management plugin for WordPress.
myCRED Logo
myCRED Logo
  • 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
Chapter I
Introduction
  1. The Plugin
  2. Points
  3. The Log
  4. Administration
  5. Automatic Points
  6. Multisites
    • Master Template
    • Central Logging
  7. Add-ons
  8. Supported Plugins
  9. BuddyPress
  10. Usage Examples
  11. Limitations
Chapter II
Getting Started
  1. Installation
  2. Point Type Settings
  3. Multiple Point Types
  4. Adjusting Balances
  5. Setup Hooks
  6. Import Data
    • Importing Balances
    • Importing Log Entries
    • Import CubePoints
  7. Export Data
  8. Widgets
  9. Shortcodes
  10. Optimization
  11. Uninstall
Chapter III
Add-ons
  1. Badges
    • Creating Badges
    • Manual Badges
    • Displaying Badges
    • Developer Resources
  2. Banking
    • Central Banking
    • Compound Interest
    • Recurring Payout
    • Developer Resources
  3. buyCRED
    • Selling Points
    • Add-on Setup
    • Payment Gateways
    • The Checkout Page
    • Pending Payments
    • Developer Resources
  4. Coupons
    • Creating Coupons
    • Redeeming Coupons
    • Coupon Management
    • Developer Resources
  5. Email Notifications
    • Add-on Setup
    • Creating Emails
    • Unsubscribe
    • Developer Resources
  6. Gateway
    • WooCommerce
    • WP E-Commerce
    • Event Espresso
    • Events Manager
    • Developer Resources
  7. Notifications
    • Troubleshooting
    • Developer Resources
  8. Ranks
    • Introduction
    • Add-on Setup
    • Create New Rank
    • Displaying Ranks
    • Developer Resources
  9. Sell Content
    • Add-on Setup
    • Manual Mode
    • Available Shortcodes
    • Troubleshooting
    • Developer Resources
  10. Statistics
  11. Transfers
    • Add-on Setup
    • Available Shortcodes
    • Transfer Messages
    • Transfer Types
    • Developer Resources
Chapter IV
Premium Add-ons
  1. ProgressBar
    • mycred_badges_progress
    • mycred_my_ranks_progress
  2. The myCRED Store
  3. buyCRED Gateways
    • Stripe
    • Payza
    • Wepay
    • PayFast
    • 2checkout
    • Coinbase
    • ComproPago
    • Paymentwall
    • Robokassa
    • CoinPayments
  4. Third-party Bridges
    • myCRED for WPBakery Page Builder
    • myCRED for UserPro
    • myCRED for Users Ultra
  5. Games
    • myCred Learndash
    • Fortune Wheel Addon
    • Lottery Add-on
    • Scratch Cards Add-on
    • Custom Set for Scratch Card Add-on
  6. Enhancements
    • Notifications Plus
    • Transfer Plus
    • Twilio Transfers
    • Video Add-on
    • Video Add-on for JW Player
    • BuddyPress Charges
    • Partial Payments – WooCommerce
  7. Store Gateways
    • Jigoshop
    • Easy Digital Downloads
    • WPMUDEV Fundraising
  8. Freebies
    • BP Group Leaderboards
      • Plugin Setup
      • Caching
      • Leaderboard Customizations
      • Custom Leaderboard Types
    • myCRED for Events Manager Pro
Chapter V
For Developers
  1. Introduction
  2. White Labeling
  3. Flowcharts
  4. Playing with Balances
  5. myCRED Objects
  6. Log API
  7. Hook API
  8. Module API
  9. Gateway API
  10. Remote API
    • Version 1.0
    • Version 2.0
  11. Front-end Encryption
Chapter VI
Reference Guides
  1. Log References
  2. Shortcodes
  3. Template Tags
  4. Globals
  5. Constants
  6. Actions
  7. Filters
  8. Objects
  9. Functions
  10. Classes
Plugin Setup

Once the plugin is installed and enabled, you will need to go through and save your desired setup. To do this, you need to go to your BuddyPress Settings page in your wp-admin area. Here you will find a new “Leaderboard” tab which will take you to the plugins settings page.

Default Setup

There is two ways the plugin can operate. You can either enforce one setup on all groups or let your BuddyPress Group admins setup leaderboards themselves. In either case, you are required to set a default setup.

This includes what point type or types to create leaderboards for, the size of the leaderboard, the option to append the current user and the leaderboard type (as of version 1.1).

Sizes

The size of the leaderboard refers to the number of users to include in the leaderboard. The larger the size, the more resources will be required in order to query the leaderboard. For this reason, the plugin, by default has a limit of maximum 50 users being shown in a leaderboard. You can change this using the MYCRED_BP_GROUP_LEAD_MAX_SIZE constant.

Appending Users

If the user viewing the leaderboard is not in the size you set, you can select to append them to the end with their position.

This will only be applicable to those who are a member of the group, are logged in and are not excluded from the point type the leaderboard is based on.

Leaderboard Types

As of version 1.1 you can select what type of leaderboard you want to generate. The plugin supports 6 different types of leaderboards:

Leaderboard Based on Current Balance (default)

This is what previous versions were offering and is based on members current balance.

Leaderboard Based on Total Balance

This will generate a leaderboard based on a users total balance. Total balances are calculated by adding up all point gains a user has then deducting any manual adjustments an admin might have made.

Leaderboard Based on Today's Gains

This will generate a leaderboard based on members total accumulated points today. This is done by adding up all point gains and losses from the beginning of each day until now.

Leaderboard Based on This Week's Gains

This will generate a leaderboard based on members total accumulated points this week. This is done by adding up all point gains and losses from the the start of each week until now. Resets each week.

Leaderboard Based on This Months' Gains

This will generate a leaderboard based on members total accumulated points this month. This is done by adding up all point gains and losses from the start of each month until now.

Leaderboard Based on Date Range

This option allows a leaderboard creation between two dates. When this option is selected, two hidden fields will become available where you can set the start and end date. These dates must be well formatted either YYYY-MM-DD or MM/DD/YYYY.

Override

Once you have selected the leaderboard type, you need to decide if these settings should be applicable to all groups or if you want to let admins create their own setups.

If admins are allowed to setup their own leaderboards, they will be able to do this in their Groups admin area in BuddyPress.

The Menu

Finally we need to setup the BuddyPress navigation. This includes the title shown in the menu, the URL slug for the leaderboard page and the menu position. The URL slug must be unique to prevent conflicts with other BuddyPress group pages!

Remember to always save!

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 - 2019 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.

  • 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