fbpx

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.

ActionDescriptionDonnées transmises
mm_member_addCette action est exécutée lorsqu'un nouveau membre est ajouté à MemberMouse.données des membres
mm_member_membership_changeCette action est exécutée lorsque le niveau d'adhésion d'un membre est modifié.données des membres
mm_member_status_changeCette action est exécutée lorsque le statut du compte d'un membre change.données des membres
mm_member_account_updateCette 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_deleteCette action est exécutée lorsque le compte d'un membre est supprimé.données des membres
mm_bundles_addCette action est exécutée lorsqu'une offre groupée est ajoutée au compte d'un membre.données des membresdonnées de la liasse
mm_bundles_status_changeCette action est exécutée lorsque le statut d'une offre groupée change sur le compte d'un membre.données des membresdonnées de la liasse
mm_product_purchaseCette action est exécutée lorsqu'une commande est soumise données des membresdonnées de commande
mm_payment_receivedCette action est exécutée lorsqu'un paiement est reçu.données des membresdonnées de commande
mm_payment_rebillCette action est exécutée lorsqu'un paiement de refacturation est reçu.données des membresdonnées de commande
mm_payment_rebill_declinedCette action est exécutée lorsqu'un paiement de refacturation est refusé.données des membresdonnées de commande
mm_refund_issuedCette action est exécutée lorsqu'un remboursement est émis.données des membresdonnées de commande
mm_commission_initialeCette action est exécutée lorsqu'une première commission d'affilié doit être suivie.données sur les affiliés
mm_commission_rebillCette action est exécutée lorsqu'une commission d'affiliation de type "rebill" doit être suivie.données sur les affiliés
mm_commission_cancelCette 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
AttributDescription
numéro de membreL'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_à_jourDate de la dernière mise à jour du compte du membre dans le format AAAA-MM-JJ HH:MM:SS.
jours_comme_me_membreLe nombre de jours depuis lesquels le membre est membre.
statutLe 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_statutLe statut du compte du membre sous la forme d'une chaîne de caractères (c'est-à-dire actifannuléetc).
est_complémentaireCe 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ésionL'identifiant du niveau d'adhésion associé au compte du membre.
nom_du_niveau_d'appartenanceLe nom du niveau d'adhésion associé au compte du membre.
prénomLe prénom du membre.
nom de familleLe nom de famille du membre.
Nom d'utilisateurLe nom d'utilisateur du membre.
courrielL'adresse électronique du membre.
téléphoneLe 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_facturationL'adresse de facturation du membre.
ville_de_facturationVille de facturation du membre.
état de la facturationL'état de facturation du membre.
code postal de facturationLe code postal de facturation du membre.
pays de facturationPays de facturation du membre.
adresse_d'expéditionL'adresse de livraison du membre.
ville_d'expéditionLa ville d'expédition du membre.
état_de_livraisonL'état d'expédition du membre.
code postalLe code postal d'expédition du membre.
pays d'expéditionLe pays d'expédition du membre.
Données de l'offre groupée
AttributDescription
bundle_idL'ID de la liasse.
nom_du_groupeLe nom de la liasse.
jours_avec_forfaitNombre de jours pendant lesquels l'offre groupée a été active sur le compte du membre.
bundle_statusLe 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_complimentaryCette 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_nameLe statut de la liasse sous forme de chaîne de caractères (c'est-à-dire actifannuléetc).
bundle_date_addedDate à laquelle l'offre groupée a été ajoutée au compte du membre dans le format AAAA-MM-JJ HH:MM:SS.
bundle_last_updatedDate 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
AttributDescription
numéro de commandeLe numéro de référence attribué à la commande par MemberMouse.
order_transaction_idL'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_commandeLe total de la commande qui est égal à (sous-total - remise) + frais de port.
commande_sous-totalLe sous-total de la commande.
remise_commandeLa réduction appliquée à la commande.
commande_expéditionFrais d'expédition appliqués à la commande.
méthode_d'expédition_de_la_commandeLe nom de la méthode d'expédition choisie par le client lors du paiement.
adresse_de_facturation_de_la_commandeL'adresse de facturation associée à la commande.
ville_de_facturation_de_la_commandeLa ville de facturation associée à la commande.
état_de_la_facturation_de_la_commandeL'état de la facturation associé à la commande.
code postal de facturation de la commandeLe code postal de facturation associé à la commande.
pays_de_facturation_de_la_commandeLe pays de facturation associé à la commande.
adresse_d'expédition_de_la_commandeL'adresse de livraison associée à la commande.
ville_d'expédition_de_la_commandeLa ville d'expédition associée à la commande.
état_d'expédition_de_la_commandeL'état d'expédition associé à la commande.
code postal de la commandeLe code postal d'expédition associé à la commande.
pays_d'expédition_de_la_commandeLe pays d'expédition associé à la commande.
commander_produitsUn 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_couponsUn 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 commandesUn 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_idL'identifiant de l'affilié associé à la commande.
order_subaffiliate_idL'identifiant du sous-affilié associé à la commande.
adresse_ip_de_la_commandeL'adresse IP associée à la commande.
Données sur les affiliés
AttributDescription
order_affiliate_idL'identifiant de l'affilié associé à la commande.
order_subaffiliate_idL'identifiant du sous-affilié associé à la commande.
numéro de membreL'identifiant attribué au membre par MemberMouse.
numéro de commandeLe 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_commandeLe 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_commandeL'adresse IP associée à la commande.
commander_produitsUn 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_couponsUn 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 commandesUn 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 refacturationCet é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_refacturationCet é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".

AttributDescription
idL'ID du produit.
nomLe nom du produit.
skuL'UGS du produit.
montantMontant payé pour chaque unité du produit.
quantitéLe nombre de ce produit acheté.
totalLe prix total payé équivaut au montant * quantité.
is_recurringIndique si ce produit est associé à un abonnement ou non. Les valeurs possibles sont "true" ou "false".
montant récurrentLe montant payé à chaque période de facturation.
période de facturationUn 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-facturationsChaî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".

AttributDescription
idL'ID du coupon.
nomLe nom du coupon.
codeLe 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".

AttributDescription
montantLe montant de la proratisation.
descriptionLa description associée à l'achat.
Cet article a-t-il été utile ?

Articles connexes