Crochets WordPress MemberMouse

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)
{
    // effectue l'action
}
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 lire cet article.

Catégories de crochets WordPress

Référence de l'action 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.

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	This action is executed when a member’s membership level is changed.	données des membres
mm_member_status_change	This action is executed when the status of a member’s account changes.	données des membres
mm_member_account_update	This action is executed when certain data on a member’s account is updated. 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	This action is executed when a member’s account is deleted.	données des membres
mm_bundles_add	This action is executed when a bundle is added to a member’s account.	données des membres, données de la liasse
mm_bundles_status_change	This action is executed when the status of a bundle changes on a member’s account.	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	The date the member’s account was last updated in the format YYYY-MM-DD HH:MM:SS.
jours_comme_me_membre	Le nombre de jours depuis lesquels le membre est membre.
statut	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
nom_du_statut	The status of the member’s account as a string (i.e. actif, annuléetc).
est_complémentaire	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.
niveau d'adhésion	The ID of the membership level associated with the member’s account.
nom_du_niveau_d'appartenance	The name of the membership level associated with the member’s account.
prénom	The member’s first name.
nom de famille	The member’s last name.
Nom d'utilisateur	The member’s username.
courriel	The member’s email address.
téléphone	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’.
adresse_de_facturation	The member’s billing address.
ville_de_facturation	The member’s billing city.
état de la facturation	The member’s billing state.
code postal de facturation	The member’s billing zip code.
pays de facturation	The member’s billing country.
adresse_d'expédition	The member’s shipping address.
ville_d'expédition	The member’s shipping city.
état_de_livraison	The member’s shipping state.
code postal	The member’s shipping zip code.
pays d'expédition	The member’s shipping country.

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	The number of days the bundle has been active on the member’s account.
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	This indicates if the bundle is complimentary or not. It will be set to ‘true’ if the bundle is complimentary and ‘false’ if not.
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	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.

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	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_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	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.
pourcent_de_la_commission_de_la_refacturation	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.

Données sur le produit

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.

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	Indicates where this product has a subscription associated with it or not. Possible values are ‘true’ or ‘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

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.

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

Données de proratisation

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.

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