Description

This filter allows you to adjust the log entry myCRED adds with each WooCommerce store reward payout.

Available since version 1.0

Parameters
Param Type Required Description
$log_template string Yes

The log template to use.

$order_id int No

The WooCommerce order ID.

$point_type string No

The point type key, representing the point type the user is paid.

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

Example 1: Basic Usage

/**
 * Change Woo Reward Template
 * @version 1.0
 */
function mycred_pro_adjust_woo_reward_log( $log_template, $order_id ) {

	return sprintf( 'Reward for your sore order #%d', $order_id );

}
add_filter( 'mycred_woo_reward_log', 'mycred_pro_adjust_woo_reward_log', 10, 2 );
Description

Used by the central banking service in the Banking add-on, this filter allows you to inform the add-on which references it should ignore. By default, transfers and interest payouts are ignored by the central bank, preventing large number of log entries to be saved with each event.

Available since version 1.5.2

Parameters
Param Type Required Description
$references array Yes

An Array of references that should be ignored by the central bank. Defaults to: interest, recurring_payout and transfer.

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

Example 1: Add the custom reference “gift“ to the list.

function mycred_pro_add_bank_exception( $references ) {

	$references[] = 'gift';
	return $references;

}
add_filter( 'mycred_central_banking_ignore', 'mycred_pro_add_bank_exception' );
Description

This filter allows you to add, replace or remove templates for the Scratch Card add-on.

Available since version 1.0

Parameters
Param Type Required Description
$templates array Yes

An associative array of available templates. You can read more about this in the Scratch Card documentation.

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

Example 1: Add a custom template from a theme.

Example 2: Add a custom template from a plugin.

Description

This filter allows you to adjust the JavaScript variables for the Notifications Plus script. You can use this to make adjustments to the notifications before they are rendered or adjust the add-on settings.

Available since version 1.3.6

Parameters
Param Type Required Description
$args array Yes

Associative array of arguments.

$module obj No

The myCRED Notifications Plus module object.

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

Example 1: Disable front end debugging for administrators.

Description

This hook allows you to reward your users points for making referrals using the AffiliateWP plugin. You can select to reward users for signing up as an affiliate, referring signups on your website or referring WooCommerce store sales.

Available since version 1.6

Known Issues

This hook will not be visible if AffiliateWP is not enabled.

Setup

Make sure you set a point value other than zero for the instances that you want to use. For the store referral instance, please see the guide below.

Store Referrals

When it comes to rewarding store referrals, the hook offers three options:

Set Amount

This is the default option and it will reward / deduct a set amount for all referrals no matter the order amount.

If you have multiple point types setup, you can select to enable this option for any number of types.

Point Stores

If your store has been setup to use points as it’s currency, you can select this option in order to reward a percentage of the order amount to the user that made the referral.

In order to use this option, we must set AffiliateWP to use the same point type that you set your store to use. Before we can do that, we first need to set a unique currency code for our point type. This is the only way that AffiliateWP can display points as a currency. By default the MYC code is used which is not used by any real currency but if you have customized this in your store, you need to add this custom code here as well. For most users this should be left as is.

This option can not be used multiple times! If you have multiple point types setup, this hook can only be enabled for the point type your store is setup to use.

Exchange Rate

If your store is using a real currency and AffiliateWP is setup to use the same currency, you can select this option in order to convert users commissions into their point value using an exchange rate. This exchange rate is then applied to the commission amount and paid out in points.

If you have multiple point types setup and wish to reward more than one type for each commission, you can do so by enabling the hook for all point types you want to pay out. Just make sure they are all set to use this option for store referrals, the exchange rate, log template can of course be different if you want.

Refunds

When a store commission is undone, e.g. the commission’s status is changed from “Paid” to anything else, the hook will undo the payment it made when the commission was originally paid out. If however a commission has not been paid out and is undone, the hook will take no action.

Supported Instances
Instance Reference Description
affiliate_signup Give or take points from users for becoming an affiliate.
affiliate_visit_referral Give or take points from users for referring site visits.
affiliate_referral Give or take points from users for earning a commission in a store sale.
affiliate_referral_refund Give or take points from users for a store sale commission being refunded.
Description

This hook allows you to reward your users for rating content on your website using the WP-PostRatings plugin. You can select to reward the user making the rating or the content author that is receiving the rating.

As of version 1.6 you can select to reward a specific amount or reward the rating amount (1-5).

Available since version 1.5

Known Issues

This hook will not be visible if WP-PostRatings is not enabled.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template. You can select to just reward the user making the rating and/or the post content author for getting their content rated.

Supported Instances
Instance Reference Description
post_rating Give or take points from users for rating content.
post_rating_author Give or take points from content authors for receiving a rating.
Description

This hook allows you to reward your users with points for adding or removing “favorite posts” that are managed by the WP Favorite Posts plugin. You can select to reward the user that adds / removes a post from their Favorites, and/or the post author for getting their post added to someone’s “Favorites”.

Available since version 1.1

Known Issues

This hook will not be visible if WP Favorite Posts is not enabled.

Users can only get points once for each post their add to their favorites. If a user removes the post and adds it again, the hook will not reward further actions.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template.

Supported Instances
Instance Reference Description
add_favorite_post Give or take points from users for adding a post to their "Favorites".
favorited_post Give or take points from post authors that get their posts added to someone's "Favorites".
favorite_post_removed Give or take points from users for removing a post from their "Favorites".
favorite_post_removal Give or take points from post authors that get their posts removed from someone's "Favorites".
Description

