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
    Packages
    Filter by package
    1. mycred/api
    2. mycred/badge
    3. mycred/balance
    4. mycred/banking
    5. mycred/buddypress
    6. mycred/content
    7. mycred/core
    8. mycred/coupon
    9. mycred/email
    10. mycred/game
    11. mycred/hook
    12. mycred/log
    13. mycred/notice
    14. mycred/payment
    15. mycred/purchase
    16. mycred/rank
    17. mycred/stats
    18. mycred/transfer
    19. mycred/twilio
    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
Package: mycred/balance
A compilation of items related to point balances.

Codex / mycred/balance

mycred_addFunction

Adds a given amount of creds to a specific user. Once the users balance has been updated, a new log entry is made under the given reference.

mycred_addFilter

This filter can be used to stop a myCRED point transaction before it is processed.

mycred_add_finishedFilter

This filter is the last filter that runs once a transaction has been processed, no matter of the outcome.

myCRED_BalanceObject

The Balance object consists of the balance values for both the current and total balance along with the point type.

mycred_best_userShortcode

This shortcode allows you to present the “best” user according to their total accumulated balance or by one or more references.

mycred_display_users_balanceFunction

Returns a given users current balance for a specific point type formatted.

mycred_display_users_total_balanceFunction

Returns a given users total balance for a specific point type formatted.

mycred_format_credsFilter

This filter allows you to make adjustments to points before they are rendered on your website.

mycred_format_numberFilter

Adjust how points are formatted before being displayed and before a prefix / suffix is applied.

mycred_get_users_balanceFunction

This function will return a given users current points balance.

mycred_get_users_credFilter

This filter allows you to make adjustments to a users balance as it is retrieved from the database.

mycred_get_users_total_balanceFunction

This function returns a given user’s total point balance for a specific point type.

mycred_label_my_balanceFilter

This filter allows you to change how a users balance is displayed in the toolbar (if used)

mycred_my_balanceShortcode

This shortcode returns the current users myCRED points balance.

mycred_my_balance_convertedShortcode
Description This shortcode will convert the total amount of points your users has gained / lost into specified currency. Available since version 1.8.6 Shortcode Attributes Attribute Type Required Default Description rate string No 1 Insert your conversion rate as per your wish even in decimal points. The Points will be multiplied with the defined figure. [...]
myCRED_Point_TypeObject

This object holds the format and name of a given point type that has been setup in myCRED.

mycred_query_users_totalFunction

This function will query the myCRED log in order to get a given users total balance for a particular point type.

mycred_run_thisFilter

This filter allows you to adjust a request before it is processed by myCRED.

mycred_subtractFunction

This function allows you to decrease a users balance by deducting a specific amount from it.

mycred_total_balanceShortcode

This shortcode will show a users total points balance of either one particular point type or by adding up multiple point types into one total.

mycred_total_pointsShortcode

This shortcode allows you to show the total amount of points currently in circulation or the total amount of points awarded or deducted from your users for a specific instance.

mycred_update_user_balanceAction

This action hook fires each time a users balance is updated.

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