Ganchos para WordPress de MemberMouse

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)
{
    // realizar acción
}
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 leer este artículo.

Categorías de ganchos de WordPress

MemberMouse Referencia de acción

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.

Acción	Descripción	Datos transmitidos
mm_member_add	Esta acción se ejecuta cuando se añade un nuevo miembro a MemberMouse.	datos de los miembros
mm_member_membership_change	This action is executed when a member’s membership level is changed.	datos de los miembros
mm_member_status_change	This action is executed when the status of a member’s account changes.	datos de los miembros
mm_member_account_update	This action is executed when certain data on a member’s account is updated. Esto incluye: nombre, apellidos, dirección de correo electrónico, nombre de usuario, número de teléfono, notas, dirección de facturación, dirección de envío, método de cálculo de días como afiliado y datos de campos personalizados.	datos de los miembros
mm_member_delete	This action is executed when a member’s account is deleted.	datos de los miembros
mm_bundles_add	This action is executed when a bundle is added to a member’s account.	datos de los miembros, datos del paquete
mm_bundles_status_change	This action is executed when the status of a bundle changes on a member’s account.	datos de los miembros, datos del paquete
mm_producto_compra	Esta acción se ejecuta cuando se envía un pedido, antes de su validación y pago.	datos de los miembros, datos del pedido
mm_compra_completa	Esta acción se ejecuta cuando se completa una compra. Está disponible en MemberMouse 3.0.6 y versiones posteriores.	datos de los miembros, datos del pedido
mm_pago_recibido	Esta acción se ejecuta cuando se recibe un pago.	datos de los miembros, datos del pedido
mm_payment_rebill	Esta acción se ejecuta cuando se recibe un pago de refacturación.	datos de los miembros, datos del pedido
mm_payment_rebill_declined	Esta acción se ejecuta cuando se rechaza un pago de refacturación.	datos de los miembros, datos del pedido
mm_reembolso_emitido	Esta acción se ejecuta cuando se emite una devolución.	datos de los miembros, datos del pedido
mm_commission_initial	Esta acción se ejecuta cuando se debe realizar el seguimiento de una comisión de afiliación inicial.	datos de afiliación
mm_commission_rebill	Esta acción se ejecuta cuando se debe realizar el seguimiento de una comisión de afiliado refacturada.	datos de afiliación
mm_commission_cancel	Esta acción se ejecuta cuando una comisión de afiliado debe ser cancelada.	datos de afiliación

Atributos de datos por tipo

Todos los datos se pasan a las funciones como una matriz asociativa y se puede acceder a ellos de la siguiente manera:

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

En las secciones siguientes se enumeran los atributos de datos disponibles para cada tipo.

Datos de los miembros

Atributo	Descripción
member_id	El ID asignado al miembro por MemberMouse.
registrado	La fecha en que el afiliado se registró en el formato AAAA-MM-DD HH:MM:SS.
last_logged_in	La fecha en que el miembro se conectó por última vez en el formato AAAA-MM-DD HH:MM:SS.
última_actualización	The date the member’s account was last updated in the format YYYY-MM-DD HH:MM:SS.
días_como_miembro	El número de días que el miembro ha sido miembro.
estado	The status of the member’s account as an integer: 1 = active, 2 = canceled, 3 = locked, 4 = paused, 5 = overdue, 6 = pending activation, 7 = error, 8 = expired, 9 = pending cancellation
nombre_estado	The status of the member’s account as a string (i.e. activo, canceladoetc.).
is_complimentary	This indicates if the member’s account is complimentary or not. It will be set to ‘true’ if the account is complimentary and ‘false’ if not.
nivel_de_afiliación	The ID of the membership level associated with the member’s account.
nombre_nivel_socio	The name of the membership level associated with the member’s account.
nombre	The member’s first name.
apellido	The member’s last name.
nombre de usuario	The member’s username.
correo electrónico	The member’s email address.
teléfono	The member’s phone number.
cf_#	Outputs the member’s value for the custom field with ID #. For example, if the ID of the custom field that stores birthday is 4 then to output the member’s birthday you would use ‘cf_4’.
dirección_facturación	The member’s billing address.
ciudad_facturación	The member’s billing city.
estado_de_facturación	The member’s billing state.
código_zip_facturación	The member’s billing zip code.
país_de_facturación	The member’s billing country.
dirección_de_envío	The member’s shipping address.
ciudad_de_envío	The member’s shipping city.
estado_de_envío	The member’s shipping state.
código_zip_de_envío	The member’s shipping zip code.
país_de_envío	The member’s shipping country.

Datos del paquete

Atributo	Descripción
bundle_id	ID del paquete.
nombre_paquete	El nombre del paquete.
días_con_paquete	The number of days the bundle has been active on the member’s account.
bundle_status	Estado del paquete: 1 = activo, 2 = cancelado, 3 = bloqueado, 4 = en pausa, 5 = vencido, 6 = pendiente de activación, 7 = error, 8 = vencido, 9 = pendiente de cancelación.
bundle_is_complimentary	This indicates if the bundle is complimentary or not. It will be set to ‘true’ if the bundle is complimentary and ‘false’ if not.
nombre_estado_paquete	El estado del paquete como una cadena (es decir. activo, canceladoetc.).
bundle_date_added	The date the bundle was added to the member’s account in the format YYYY-MM-DD HH:MM:SS.
bundle_last_updated	The date the bundle was last updated on the member’s account in the format YYYY-MM-DD HH:MM:SS.

