Constructs and returns the myCRED_Settings object based on a given point type.
Package: mycred/core
A compilation of core plugin functions.
Codex / mycred/core
The myCRED_Account object is an “umbrella” object for a particular user, consisting primarily of their balance and history.
This action indicates the instance where myCRED has finished registering all the wp-admin screens.
A wrapper function for add_user_meta, it assures that point related data is saved under the correct meta key structure.
This action indicates the instance where myCRED has enqueued all scripts and styling in the admin area.
This action indicates the instance where myCRED has finished running tasks when the wp-admin area is initiated.
This filter allows you to change the lifespan of the cookies your users receive from the “Points for referrals” hook.
Used by the Point for referrals hook, this shortcode will return the current logged in users referral ID.
This filter allows you to adjust the referral key that the myCRED hook uses.
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 indicates the instance when the myCRED plugin has been deleted.
This filter allows you to change the results of the apply_exchange() class method in the myCRED_Settings object.
This action indicates the instance when the myCRED plugin is about to be deleted.
This function checks if the central log feature is enabled on a Multisite installation.
This function will convert a well formatted date to a GMT unix timestamp.
This action indicates the instance when the myCRED plugin has been disabled.
A wrapper function for delete_user_meta, it assures that point related data is deleted under the correct meta key structure.
This shortcode allows your users to exchange one point type for another based on an exchange rate that you set.
Checks if a given user is excluded from using a particular point type.
This filter allows you to exclude users from using myCRED via script.
This filter allows you to adjust what columns should be included when myCRED log entries are exported.
Wrapper function for wp_cache_delete for deleting widget caches. Used when myCRED widget settings are saved.
This function is used throughout myCRED to prevent users from attempting to submit AJAX forms multiple times.
This action indicates the instance when scripts and styles needs to be enqueued for the front end of your website.
Retrieves a given users myCRED_Account object.
This function will return a specific myCRED Module object.
This function returns a specific point type’s given name in singular or plural form.
This function returns the Remove API (version 1.0) settings.
This function returns the network settings on a Multisite installation.
This function will attempt to return a user ID based on either an identifying piece of information (email, login or slug) or based on keywords.
This function will return a given users profile URL based on your websites setup.
This shortcode allows you to award or deduct points from the current user when this shortcode is executed.
This filter controls if the mycred_give shortcode should run or not. It can be used to either disable this shortcode or to limit when or by whom it can be used.
This shortcode allows you to hide parts of your content for those who fulfil the requirements you set.
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.
Show your users how they can earn points based on how you setup your hooks.
This action indicates the instance where myCRED is ready to run it’s initial actions.
This function checks if a specific user is to be considered an “administrator”.
This filter allows you to change the value of the MYCRED_DEFAULT_LABEL constant, re-naming the myCRED plugin.
This function returns the myCRED label.
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.
This filter allows you to adjust the anchor element the mycred_link shortcode renders.
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.
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. NavigationmyCRED Home About Add-ons Support Store Showcase Usage in content [mycred_my_ranking] Usage in theme files echo [...]
This function checks if the master template feature is enabled on a Multisite installation.
This action fires once myCRED is ready after that modules have been loaded but before the init action.
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 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.
This filter lets you change the language used for the button in the mycred_send shortcode.
This action allows you to execute custom actions when a users balance is changed to a specific amount.
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.
This filter allows you to register your own add-ons or remove/disable existing add-ons.
This filter allows you to add custom hooks or remove built-in ones.
This shortcode allows you to show parts of your content for those who fulfil the requirements you set.
This action fires directly after myCRED has setup the WordPress Toolbar items.
This filter allows you to remove or add custom action links when viewing your users point balance on the Users page.
This filter allows you to adjust what URL the %user_profile_url% and the %user_profile_link% template tags point to.
With this shortcode you can embed YouTube videos in your content and award points to users who views them. Added in 1.2
This filter allows you to adjust the video embed that is generated by the mycred_video add-on.
This filter allows you to make changes to the youtube video query.
This action fires once myCRED has loaded and registered all widgets.