This hook allows you to reward your users for posting forum topics and posts using the Simple:Press forum plugin.

Available since version 1.3.3

Known Issues

This hook will not be visible if Simple:Press is not enabled.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template.

Supported Instances
Instance Reference Description
new_forum_topic Give or take points from users for creating a new forum topic.
deleted_topic Give or take points from users for having a forum topic deleted.
new_topic_post Give or take points from users for creating a new forum post.
deleted_topic_post Give or take points from users for having a forum post deleted.
Description

This hook allows you to reward your users for “sharing” your content using the ShareThis plugin.

Due to changes in the ShareThis plugin, myCRED can no longer reward your users with points for actual sharing your content! Instead, you will reward the user clicking on the share link! A user could technically click on the share button to get the option to share to popup but never complete the share process and still get points. Unfortunately ShareThis has been unable to provide a solution to this.

Available since version 1.0

Known Issues

This hook will not be visible if ShareThis is not enabled.

Setup

Make sure you set a point value other than zero for all services you want to use, along with a log entry template.

You should setup the ShareThis plugin BEFORE setting up this plugin in order to see all the services you selected to use.

Supported Instances
Instance Reference Description
share Give or take points from users for sharing something.
Description

This hook allows you to reward your users for subscribing to either comment updates or site updates using the Jetpack plugin.

Available since version 1.0

Known Issues

This hook will not be visible if Jetpack is not enabled. You also require to enable the Subscription module in Jetpack.

Users can only gain points once for each subscription. So if you reward comment subscriptions, a user will not receive points again for subscribing to the same post multiple times. This also applies to site update subscriptions.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template.

Supported Instances
Instance Reference Description
site_subscription Give or take points from users for subscribing to site updates.
comment_subscription Give or take points from users for subscribing to comment updates for a particular post.
Description

This hook allows you to reward your users for sending invites for others to join your website using the Invite Anyone plugin. You can also select to reward your users when someone accepts their invite and signs up.

Available since version 1.4

Known Issues

This hook will not be visible if Invite Anyone is not enabled.

If you are using BuddyPress and require users to verify their account before their signup is completed, no points will be paid out until that verification is completed.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template.

Supported Instances
Instance Reference Description
sending_an_invite Give or take points from users for sending an invite.
accepting_an_invite Give or take points from users when an invite they sent is used and someone signs up.
Description

This hook allows you to reward your users with points for attending events that are managed by the Events Manager plugin. The hook has built-in support for multiple bookings.

Available since version 1.1

Known Issues

This hook will not be visible if Events Manager is not enabled.

If attendance requires approval, points will not be paid out until the booking is approved.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template.

Supported Instances
Instance Reference Description
event_attendance Give or take points from users for attending an event.
cancelled_event_attendance Give or take points from users for attending an event.
event_booking Give or take points from users for attending an event (Multi booking).
Description

This hook allows you to reward your users for earning or losing a BadgeOS achievement. The settings this hook provides serves as your default setup. The amount you set here is what users receive by default. You can however edit each BadgeOS achievement and set a unique point amount and log template for each one.

Available since version 1.0.8

Known Issues

This hook will not be visible if BadgeOS is not enabled.

In order for you to be able to setup points for each unique achievement type / badge, the hook must be enabled. Until this is done, no metabox will be visible.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template. These will be your default settings. You can edit each BadgeOS achievement and set a unique amount and log template for each one.

Supported Instances
Instance Reference Description
badges Give or take points from users for earnings a "Badge".
{$post_type} Give or take points from users for earnings a custom achievement type you have created in BadgeOS.
Description

This hook allows you to reward your users for submitting a form that you created in the GravityForms plugin. The hook will generate a unique set of settings for each form you create, allowing you to reward or deduct a unique amount for each form.

Available since version 1.4

Known Issues

This hook will not be visible if Gravity Forms is not enabled.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template for all forms you want to reward/deduct points for.

Supported Instances
Instance Reference Description
gravity_form_submission Give or take points from users for submitting a form.
Description

This hook allows you to reward your users for submitting a form that you created in the Contact Form 7 plugin. The hook will generate a unique set of settings for each form you create, allowing you to reward or deduct a unique amount for each form.

Available since version 1.0

Known Issues

This hook will not be visible if Contact Form 7 is not enabled.

Setup

Make sure you set a point value other than zero to enable the hook and make sure you have provided a log entry template for all forms you want to reward/deduct points for.

Supported Instances
Instance Reference Description
contact_form_submission Give or take points from users for submitting a form.
Description

This hook allows you to reward your users with points for uploading photos, videos and audio files to your website using the rtMedia plugin.

Available since version 1.4

Known Issues

This hook will not be visible if rtMedia is not enabled.

Setup

Make sure you set a point value for each file type that you want to reward your users for. For those file types that you do not want to reward make sure the value is set to zero. Remember to make sure the log template fields are not empty.

Supported Instances
Instance Reference Description
photo_upload Give or take points from users for photo uploads.
video_upload Give or take points from users for video uploads.
audio_upload Give or take points from users for audio uploads.
photo_deletion Give or take points from users for deleting photos files.
video_deletion Give or take points from users for deleting videos files.
audio_deletion Give or take points from users for deleting audio files.