fbpx

Ganchos para WordPress de MemberMouse

Los ganchos son proporcionados por WordPress para permitir que su plugin se 'enganche' al resto de WordPress; es decir, para llamar a funciones de su plugin en momentos específicos, y así poner en marcha su plugin. MemberMouse define su propio conjunto de ganchos que puede utilizar para 'engancharse' a MemberMouse y así poder llamar a funciones de su plugin cuando se produzcan eventos específicos en MemberMouse.

He aquí un ejemplo básico:

function memberAdded($data)
{
    // realizar acción
}
add_action('mm_member_add', 'memberAdded');

En este ejemplo, utilizamos el botón 'add_action()para indicar que el método 'memberAdded()' debe ser llamado cuando MemberMouse ejecute una acción 'mm_member_add'. Para saber más sobre cómo trabajar con la API de acciones de WordPress leer este artículo.

Categorías de ganchos de WordPress
MemberMouse Referencia de acción

La siguiente tabla enumera todas las acciones de MemberMouse, una descripción de cuándo se ejecutan y qué datos se pasarán a cualquier función enganchada a la acción.

AcciónDescripciónDatos transmitidos
mm_member_addEsta acción se ejecuta cuando se añade un nuevo miembro a MemberMouse.datos de los miembros
mm_member_membership_changeEsta acción se ejecuta cuando se cambia el nivel de afiliación de un miembro.datos de los miembros
mm_member_status_changeEsta acción se ejecuta cuando cambia el estado de la cuenta de un afiliado.datos de los miembros
mm_member_account_updateEsta acción se ejecuta cuando se actualizan determinados datos de la cuenta de un afiliado.
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_deleteEsta acción se ejecuta cuando se elimina la cuenta de un miembro.datos de los miembros
mm_bundles_addEsta acción se ejecuta cuando se añade un paquete a la cuenta de un miembro.datos de los miembrosdatos del paquete
mm_bundles_status_changeEsta acción se ejecuta cuando cambia el estado de un paquete en la cuenta de un miembro.datos de los miembrosdatos del paquete
mm_producto_compraEsta acción se ejecuta cuando se envía una orden datos de los miembrosdatos del pedido
mm_pago_recibidoEsta acción se ejecuta cuando se recibe un pago.datos de los miembrosdatos del pedido
mm_payment_rebillEsta acción se ejecuta cuando se recibe un pago de refacturación.datos de los miembrosdatos del pedido
mm_payment_rebill_declinedEsta acción se ejecuta cuando se rechaza un pago de refacturación.datos de los miembrosdatos del pedido
mm_reembolso_emitidoEsta acción se ejecuta cuando se emite una devolución.datos de los miembrosdatos del pedido
mm_commission_initialEsta acción se ejecuta cuando se debe realizar el seguimiento de una comisión de afiliación inicial.datos de afiliación
mm_commission_rebillEsta acción se ejecuta cuando se debe realizar el seguimiento de una comisión de afiliado refacturada.datos de afiliación
mm_commission_cancelEsta 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
AtributoDescripción
member_idEl ID asignado al miembro por MemberMouse.
registradoLa fecha en que el afiliado se registró en el formato AAAA-MM-DD HH:MM:SS.
last_logged_inLa fecha en que el miembro se conectó por última vez en el formato AAAA-MM-DD HH:MM:SS.
última_actualizaciónLa fecha en que se actualizó por última vez la cuenta del miembro en el formato AAAA-MM-DD HH:MM:SS.
días_como_miembroEl número de días que el miembro ha sido miembro.
estadoEl estado de la cuenta del miembro como un número entero: 1 = activa, 2 = cancelada, 3 = bloqueada, 4 = en pausa, 5 = vencida, 6 = pendiente de activación, 7 = error, 8 = caducada, 9 = pendiente de cancelación.
nombre_estadoEl estado de la cuenta del miembro como una cadena (es decir. activocanceladoetc.).
is_complimentaryIndica si la cuenta del usuario es gratuita o no. Será 'true' si la cuenta es de cortesía y 'false' si no lo es.
nivel_de_afiliaciónID del nivel de afiliación asociado a la cuenta del afiliado.
nombre_nivel_socioNombre del nivel de afiliación asociado a la cuenta del afiliado.
nombreNombre de pila del afiliado.
apellidoApellido del afiliado.
nombre de usuarioEl nombre de usuario del miembro.
correo electrónicoDirección de correo electrónico del afiliado.
teléfonoEl número de teléfono del afiliado.
cf_#Muestra el valor del campo personalizado con ID #. Por ejemplo, si el ID del campo personalizado que almacena la fecha de nacimiento es 4, para mostrar la fecha de nacimiento del usuario se utilizará "cf_4".
dirección_facturaciónDirección de facturación del afiliado.
ciudad_facturaciónLa ciudad de facturación del socio.
estado_de_facturaciónEstado de facturación del afiliado.
código_zip_facturaciónEl código postal de facturación del afiliado.
país_de_facturaciónPaís de facturación del afiliado.
dirección_de_envíoDirección de envío del afiliado.
ciudad_de_envíoLa ciudad de envío del miembro.
estado_de_envíoEstado de envío del afiliado.
código_zip_de_envíoEl código postal de envío del afiliado.
país_de_envíoPaís de envío del afiliado.
Datos del paquete
AtributoDescripción
bundle_idID del paquete.
nombre_paqueteEl nombre del paquete.
días_con_paqueteEl número de días que el paquete ha estado activo en la cuenta del miembro.
bundle_statusEstado 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_complimentaryIndica si el paquete es complementario o no. Será "true" si el paquete es complementario y "false" si no lo es.
nombre_estado_paqueteEl estado del paquete como una cadena (es decir. activocanceladoetc.).
bundle_date_addedLa fecha en que el paquete se añadió a la cuenta del miembro en el formato AAAA-MM-DD HH:MM:SS.
bundle_last_updatedLa fecha en que el paquete se actualizó por última vez en la cuenta del miembro en el formato AAAA-MM-DD HH:MM:SS.
Datos del pedido
AtributoDescripción
número_pedidoEl número de referencia asignado al pedido por MemberMouse.
order_transaction_idEl ID de transacción asociado a la orden. Puede utilizarse como ID único para todos los pagos asociados a un pedido. Cuando un cliente adquiere una suscripción, cada pago de refacturación forma parte del mismo pedido, por lo que todos compartirán el mismo ID de pedido. Cada pago de refacturación tendrá un ID de transacción único.
total_pedidoEl total del pedido que es igual a (subtotal - descuento) + gastos de envío.
subtotal_pedidoEl subtotal del pedido.
descuento_pedidoEl descuento aplicado al pedido.
pedido_envíoGastos de envío aplicados al pedido.
método_envío_pedidoEl nombre del método de envío elegido por el cliente al realizar el pago.
dirección_facturación_pedidoLa dirección de facturación asociada al pedido.
order_billing_cityLa ciudad de facturación asociada al pedido.
order_billing_stateEl estado de facturación asociado al pedido.
order_billing_zip_codeEl código postal de facturación asociado al pedido.
order_billing_countryEl país de facturación asociado al pedido.
dirección_envío_pedidoLa dirección de envío asociada al pedido.
ciudad_envío_pedidoLa ciudad de envío asociada al pedido.
estado_envío_pedidoEl estado de envío asociado al pedido.
código_zip_envío_pedidoEl código postal de envío asociado al pedido.
país_envío_pedidoEl país de envío asociado al pedido.
productos_pedidosMatriz de productos asociados al pedido. Consulte el Datos del producto tabla siguiente para conocer los parámetros disponibles para cada producto.
pedir_cuponesUna 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_pedidosMatriz 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_pedidoEl ID de afiliado asociado a la orden.
order_subaffiliate_idEl ID de subfilial asociado a la orden.
dirección_ip_pedidoLa dirección IP asociada a la orden.
Datos de afiliación
AtributoDescripción
ID_afiliado_pedidoEl ID de afiliado asociado a la orden.
order_subaffiliate_idEl ID de subfilial asociado a la orden.
member_idEl ID asignado al miembro por MemberMouse.
número_pedidoEl 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_pedidoEl 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_pedidoLa dirección IP asociada a la orden.
productos_pedidosMatriz de productos asociados al pedido. Consulte el Datos del producto tabla siguiente para conocer los parámetros disponibles para cada producto.
pedir_cuponesUna 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_pedidosMatriz 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_rateEsto sólo se incluirá en los eventos de refacturación de comisiones. Basándose en el perfil de comisión aplicado al pedido, indica si hay una sobrecomisión de tarifa plana que debería tenerse en cuenta.
rebill_commission_percentEsto sólo se incluirá en los eventos de refacturación de comisiones. En función del perfil de comisión aplicado al pedido, indica si hay un porcentaje de comisión adicional que deba tenerse en cuenta.
Datos del producto