Datos del pedido

Atributo	Descripción
número_pedido	El número de referencia asignado al pedido por MemberMouse.
order_transaction_id	The transaction ID associated with the order. This can be used as a unique ID for all payments associated with an order. When a customer purchases a subscription, each rebill payment is part of the same order so they’ll all share the same order ID. Each rebill payment will have a unique transaction ID.
total_pedido	El total del pedido que es igual a (subtotal - descuento) + gastos de envío.
subtotal_pedido	El subtotal del pedido.
descuento_pedido	El descuento aplicado al pedido.
pedido_envío	Gastos de envío aplicados al pedido.
método_envío_pedido	El nombre del método de envío elegido por el cliente al realizar el pago.
dirección_facturación_pedido	La dirección de facturación asociada al pedido.
order_billing_city	La ciudad de facturación asociada al pedido.
order_billing_state	El estado de facturación asociado al pedido.
order_billing_zip_code	El código postal de facturación asociado al pedido.
order_billing_country	El país de facturación asociado al pedido.
dirección_envío_pedido	La dirección de envío asociada al pedido.
ciudad_envío_pedido	La ciudad de envío asociada al pedido.
estado_envío_pedido	El estado de envío asociado al pedido.
código_zip_envío_pedido	El código postal de envío asociado al pedido.
país_envío_pedido	El país de envío asociado al pedido.
productos_pedidos	Matriz de productos asociados al pedido. Consulte el Datos del producto tabla siguiente para conocer los parámetros disponibles para cada producto.
pedir_cupones	Una matriz de cupones asociados al pedido. Consulte el Datos del cupón tabla siguiente para conocer los parámetros disponibles para cada cupón.
precios_pedidos	Matriz de prorrateos asociados a la orden. Véase el Datos de prorrateo tabla siguiente para conocer los parámetros disponibles para cada elemento de prorrateo.
ID_afiliado_pedido	El ID de afiliado asociado a la orden.
order_subaffiliate_id	El ID de subfilial asociado a la orden.
dirección_ip_pedido	La dirección IP asociada a la orden.

Datos de afiliación

Atributo	Descripción
ID_afiliado_pedido	El ID de afiliado asociado a la orden.
order_subaffiliate_id	El ID de subfilial asociado a la orden.
member_id	El ID asignado al miembro por MemberMouse.
número_pedido	El número único asociado al pedido concatenado con el ID de transacción asociado al pago (es decir, 1456-3462). Esto garantiza que el número de pedido proporcionado aquí sea único en todas las transacciones de refacturación asociadas al pedido.
total_pedido	El total del pedido disponible para comisiones, que es igual al total del pedido menos los descuentos y los gastos de envío.
dirección_ip_pedido	La dirección IP asociada a la orden.
productos_pedidos	Matriz de productos asociados al pedido. Consulte el Datos del producto tabla siguiente para conocer los parámetros disponibles para cada producto.
pedir_cupones	Una matriz de cupones asociados al pedido. Consulte el Datos del cupón tabla siguiente para conocer los parámetros disponibles para cada cupón.
precios_pedidos	Matriz de prorrateos asociados a la orden. Véase el Datos de prorrateo tabla siguiente para conocer los parámetros disponibles para cada elemento de prorrateo.
rebill_commission_flat_rate	This will only be included on commission rebill events. Based on the commission profile applied to the order, this indicates if there’s a flat rate commission override that should be taken into account.
rebill_commission_percent	This will only be included on commission rebill events. Based on the commission profile applied to the order, this indicates if there’s a percentage commission override that should be taken into account.

Datos del producto

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.

Atributo	Descripción
id	El ID del producto.
nombre	El nombre del producto.
sku	La SKU del producto.
importe	El importe pagado por cada unidad del producto.
cantidad	El número de este producto comprado.
total	El precio total pagado equivale al importe * cantidad.
is_recurring	Indicates where this product has a subscription associated with it or not. Possible values are ‘true’ or ‘false’.
importe_recurrente	El importe pagado en cada periodo de facturación.
período_facturación	Un número entero que representa la duración del periodo de facturación. Para determinar la duración completa del periodo de facturación, combínelo con rebill_frequency (es decir, 1 mes, 30 días, 2 semanas, etc.).
frecuencia_de_facturación	Cadena que indica la unidad de medida utilizada para el periodo de facturación. Los valores posibles son días, semanas, meses o años.

Datos del cupón

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["cupones_pedido"]);

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.

Atributo	Descripción
id	ID del cupón.
nombre	El nombre del cupón.
código	El código del cupón.

Datos de prorrateo

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.

Atributo	Descripción
importe	Importe del prorrateo.
descripción	La descripción asociada a la compra.