Crochets WordPress MemberMouse

Les crochets sont fournis par WordPress pour permettre à votre plugin de "s'accrocher" au reste de WordPress, c'est-à-dire d'appeler des fonctions de votre plugin à des moments précis et de mettre ainsi votre plugin en mouvement. MemberMouse définit son propre ensemble de crochets que vous pouvez utiliser pour vous "connecter" à MemberMouse afin d'appeler des fonctions dans votre plugin lorsque des événements spécifiques se produisent dans MemberMouse.

Voici un exemple de base :

function memberAdded($data)
{
    // effectue l'action
}
add_action('mm_member_add', 'memberAdded') ;

Dans cet exemple, nous utilisons l'option 'add_action()pour indiquer que la méthode "memberAdded()" doit être appelée lorsque MemberMouse exécute une action "mm_member_add". Pour en savoir plus sur l'utilisation de l'API d'action de WordPress lire cet article.

Catégories de crochets WordPress

Référence de l'action MemberMouse

Le tableau suivant présente toutes les actions MemberMouse, une description du moment où elles sont exécutées et les données qui seront transmises à toute fonction liée à l'action.

Action	Description	Données transmises
mm_member_add	Cette action est exécutée lorsqu'un nouveau membre est ajouté à MemberMouse.	données des membres
mm_member_membership_change	Cette action est exécutée lorsque le niveau d'adhésion d'un membre est modifié.	données des membres
mm_member_status_change	Cette action est exécutée lorsque le statut du compte d'un membre change.	données des membres
mm_member_account_update	Cette action est exécutée lorsque certaines données du compte d'un membre sont mises à jour. Il s'agit du prénom, du nom de famille, de l'adresse électronique, du nom d'utilisateur et du numéro de téléphone, les notes, l'adresse de facturation, l'adresse de livraison, la méthode de calcul du nombre de jours en tant que membre et les données des champs personnalisés.	données des membres
mm_member_delete	Cette action est exécutée lorsque le compte d'un membre est supprimé.	données des membres
mm_bundles_add	Cette action est exécutée lorsqu'une offre groupée est ajoutée au compte d'un membre.	données des membres, données de la liasse
mm_bundles_status_change	Cette action est exécutée lorsque le statut d'une offre groupée change sur le compte d'un membre.	données des membres, données de la liasse
mm_product_purchase	Cette action est exécutée lorsqu'une commande est soumise, avant la validation et le paiement.	données des membres, données de commande
mm_achat_complet	Cette action est exécutée lorsqu'un achat est effectué. Elle est disponible à partir de la version 3.0.6 de MemberMouse.	données des membres, données de commande
mm_payment_received	Cette action est exécutée lorsqu'un paiement est reçu.	données des membres, données de commande
mm_payment_rebill	Cette action est exécutée lorsqu'un paiement de refacturation est reçu.	données des membres, données de commande
mm_payment_rebill_declined	Cette action est exécutée lorsqu'un paiement de refacturation est refusé.	données des membres, données de commande
mm_refund_issued	Cette action est exécutée lorsqu'un remboursement est émis.	données des membres, données de commande
mm_commission_initiale	Cette action est exécutée lorsqu'une première commission d'affilié doit être suivie.	données sur les affiliés
mm_commission_rebill	Cette action est exécutée lorsqu'une commission d'affiliation de type "rebill" doit être suivie.	données sur les affiliés
mm_commission_cancel	Cette action est exécutée lorsqu'une commission d'affiliation doit être annulée.	données sur les affiliés

Attributs des données par type

Toutes les données sont transmises aux fonctions sous la forme d'un tableau associatif et sont accessibles de la manière suivante :

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

Les sections ci-dessous énumèrent les attributs de données disponibles pour chaque type.

Données des membres

