Navigation:

  1. Description
  2. Add-ons

Description

This template tag returns the rank image that the user has achieved.

Add-ons

This template tag can be used with the following add-ons:

Navigation:

  1. Description
  2. Add-ons

Description

This template tag returns the rank title that the user has awarded.

Add-ons

This template tag can be used with the following add-ons:

Navigation:

  1. Description
  2. Add-ons

Description

This template tag returns the badge image that the user has achieved.

Add-ons

This template tag can be used with the following add-ons:

Navigation:

  1. Description
  2. Add-ons

Description

This template tag returns the badge title that the user has awarded.

Add-ons

This template tag can be used with the following add-ons:

Navigation:

  1. Description
  2. Add-ons

Description

This template tag returns the amount that the user has determined to settings.

Add-ons

This template tag can be used with the following add-on:

Navigation:

  1. Description
  2. Hook

Description

This template tag returns the amount that the user has determined to settings.

Hook

This template tag can be used with the referral hook:

Requires the “Points for referrals” hook to be enabled.

Description

The mycred_referral_stats shortcode is associated with the referral hook which displays the total count of referred visitors/sign ups users.

Example

Example 1:

Copy and paste the following URL:
[mycred_referral_stats]
Description

This shortcode will generate cashCred’s payment form on the front-end. The following shortcode attributes allow the admin to add payment gateway(s), point types(s), and messages for insufficient funds and excluded users.

Requires the Cashcred add-on to be enabled.

Available since version 2.0

Shortcode Attributes

Their are 6 attributes are available in the mycred_cahcred shortcode:

Attribute Type Required Default Description
button String No Submit Request Button text
gateways string No - The payment gateways to use allow multiple with comma separated
types string No - Allowed point types allow multiple with comma separated values
excluded string No You have excluded from this point type. Message for excluded users
insufficient string No Insufficient Points for Withdrawal. Message for insufficient balance
Examples

Example 1:

[mycred_cashcred]
Description

This shortcode allows you to display all published badges that have ever existed on your website and define them under their respective achievement types.

We have includes a badge search functionality that allows any user to run a unique search on all published badges.

Requires the Badge add-on to be enabled.

Available since version 2.1

Shortcode Attributes
Attribute Type Required Default Description
achievement_tabs int No 1 Select (1) to enable or (0) to disable the achievement tabs.
Example

Example 1: Default usage.

[mycred_badges_list]

Shortcode Description

This shortcode allows you to show a given users or the current users position in a particular leaderboard. Nothing will be returned if the user viewing the shortcode is not logged in.

Requirements

  • myCRED 1.4 or higher.

Usage in content

[mycred_my_ranking]

Usage in theme files

echo do_shortcode( '[mycred_my_ranking]' );

Shortcode Attributes

Attribute Type Default Required
user_id ( int ) current user no
Option to show a particular users leaderboard position. Will default to the current users ID if not set.
Attribute Type Default Required
ctype ( string ) mycred_default no
The point type in question for the leaderboard.
Attribute Type Default Required
based_on ( string ) balance no
Option to set what the leaderboard is based on in order to get the users position. This can either be their current balance (balance) or a reference.
Attribute Type Default Required
missing ( int|string) 0 no
Option to set what to return when a user does not have a position in the leaderboard.

CSS Styling

This shortcode does not render any style-able elements.

Examples

Example 1: Get the current users position in a leaderboard based on most points gained for approved comments.

[mycred_my_ranking based_on="approved_comment"]

Example 2: Get the current users leaderboard position for the custom point type “cointype”.

[mycred_my_ranking ctype="cointype"]
Description

This hooks allows you to reward points to referrers and referred users on successful purchase of WooCommerce referred Products. Instantly generate and share referral link on any networking platform.
Download – myCred WooCommerce Plus

Known Issues

This hook works with WooCoomerce Plugin.

It will not be available if myCred WooCommerce plus is not activated.

Points will be awarded on the first purchase. If a same user again buys the same product points will not be rewarded.

If the referral cookie expires points will not be awarded on product purchase.

Setup

Make sure to enable the Hooks from myCred Hooks. Set the point value other than zero, you can also define the log entry template. Points can also be awarded to referee. Enable the Cookie setting from WooCommerce ➜ Settings ➜ myCred ➜ Product Referral Cookie.

