MemberMouse WordPress Hooks

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)
{
    // executar ação
}
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 leia este artigo.

Categorias de Hooks do WordPress

Referência da ação MemberMouse

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.

Ação	Descrição	Dados transmitidos
mm_member_add	Essa ação é executada quando um novo membro é adicionado ao MemberMouse.	dados do membro
mm_member_membership_change	This action is executed when a member’s membership level is changed.	dados do membro
mm_member_status_change	This action is executed when the status of a member’s account changes.	dados do membro
mm_member_account_update	This action is executed when certain data on a member’s account is updated. Isso inclui: nome, sobrenome, endereço de e-mail, nome de usuário, número de telefone, notas, endereço de cobrança, endereço de entrega, método de cálculo de dias como membro e dados de campos personalizados.	dados do membro
mm_member_delete	This action is executed when a member’s account is deleted.	dados do membro
mm_bundles_add	This action is executed when a bundle is added to a member’s account.	dados do membro, dados do pacote
mm_bundles_status_change	This action is executed when the status of a bundle changes on a member’s account.	dados do membro, dados do pacote
mm_product_purchase	Essa ação é executada quando um pedido é enviado, antes da validação e do pagamento.	dados do membro, dados do pedido
mm_purchase_complete	Essa ação é executada quando uma compra é concluída. Ela está disponível no MemberMouse 3.0.6 e mais recente.	dados do membro, dados do pedido
mm_payment_received	Essa ação é executada quando um pagamento é recebido.	dados do membro, dados do pedido
mm_payment_rebill	Essa ação é executada quando um pagamento de cobrança é recebido.	dados do membro, dados do pedido
mm_payment_rebill_declined	Essa ação é executada quando um pagamento de cobrança é recusado.	dados do membro, dados do pedido
mm_refund_issued	Essa ação é executada quando um reembolso é emitido.	dados do membro, dados do pedido
mm_commission_initial	Essa ação é executada quando uma comissão inicial de afiliado deve ser rastreada.	dados de afiliados
mm_commission_rebill	Essa ação é executada quando uma comissão de afiliado de cobrança deve ser rastreada.	dados de afiliados
mm_commission_cancel	Essa ação é executada quando uma comissão de afiliado deve ser cancelada.	dados de afiliados

Atributos de dados por tipo

Todos os dados são passados para as funções como uma matriz associativa e podem ser acessados da seguinte forma:

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

As seções abaixo listam os atributos de dados disponíveis para cada tipo.

Dados do membro