Attribut	Description
numéro de membre	L'identifiant attribué au membre par MemberMouse.
enregistré	La date d'inscription du membre dans le format AAAA-MM-JJ HH:MM:SS.
dernier_congé	Date de la dernière connexion du membre au format AAAA-MM-JJ HH:MM:SS.
dernière_mise_à_jour	Date de la dernière mise à jour du compte du membre dans le format AAAA-MM-JJ HH:MM:SS.
jours_comme_me_membre	Le nombre de jours depuis lesquels le membre est membre.
statut	Le statut du compte du membre est un nombre entier : 1 = actif, 2 = annulé, 3 = bloqué, 4 = en pause, 5 = en retard, 6 = en attente d'activation, 7 = erreur, 8 = expiré, 9 = en attente d'annulation.
nom_du_statut	Le statut du compte du membre sous la forme d'une chaîne de caractères (c'est-à-dire actif, annuléetc).
est_complémentaire	Ce champ indique si le compte du membre est gratuit ou non. La valeur sera "true" si le compte est gratuit et "false" s'il ne l'est pas.
niveau d'adhésion	L'identifiant du niveau d'adhésion associé au compte du membre.
nom_du_niveau_d'appartenance	Le nom du niveau d'adhésion associé au compte du membre.
prénom	Le prénom du membre.
nom de famille	Le nom de famille du membre.
Nom d'utilisateur	Le nom d'utilisateur du membre.
courriel	L'adresse électronique du membre.
téléphone	Le numéro de téléphone du membre.
cf_#	Affiche la valeur du membre pour le champ personnalisé dont l'ID est #. Par exemple, si l'ID du champ personnalisé qui enregistre la date d'anniversaire est 4, vous devez utiliser "cf_4" pour afficher la date d'anniversaire du membre.
adresse_de_facturation	L'adresse de facturation du membre.
ville_de_facturation	Ville de facturation du membre.
état de la facturation	L'état de facturation du membre.
code postal de facturation	Le code postal de facturation du membre.
pays de facturation	Pays de facturation du membre.
adresse_d'expédition	L'adresse de livraison du membre.
ville_d'expédition	La ville d'expédition du membre.
état_de_livraison	L'état d'expédition du membre.
code postal	Le code postal d'expédition du membre.
pays d'expédition	Le pays d'expédition du membre.

Données de l'offre groupée

Attribut	Description
bundle_id	L'ID de la liasse.
nom_du_groupe	Le nom de la liasse.
jours_avec_forfait	Nombre de jours pendant lesquels l'offre groupée a été active sur le compte du membre.
bundle_status	Le statut de l'offre groupée : 1 = actif, 2 = annulé, 3 = verrouillé, 4 = en pause, 5 = en retard, 6 = en attente d'activation, 7 = erreur, 8 = expiré, 9 = en attente d'annulation.
bundle_is_complimentary	Cette valeur indique si l'offre est gratuite ou non. La valeur sera "true" si l'offre est gratuite et "false" si elle ne l'est pas.
bundle_status_name	Le statut de la liasse sous forme de chaîne de caractères (c'est-à-dire actif, annuléetc).
bundle_date_added	Date à laquelle l'offre groupée a été ajoutée au compte du membre dans le format AAAA-MM-JJ HH:MM:SS.
bundle_last_updated	Date de la dernière mise à jour de l'offre groupée sur le compte du membre, dans le format AAAA-MM-JJ HH:MM:SS.

Données de commande

Attribut	Description
numéro de commande	Le numéro de référence attribué à la commande par MemberMouse.
order_transaction_id	L'identifiant de la transaction associée à la commande. Il peut être utilisé comme identifiant unique pour tous les paiements associés à une commande. Lorsqu'un client achète un abonnement, chaque nouvelle facture fait partie de la même commande et porte donc le même numéro d'identification. Chaque nouvelle facture aura un identifiant de transaction unique.
total_de_la_commande	Le total de la commande qui est égal à (sous-total - remise) + frais de port.
commande_sous-total	Le sous-total de la commande.
remise_commande	La réduction appliquée à la commande.
commande_expédition	Frais d'expédition appliqués à la commande.
méthode_d'expédition_de_la_commande	Le nom de la méthode d'expédition choisie par le client lors du paiement.
adresse_de_facturation_de_la_commande	L'adresse de facturation associée à la commande.
ville_de_facturation_de_la_commande	La ville de facturation associée à la commande.
état_de_la_facturation_de_la_commande	L'état de la facturation associé à la commande.
code postal de facturation de la commande	Le code postal de facturation associé à la commande.
pays_de_facturation_de_la_commande	Le pays de facturation associé à la commande.
adresse_d'expédition_de_la_commande	L'adresse de livraison associée à la commande.
ville_d'expédition_de_la_commande	La ville d'expédition associée à la commande.
état_d'expédition_de_la_commande	L'état d'expédition associé à la commande.
code postal de la commande	Le code postal d'expédition associé à la commande.
pays_d'expédition_de_la_commande	Le pays d'expédition associé à la commande.
commander_produits	Un tableau de produits associés à la commande. Voir le tableau Données sur le produit Le tableau ci-dessous indique les paramètres disponibles pour chaque produit.
commander_coupons	Un tableau de coupons associés à la commande. Voir le tableau Données sur les coupons tableau ci-dessous pour les paramètres disponibles pour chaque coupon.
prorata des commandes	Un tableau des prorata associés à la commande. Voir le tableau Données de proratisation Le tableau ci-dessous indique les paramètres disponibles pour chaque élément de proratisation.
order_affiliate_id	L'identifiant de l'affilié associé à la commande.
order_subaffiliate_id	L'identifiant du sous-affilié associé à la commande.
adresse_ip_de_la_commande	L'adresse IP associée à la commande.

Données sur les affiliés

Attribut	Description
order_affiliate_id	L'identifiant de l'affilié associé à la commande.
order_subaffiliate_id	L'identifiant du sous-affilié associé à la commande.
numéro de membre	L'identifiant attribué au membre par MemberMouse.
numéro de commande	Le numéro unique associé à la commande concaténé avec l'identifiant de la transaction associée au paiement (c'est-à-dire 1456-3462). Cela permet de s'assurer que le numéro de commande fourni ici est unique pour toutes les transactions de refacturation associées à la commande.
total_de_la_commande	Le total de la commande disponible pour les commissions qui est égal au total de la commande moins les remises et les frais d'expédition.
adresse_ip_de_la_commande	L'adresse IP associée à la commande.
commander_produits	Un tableau de produits associés à la commande. Voir le tableau Données sur le produit Le tableau ci-dessous indique les paramètres disponibles pour chaque produit.
commander_coupons	Un tableau de coupons associés à la commande. Voir le tableau Données sur les coupons tableau ci-dessous pour les paramètres disponibles pour chaque coupon.
prorata des commandes	Un tableau des prorata associés à la commande. Voir le tableau Données de proratisation Le tableau ci-dessous indique les paramètres disponibles pour chaque élément de proratisation.
taux fixe de la commission de refacturation	Cet élément ne sera inclus que dans les événements de refacturation de la commission. En fonction du profil de commission appliqué à la commande, ceci indique s'il y a une surcharge de commission forfaitaire qui doit être prise en compte.
pourcent_de_la_commission_de_la_refacturation	Cet élément ne sera inclus que dans les événements de refacturation de la commission. En fonction du profil de commission appliqué à la commande, ceci indique s'il y a un pourcentage de dépassement de commission qui doit être pris en compte.