Los datos de los productos se almacenan como una matriz de objetos codificados en JSON en el atributo 'order_products' y se incluyen con los Datos del pedido y los Datos del afiliado. Antes de interactuar con la matriz, asegúrese de decodificar JSON de la siguiente manera:

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

Este código de ejemplo asume que los datos fueron pasados a su script en una variable llamada '$data'. La siguiente tabla muestra los parámetros disponibles para cada elemento de la matriz 'order_products'.

AtributoDescripción
idEl ID del producto.
nombreEl nombre del producto.
skuLa SKU del producto.
importeEl importe pagado por cada unidad del producto.
cantidadEl número de este producto comprado.
totalEl precio total pagado equivale al importe * cantidad.
is_recurringIndica si este producto tiene una suscripción asociada o no. Los valores posibles son 'true' o 'false'.
importe_recurrenteEl importe pagado en cada periodo de facturación.
período_facturaciónUn 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ónCadena 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

Los datos de los cupones se almacenan como una matriz de objetos codificados en JSON en el atributo 'order_coupons' y se incluyen con los Datos del pedido y los Datos del afiliado. Antes de interactuar con la matriz, asegúrese de decodificar JSON de la siguiente manera:

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

Este código de ejemplo asume que los datos fueron pasados a su script en una variable llamada '$data'. La siguiente tabla muestra los parámetros disponibles para cada elemento de la matriz "order_coupons".

AtributoDescripción
idID del cupón.
nombreEl nombre del cupón.
códigoEl código del cupón.
Datos de prorrateo

Los datos de prorrateo se almacenan como una matriz de objetos codificados en JSON en el atributo 'order_prorations' y se incluyen con los Datos del pedido y los Datos del afiliado. Antes de interactuar con la matriz, asegúrese de decodificar JSON como se indica a continuación:

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

Este código de ejemplo asume que los datos fueron pasados a su script en una variable llamada '$data'. La siguiente tabla muestra los parámetros disponibles para cada elemento de la matriz 'order_prorations'.

AtributoDescripción
importeImporte del prorrateo.
descripciónLa descripción asociada a la compra.
¿Le ha resultado útil este artículo?

Artículos relacionados