Atributo	Descrição
member_id	A ID atribuída ao membro pelo MemberMouse.
registrado	A data em que o membro se registrou no formato AAAA-MM-DD HH:MM:SS.
last_logged_in	A data em que o membro fez login pela última vez no formato AAAA-MM-DD HH:MM:SS.
last_updated	The date the member’s account was last updated in the format YYYY-MM-DD HH:MM:SS.
dias_como_membro	O número de dias em que o membro é membro.
status	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
nome_do_status	The status of the member’s account as a string (i.e. ativo, 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.
nível de associação	The ID of the membership level associated with the member’s account.
nome do nível de associação	The name of the membership level associated with the member’s account.
primeiro_nome	The member’s first name.
sobrenome	The member’s last name.
nome de usuário	The member’s username.
e-mail	The member’s email address.
telefone	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’.
endereço de cobrança	The member’s billing address.
cidade_de_faturamento	The member’s billing city.
billing_state	The member’s billing state.
billing_zip_code	The member’s billing zip code.
país_de_faturamento	The member’s billing country.
endereço_de_envio	The member’s shipping address.
cidade_de_envio	The member’s shipping city.
shipping_state	The member’s shipping state.
código_de_zip_de_envio	The member’s shipping zip code.
país_de_envio	The member’s shipping country.

Dados do pacote

Atributo	Descrição
bundle_id	A ID do pacote.
nome do pacote	O nome do pacote.
dias_com_bundle	The number of days the bundle has been active on the member’s account.
bundle_status	O status do pacote: 1 = ativo, 2 = cancelado, 3 = bloqueado, 4 = pausado, 5 = vencido, 6 = ativação pendente, 7 = erro, 8 = expirado, 9 = cancelamento pendente
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.
nome_do_conjunto	O status do pacote como uma cadeia de caracteres (ou seja ativo, 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.

Dados do pedido

Atributo	Descrição
número do pedido	O número de referência atribuído ao pedido pelo 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_do_pedido	O total do pedido, que é igual a (subtotal - desconto) + frete.
subtotal_do_pedido	O subtotal do pedido.
order_discount	O desconto aplicado ao pedido.
envio de pedidos	Custo de frete aplicado ao pedido.
order_shipping_method	O nome do método de envio escolhido pelo cliente ao fazer o check-out.
endereço de faturamento do pedido	O endereço de cobrança associado ao pedido.
order_billing_city	A cidade de cobrança associada ao pedido.
order_billing_state	O estado de faturamento associado ao pedido.
order_billing_zip_code	O código postal de cobrança associado ao pedido.
país de faturamento do pedido	O país de cobrança associado ao pedido.
endereço de envio do pedido	O endereço de entrega associado ao pedido.
cidade_de_envio_do_pedido	A cidade de envio associada ao pedido.
order_shipping_state	O estado de envio associado ao pedido.
código postal de envio do pedido	O código postal de remessa associado ao pedido.
país_de_envio_do_pedido	O país de remessa associado ao pedido.
produtos_pedidos	Uma matriz de produtos associados ao pedido. Consulte a seção Dados do produto A tabela abaixo apresenta os parâmetros disponíveis para cada produto.
cupons_de_pedido	Uma matriz de cupons associados ao pedido. Consulte a seção Dados do cupom A tabela abaixo mostra os parâmetros disponíveis para cada cupom.
order_prorations	Uma matriz de rateios associados ao pedido. Veja o Dados de precificação A tabela abaixo apresenta os parâmetros disponíveis para cada item de rateio.
order_affiliate_id	O ID de afiliado associado ao pedido.
order_subaffiliate_id	A ID da subafiliada associada ao pedido.
endereço_ip_do_pedido	O endereço IP associado ao pedido.

Dados de afiliados

Atributo	Descrição
order_affiliate_id	O ID de afiliado associado ao pedido.
order_subaffiliate_id	A ID da subafiliada associada ao pedido.
member_id	A ID atribuída ao membro pelo MemberMouse.
número do pedido	O número exclusivo associado ao pedido concatenado com o ID da transação associado ao pagamento (ou seja, 1456-3462). Isso garante que o número do pedido fornecido aqui seja exclusivo em todas as transações de cobrança associadas ao pedido.
total_do_pedido	O total do pedido disponível para comissões, que é igual ao total do pedido menos os descontos e os custos de envio.
endereço_ip_do_pedido	O endereço IP associado ao pedido.
produtos_pedidos	Uma matriz de produtos associados ao pedido. Consulte a seção Dados do produto A tabela abaixo apresenta os parâmetros disponíveis para cada produto.
cupons_de_pedido	Uma matriz de cupons associados ao pedido. Consulte a seção Dados do cupom A tabela abaixo mostra os parâmetros disponíveis para cada cupom.
order_prorations	Uma matriz de rateios associados ao pedido. Veja o Dados de precificação A tabela abaixo apresenta os parâmetros disponíveis para cada item de rateio.
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.

Dados do produto

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	Descrição
id	A ID do produto.
nome	O nome do produto.
sku	A SKU do produto.
quantidade	O valor pago por cada unidade do produto.
quantidade	O número deste produto adquirido.
total	O preço total pago é equivalente ao valor * quantidade.
is_recurring	Indicates where this product has a subscription associated with it or not. Possible values are ‘true’ or ‘false’.
recurring_amount	O valor pago em cada período de cobrança.
período de cobrança	Um número inteiro que representa a duração do período de cobrança. Para determinar a duração completa do período de cobrança, combine esse valor com rebill_frequency (ou seja, 1 mês, 30 dias, 2 semanas etc.).
rebill_frequency	Uma cadeia de caracteres que indica a unidade de medida usada para o período de cobrança. Os valores possíveis são dias, semanas, meses ou anos.

Dados do cupom

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.

Atributo	Descrição
id	A ID do cupom.
nome	O nome do cupom.
código	O código do cupom.

Dados de precificação

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	Descrição
quantidade	O valor do rateio.
descrição	A descrição associada à compra.