Supported Instances
Instance Reference Description
Product_referral Award points on WooCommerce product referral.
Description

This Hook rewards Points annually. After signing up user will be rewarded with points for being a member for each year.

Setup

You need to set the Points to be rewarded in the Hooks section. In the Hooks there you will find a Hook named Points for Anniversary. There you will find to set the Points and the template for creating log.

anniversary Hook myCred
  1. Click on the Points.
  2. Under Points you will find a Hook tab.
  3. Drag Points for Anniversary tab from left to right side to get activated.
  4. There you go for settings for Points for Anniversary Hooks.
Support Instances
Instance Reference Description
anniversary Points for being a member for year
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.
ctype string No mycred_default The point type we want to show data for. Should only be used when you need to show data for a custom point type.
prefix string No - Place any text/sign (e.g; $) before the converted figure.
suffix string No - Place any text/sign (e.g; $) after the converted figure.
decimal integer No 1 Show result with xx number of decimal places.
Example

Example 1: Default usage.

[mycred_my_balance_converted]
Description

This custom shortcode allows you to show a progress bar for your users current rank. You can select the colors to use, if the progress bar should be animated and to show the minimum and maximum rank requirement for the users current rank under the progress bar.

Requires the Ranks add-on to be enabled with premium mycred progress bar addon

Available since version 1.8

Shortcode Attributes
Attribute Type Required Default Description
user_id int No - Option to show the rank progress of a particular user instead of the user viewing the shortcode.
title int No 0 Option to insert a rank title above the progress bar.
ctype string No mycred_default The point type to show the rank progress for. Should not be used if you only have one point type installed.
animate int No 1 Select to enable (1) or disable (0) the progress bar animation. Note that if a user has reached 100%, the animation will be disabled.
bgcolor string No - You can use color name as well custom color code e.g #333
show_rank_title int No 1 Option to show (1) or hide (0) the users current rank title inside the progress bar.
show_logo int No 1 Option to show (1) or hide (0) show rank logo.
show_labels int No 0 Option to insert the users rank’s minimum and maximum point requirements under the progress bar. To show use 1 or 0 to hide.
logo_size STRING No post-thumbnail The logo size (if set to be shown). accepts "post-thumbnail" for thumbnail size, "full" for full size.
first STRING No logo Option to show title first (title) or the logo (logo) first.
type STRING No bar bar and radial type of progress you want to show on front end e.g radial,bar.
prefix_min STRING No MIN Prefix for min requirment of rank.
prefix_max STRING No MAX Prefix for max requirment of rank.
rank_id int No - Option to show progress towards a specific rank instead of the users current rank.
Example

Example 1: Default usage.

[mycred_my_ranks_progress]
Description

This custom shortcode allows you to show a progress bar for your badges  for current user . You can select the colors to use, if the progress bar should be animated and also there is individual progressbar for badge  requirement for the users current badge under the progress bar. You can also manually give badge id to render specific badge progress.

Requires the Badge add-on to be enabled.

Available since version 1.8

Shortcode Attributes
Attribute Type Required Default Description
width int No MYCRED_BADGE_WIDTH The badge image width to use.
height int No MYCRED_BADGE_HEIGHT The badge image height to use.
show_badge int No - Use when you want to render single or specific badge progress.
animate int No 1 Select to enable (1) or disable (0) the progress bar animation. Note that if a user has reached 100%, the animation will be disabled.
bgcolor string No - You can use color name as well custom color code e.g #333
type STRING No bar Bar and Radial type of progress you want to show on front end e.g radial,bar.
Stripe int No 1 Option to show (1) or hide (0) show stripe layer on progress.
Example

Example 1: Default usage.

[mycred_badges_progress]
Description

By default, a scratch card set must consist of cards that represents a “win” and cards that represents “no wins”. This filter can be used to change this and create sets where all cards are winners. Without this filter, if you attempt to create zero “No Win” cards, the set will decline your request when you save.

Available since version 1.2

Parameters
Param Type Required Description
$allow bool Yes

TRUE to allow or FALSE. Defaults to FALSE.

$set_id int No

The card sets WordPress post ID.

Used By
Package Prio. Description
Not used by any built-in package.
Example

Example 1: Enable all cards to be winning cards.

add_filter( 'mycred_scratch_everyonewins', '__return_true' );