Package: mycred/core

Codex / mycred/core

myCRED_Account

Package: mycred/core Category: Objects

The myCRED_Account object is an “umbrella” object for a particular user, consisting primarily of their balance and history.

Used by the Point for referrals hook, this shortcode will append the current users referral link to a given URL. If no URL is given, the current page’s URL is used.

This action fires when the plugin has been selected to be deleted and myCRED has runs it’s own deletion process. This is the last action run by myCRED.

This action fired when the myCRED plugin is de-activated. Plugins using myCRED should use this action to delete or de-activate custom features.

Checks if a given user should be excluded. These are either users who are in the exclude list or if “Exclude Plugin Editors” or “Exclude Creds Editors” are set to true.

myCRED_Hook

Package: mycred/core Category: Classes

myCRED_Hook is an abstract class used by all myCRED Hooks. It contains commonly used methods to help you build hooks without to much programming.

Description This shortcode will show a users leaderboard position. It will only render the position and nothing more. Replaces the mycred_my_ranking shortcode, which was depreciated as of version 1.7. To show an actual leaderboard, consider using the mycred_leaderboard shortcode instead. Available since version 1.7 Shortcode Attributes Attribute Type Required Default Description user_id int or string [...]

mycred_link

Package: mycred/core Category: Shortcodes

This shortcode allows you to award or deduct points from the current user when their click on the generated link. Outputs a anchor element and calls the mycred-click-link jQuery script.

myCRED_Module

Package: mycred/core Category: Classes

The myCRED_Module is an abstract class used by all myCRED add-ons and core modules. It contains commonly used methods to help you build modules without to much programming.

mycred_send

Package: mycred/core Category: Shortcodes

This shortcode allows the current user to send a pre-set amount of points to a pre-set user. A simpler version of the mycred_transfer shortcode.

myCRED_Settings

Package: mycred/core Category: Classes

This class is the most commonly used and essential class in myCRED. Besides retrieving our settings, this class contain a set of methods which presents, manages, processes actions based on these settings.