MemberMouse WordPress Hooks

Os ganchos são fornecidos pelo WordPress para permitir que seu plug-in se "conecte" ao restante do WordPress, ou seja, para chamar funções em seu plug-in em momentos específicos e, assim, colocar seu plug-in em movimento. O MemberMouse define seu próprio conjunto de ganchos que você pode utilizar para "conectar-se" ao MemberMouse, de modo que possa chamar funções em seu plug-in quando ocorrerem eventos específicos no MemberMouse.

Aqui está um exemplo básico:

function memberAdded($data)
{
    // executar ação
}
add_action('mm_member_add', 'memberAdded');

Neste exemplo, estamos usando o parâmetro 'add_action()' para indicar que o método 'memberAdded()' deve ser chamado quando o MemberMouse executar uma ação 'mm_member_add'. Para saber mais sobre como trabalhar com a API de ação do WordPress leia este artigo.

Categorias de Hooks do WordPress

Referência da ação MemberMouse

A tabela a seguir lista todas as ações do MemberMouse, uma descrição de quando elas são executadas e quais dados serão passados para qualquer função conectada à ação.

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	Essa ação é executada quando o nível de associação de um membro é alterado.	dados do membro
mm_member_status_change	Essa ação é executada quando o status da conta de um membro é alterado.	dados do membro
mm_member_account_update	Essa ação é executada quando determinados dados da conta de um membro são atualizados. 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	Essa ação é executada quando a conta de um membro é excluída.	dados do membro
mm_bundles_add	Essa ação é executada quando um pacote é adicionado à conta de um membro.	dados do membro, dados do pacote
mm_bundles_status_change	Essa ação é executada quando o status de um pacote é alterado na conta de um membro.	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	A data em que a conta do associado foi atualizada pela última vez no formato AAAA-MM-DD HH:MM:SS.
dias_como_membro	O número de dias em que o membro é membro.
status	O status da conta do membro como um número inteiro: 1 = ativa, 2 = cancelada, 3 = bloqueada, 4 = pausada, 5 = vencida, 6 = ativação pendente, 7 = erro, 8 = expirada, 9 = cancelamento pendente
nome_do_status	O status da conta do membro como uma cadeia de caracteres (ou seja ativo, canceladoetc.).
is_complimentary	Indica se a conta do membro é complementar ou não. Será definido como "true" se a conta for complementar e "false" se não for.
nível de associação	O ID do nível de associação associado à conta do membro.
nome do nível de associação	O nome do nível de associação associado à conta do membro.
primeiro_nome	O primeiro nome do membro.
sobrenome	O sobrenome do membro.
nome de usuário	O nome de usuário do membro.
e-mail	O endereço de e-mail do membro.
telefone	O número de telefone do membro.
cf_#	Emite o valor do membro para o campo personalizado com ID #. Por exemplo, se o ID do campo personalizado que armazena a data de nascimento for 4, então, para gerar a data de nascimento do membro, você usaria 'cf_4'.
endereço de cobrança	O endereço de cobrança do associado.
cidade_de_faturamento	A cidade de cobrança do membro.
billing_state	O estado de cobrança do associado.
billing_zip_code	O código postal de cobrança do associado.
país_de_faturamento	O país de cobrança do associado.
endereço_de_envio	O endereço de entrega do associado.
cidade_de_envio	A cidade de embarque do membro.
shipping_state	O estado de envio do membro.
código_de_zip_de_envio	O código postal de envio do associado.
país_de_envio	O país de envio do membro.

Dados do pacote

Atributo	Descrição
bundle_id	A ID do pacote.
nome do pacote	O nome do pacote.
dias_com_bundle	O número de dias em que o pacote esteve ativo na conta do membro.
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	Indica se o pacote é complementar ou não. Será definido como "true" se o pacote for complementar e "false" se não for.
nome_do_conjunto	O status do pacote como uma cadeia de caracteres (ou seja ativo, canceladoetc.).
bundle_date_added	A data em que o pacote foi adicionado à conta do associado no formato AAAA-MM-DD HH:MM:SS.
bundle_last_updated	A data em que o pacote foi atualizado pela última vez na conta do membro no formato AAAA-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	O ID da transação associado ao pedido. Isso pode ser usado como um ID exclusivo para todos os pagamentos associados a um pedido. Quando um cliente adquire uma assinatura, cada pagamento de cobrança faz parte do mesmo pedido, portanto, todos eles compartilham o mesmo ID de pedido. Cada pagamento de cobrança terá um ID de transação exclusivo.
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	Isso só será incluído em eventos de cobrança de comissão. Com base no perfil de comissão aplicado ao pedido, isso indica se há uma substituição de comissão de taxa fixa que deve ser levada em conta.
rebill_commission_percent	Isso só será incluído em eventos de cobrança de comissão. Com base no perfil de comissão aplicado ao pedido, isso indica se há uma porcentagem de substituição de comissão que deve ser levada em conta.

Dados do produto

Os dados do produto são armazenados como uma matriz de objetos codificados em JSON no atributo "order_products" e são incluídos nos dados do pedido e nos dados do afiliado. Antes de interagir com a matriz, certifique-se de que a decodificação JSON seja feita da seguinte forma:

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

Este código de exemplo pressupõe que os dados foram passados para o script na variável chamada "$data". A tabela abaixo descreve os parâmetros disponíveis para cada item na matriz "order_products".

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	Indica se esse produto tem ou não uma assinatura associada a ele. Os valores possíveis são "true" (verdadeiro) ou "false" (falso).
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

Os dados do cupom são armazenados como uma matriz de objetos codificados em JSON no atributo "order_coupons" e são incluídos nos dados do pedido e nos dados do afiliado. Antes de interagir com a matriz, certifique-se de que a decodificação JSON seja feita da seguinte forma:

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

Esse código de amostra pressupõe que os dados foram passados para o script em uma variável chamada "$data". A tabela abaixo descreve os parâmetros disponíveis para cada item na matriz "order_coupons".

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

Dados de precificação

Os dados de rateio são armazenados como uma matriz de objetos codificados em JSON no atributo "order_prorations" e são incluídos nos dados do pedido e nos dados do afiliado. Antes de interagir com a matriz, certifique-se de que a decodificação JSON seja feita da seguinte forma:

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

Esse código de amostra pressupõe que os dados foram passados para o script na variável chamada "$data". A tabela abaixo descreve os parâmetros disponíveis para cada item na matriz "order_prorations".

Atributo	Descrição
quantidade	O valor do rateio.
descrição	A descrição associada à compra.