fbpx

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çãoDescriçãoDados transmitidos
mm_member_addEssa ação é executada quando um novo membro é adicionado ao MemberMouse.dados do membro
mm_member_membership_changeEssa ação é executada quando o nível de associação de um membro é alterado.dados do membro
mm_member_status_changeEssa ação é executada quando o status da conta de um membro é alterado.dados do membro
mm_member_account_updateEssa 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_deleteEssa ação é executada quando a conta de um membro é excluída.dados do membro
mm_bundles_addEssa ação é executada quando um pacote é adicionado à conta de um membro.dados do membrodados do pacote
mm_bundles_status_changeEssa ação é executada quando o status de um pacote é alterado na conta de um membro.dados do membrodados do pacote
mm_product_purchaseEssa ação é executada quando um pedido é enviado dados do membrodados do pedido
mm_payment_receivedEssa ação é executada quando um pagamento é recebido.dados do membrodados do pedido
mm_payment_rebillEssa ação é executada quando um pagamento de cobrança é recebido.dados do membrodados do pedido
mm_payment_rebill_declinedEssa ação é executada quando um pagamento de cobrança é recusado.dados do membrodados do pedido
mm_refund_issuedEssa ação é executada quando um reembolso é emitido.dados do membrodados do pedido
mm_commission_initialEssa ação é executada quando uma comissão inicial de afiliado deve ser rastreada.dados de afiliados
mm_commission_rebillEssa ação é executada quando uma comissão de afiliado de cobrança deve ser rastreada.dados de afiliados
mm_commission_cancelEssa 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
AtributoDescrição
member_idA ID atribuída ao membro pelo MemberMouse.
registradoA data em que o membro se registrou no formato AAAA-MM-DD HH:MM:SS.
last_logged_inA data em que o membro fez login pela última vez no formato AAAA-MM-DD HH:MM:SS.
last_updatedA data em que a conta do associado foi atualizada pela última vez no formato AAAA-MM-DD HH:MM:SS.
dias_como_membroO número de dias em que o membro é membro.
statusO 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_statusO status da conta do membro como uma cadeia de caracteres (ou seja ativocanceladoetc.).
is_complimentaryIndica 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çãoO ID do nível de associação associado à conta do membro.
nome do nível de associaçãoO nome do nível de associação associado à conta do membro.
primeiro_nomeO primeiro nome do membro.
sobrenomeO sobrenome do membro.
nome de usuárioO nome de usuário do membro.
e-mailO endereço de e-mail do membro.
telefoneO 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çaO endereço de cobrança do associado.
cidade_de_faturamentoA cidade de cobrança do membro.
billing_stateO estado de cobrança do associado.
billing_zip_codeO código postal de cobrança do associado.
país_de_faturamentoO país de cobrança do associado.
endereço_de_envioO endereço de entrega do associado.
cidade_de_envioA cidade de embarque do membro.
shipping_stateO estado de envio do membro.
código_de_zip_de_envioO código postal de envio do associado.
país_de_envioO país de envio do membro.
Dados do pacote
AtributoDescrição
bundle_idA ID do pacote.
nome do pacoteO nome do pacote.
dias_com_bundleO número de dias em que o pacote esteve ativo na conta do membro.
bundle_statusO 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_complimentaryIndica se o pacote é complementar ou não. Será definido como "true" se o pacote for complementar e "false" se não for.
nome_do_conjuntoO status do pacote como uma cadeia de caracteres (ou seja ativocanceladoetc.).
bundle_date_addedA data em que o pacote foi adicionado à conta do associado no formato AAAA-MM-DD HH:MM:SS.
bundle_last_updatedA 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
AtributoDescrição
número do pedidoO número de referência atribuído ao pedido pelo MemberMouse.
order_transaction_idO 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_pedidoO total do pedido, que é igual a (subtotal - desconto) + frete.
subtotal_do_pedidoO subtotal do pedido.
order_discountO desconto aplicado ao pedido.
envio de pedidosCusto de frete aplicado ao pedido.
order_shipping_methodO nome do método de envio escolhido pelo cliente ao fazer o check-out.
endereço de faturamento do pedidoO endereço de cobrança associado ao pedido.
order_billing_cityA cidade de cobrança associada ao pedido.
order_billing_stateO estado de faturamento associado ao pedido.
order_billing_zip_codeO código postal de cobrança associado ao pedido.
país de faturamento do pedidoO país de cobrança associado ao pedido.
endereço de envio do pedidoO endereço de entrega associado ao pedido.
cidade_de_envio_do_pedidoA cidade de envio associada ao pedido.
order_shipping_stateO estado de envio associado ao pedido.
código postal de envio do pedidoO código postal de remessa associado ao pedido.
país_de_envio_do_pedidoO país de remessa associado ao pedido.
produtos_pedidosUma 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_pedidoUma 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_prorationsUma 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_idO ID de afiliado associado ao pedido.
order_subaffiliate_idA ID da subafiliada associada ao pedido.
endereço_ip_do_pedidoO endereço IP associado ao pedido.
Dados de afiliados
AtributoDescrição
order_affiliate_idO ID de afiliado associado ao pedido.
order_subaffiliate_idA ID da subafiliada associada ao pedido.
member_idA ID atribuída ao membro pelo MemberMouse.
número do pedidoO 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_pedidoO 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_pedidoO endereço IP associado ao pedido.
produtos_pedidosUma 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_pedidoUma 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_prorationsUma 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_rateIsso 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_percentIsso 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".

AtributoDescrição
idA ID do produto.
nomeO nome do produto.
skuA SKU do produto.
quantidadeO valor pago por cada unidade do produto.
quantidadeO número deste produto adquirido.
totalO preço total pago é equivalente ao valor * quantidade.
is_recurringIndica se esse produto tem ou não uma assinatura associada a ele. Os valores possíveis são "true" (verdadeiro) ou "false" (falso).
recurring_amountO valor pago em cada período de cobrança.
período de cobrançaUm 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_frequencyUma 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".

AtributoDescrição
idA ID do cupom.
nomeO nome do cupom.
códigoO 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".

AtributoDescrição
quantidadeO valor do rateio.
descriçãoA descrição associada à compra.
Este artigo foi útil?

Artigos relacionados