Données sur le produit

Les données relatives aux produits sont stockées sous la forme d'un tableau d'objets codés en JSON dans l'attribut "order_products" et sont incluses dans les données relatives aux commandes et aux affiliés. Avant d'interagir avec le tableau, assurez-vous de décoder JSON comme suit :

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

Cet exemple de code suppose que les données ont été transmises à votre script dans une variable appelée "$data". Le tableau ci-dessous présente les paramètres disponibles pour chaque élément du tableau "order_products".

Attribut	Description
id	L'ID du produit.
nom	Le nom du produit.
sku	L'UGS du produit.
montant	Montant payé pour chaque unité du produit.
quantité	Le nombre de ce produit acheté.
total	Le prix total payé équivaut au montant * quantité.
is_recurring	Indique si ce produit est associé à un abonnement ou non. Les valeurs possibles sont "true" ou "false".
montant récurrent	Le montant payé à chaque période de facturation.
période de facturation	Un nombre entier représentant la durée de la période de facturation. Pour déterminer la durée totale de la période de refacturation, il faut la combiner avec rebill_frequency (c'est-à-dire 1 mois, 30 jours, 2 semaines, etc.).
fréquence des re-facturations	Chaîne de caractères indiquant l'unité de mesure utilisée pour la période de facturation. Les valeurs possibles sont les jours, les semaines, les mois ou les années.

Données sur les coupons

Les données relatives aux coupons sont stockées sous la forme d'un tableau d'objets codés en JSON dans l'attribut "order_coupons" et sont incluses dans les données relatives aux commandes et aux affiliés. Avant d'interagir avec le tableau, assurez-vous de décoder JSON comme suit :

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

Cet exemple de code suppose que les données ont été transmises à votre script dans une variable appelée "$data". Le tableau ci-dessous présente les paramètres disponibles pour chaque élément du tableau "order_coupons".

Attribut	Description
id	L'ID du coupon.
nom	Le nom du coupon.
code	Le code de réduction.

Données de proratisation

Les données de proratisation sont stockées sous la forme d'un tableau d'objets encodés en JSON dans l'attribut "order_prorations" et sont incluses dans les données relatives aux commandes et aux affiliés. Avant d'interagir avec le tableau, assurez-vous de décoder JSON comme suit :

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

Cet exemple de code suppose que les données ont été transmises à votre script dans une variable appelée "$data". Le tableau ci-dessous présente les paramètres disponibles pour chaque élément du tableau "order_prorations".

Attribut	Description
montant	Le montant de la proratisation.
description	La description associée à l'achat.