Hooks are provided by WordPress to allow your plugin to 'hook into' the rest of WordPress; that is, to call functions in your plugin at specific times, and thereby set your plugin in motion. MemberMouse defines its own set of hooks that you can utilize to 'hook into' MemberMouse so you can call functions in your plugin when specific events occur in MemberMouse.

Here's a basic example:

function memberAdded($data)  
{
    // perform action 
}
add_action('mm_member_add', 'memberAdded');

In this example, we're using the add_action() method to indicate that the memberAdded() method should be called when MemberMouse executes a mm_member_add action. To learn more about working with WordPress' Action API read this article.

Below you'll find details on the following categories of hooks:

• MemberMouse Action Reference
• Member Data
• Bundle Data
• Order Data
• Affiliate Data
• Product Data
• Coupon Data
• Proration Data

MemberMouse Action Reference

The following table lists all of the MemberMouse actions, a description of when they're executed and what data will be passed to any function hooked into the action.

Data Attributes by Type

All data is passed to functions as an associative array and can be accessed as follows:

$data["first_name"]
$data["last_name"]
$data["email"]

The sections below list the data attributes available for each type.

Member Data

Bundle Data

Order Data

Affiliate Data

Product Data

Product data is stored as an array of JSON-encoded objects in the order_products attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_products"]);

This sample code assumes that the data was passed to your script in variable called $data. The table below outlines the available parameters for each item in the order_products array.

Coupon Data

Coupon data is stored as an array of JSON-encoded objects in the order_coupons attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_coupons"]);

This sample code assumes that the data was passed to your script in variable called $data. The table below outlines the available parameters for each item in the order_coupons array.

Proration Data

Proration data is stored as an array of JSON-encoded objects in the order_prorations attribute and is included with Order Data and Affiliate Data. Prior to interacting with the array make sure to JSON decode is as follows:

json_decode(stripslashes($data["order_prorations"]);

This sample code assumes that the data was passed to your script in variable called $data. The table below outlines the available parameters for each item in the order_prorations array.