Le blog.

Attribuer une récompense à un parrain après un achat WooCommerce.

Suite de notre série de tutoriels orientés WooCommerce : abordons maintenant le versement d’une commission au parrain qui a proposé un produit à la vente dans notre boutique.

Si vous avez manqué le début de cette série de tutoriels, rendez-vous dans la première partie d’introduction pour en savoir plus ;) Sachez aussi que ce plugin est téléchargeable gratuitement et  que vous pouvez découvrir son code sur GitHub.

Dans notre dernier article, nous avons développé un shortcode permettant l’affichage d’un formulaire sur notre site WordPress, formulaire qui permet à tout utilisateur (identifié sur notre site e-commerce) de proposer un produit à la vente. Nous avons également analysé la logique propre au traitement de ce formulaire WordPress afin d’exécuter chaque action « séparément » dans sa propre fonction hookée sur un filtre commun.

Objectif : augmenter la cagnotte d’un parrain

Maintenant que des produits peuvent être indiqués par des « prescripteurs » dans notre boutique et validés par l’administrateur afin d’être disponibles à la vente, jetons un œil à une fonctionnalité très importante de notre extension WooCommerce : le versement d’une commission au parrain du produit, après l’achat d’un produit par un client.

Chaque commande peut évidemment contenir plusieurs produits achetés : plusieurs parrains sont donc peut-être concernés par des nouveaux gains d’une ou plusieurs commission(s). Et chaque parrain recevra une commission pour chacun des produits qu’il a proposé et qui vient d’être acheté : notre objectif est d’enregistrer, à chaque commande, une commission par produit et non pas une commission unique par parrain.

Cela va nous permettre en fin de tutoriel d’afficher au parrain des informations détaillées des commissions versées en indiquant quel produit a été acheté lors d’une commande et combien ce produit aura rapporté de points au parrain au moment de la commande.

Tableau récapitulatif des points gagnés et utilisés par un parrain
Tableau récapitulatif des points gagnés et utilisés par un parrain

Comment verser une commission WooCommerce à un utilisateur ?

D’abord, le code…

On ne change pas une équipe qui gagne : pour pouvoir inclure de nouvelles logiques dans le fonctionnement de WooCommerce, on va encore utiliser une action ! Cette fois, on se hooke sur l’action woocommerce_order_status_changedCette action s’exécute à chaque fois que le statut d’une commande WooCommerce change : on va donc vérifier le nouveau statut de la commande et si elle est bel et bien définie comme étant terminée, nous allons calculer et attribuer une ou plusieurs commissions aux parrains des produits achetés.

Notez qu’elle reçoit 3 paramètres de WooCommerce : l’identifiant de la commande ($order_id) et les noms machines de l’ancien et du nouveau statut de la commande ($old_status et $new_status). Ces 3 valeurs sont primordiales pour en savoir plus sur la commande, et connaître l’état (statut) de cette dernière.

Analysons un peu cette fonction histoire de comprendre ce qu’elle fait :

  • ligne 15 à 20 : on récupère des informations de la commande (avec wc_get_order()) et les articles de cette commande (avec $order->get_items()) puis on définit quelques variables initiales
  • ligne 23 à 29 : si l’ancien statut de la commande était « terminée », on a probablement enregistré des commissions sur cette commande. On va donc supprimer les lignes de commissions de notre table wp_commissions dont la colonne order_id a comme valeur l’identifiant de la commande qui est traitée (valeur stockée dans la variable $order_id). En d’autres termes : on oublie les gains de commissions enregistrés dans notre base de données car la commande n’est plus « terminée ». Elle a peut-être été annulée ou remboursée.
  • à partir de la ligne 32, on va faire l’inverse : si la commande passe en statut « terminée », on va devoir assigner des commissions. On va donc analyser chaque article acheté dans la commande, en bouclant sur la variable $order_items (ligne 34).
    • ligne 36 et 37, on va chercher via wc_get_product() le produit acheté
    • ligne 40 et 41 : on va récupérer les dates de début et de fin de commission qui sont stockées dans des meta-données (définies lors de la soumission du formulaire, ou par l’administrateur de la boutique)
    • ligne 50 : on s’assure que la date de la commande est bien comprise dans la période de validité de commission
    • ligne 51 à 57 : on récupère l’identifiant de l’utilisateur parrain à créditer (ligne 52), le taux de commission du produit (ligne 53), la quantité de produits achetés (ligne 55) et le sous-total de la commande pour cette ligne d’articles (ligne 57)
    • ligne 60 à 68 : on va calculer le montant de la commission à reverser au parrain. De plus, on en profite pour doubler la valeur du montant reversé si l’acheteur est en fait également le parrain (ligne 65 et 66)
    • enfin, de la ligne 72 à 88 : on enregistre dans notre table SQL wp_commissions une nouvelle ligne contenant les informations que l’on vient de calculer. Remarquez que la valeur de la colonne user_notified est définie sur « no » : plus tard, nous enverrons un e-mail à l’utilisateur pour l’informer des nouveaux gains qu’il a reçus (une fois prévenu de ce nouveau gain, on remplacera cette valeur « no » par la date d’envoi de l’e-mail de notification). C’est donc cette colonne qui va permettre à notre plugin WooCommerce de savoir quelles commissions récentes n’ont pas encore été communiquées au parrain par e-mail.
Colonne de notre table SQL WordPress des commissions
Colonne de notre table SQL WordPress des commissions

Et voila ! Avec cette bonne grosse fonction hookée sur la bonne action WooCommerce, notre code va intercepter tout changement de statut de commande WooCommerce et : soit supprimer les commissions, soit créer un nouvel enregistrement d’un gain-récompense pour un parrain.

Mais enregistrer ces données de gains des parrains n’a aucune utilité si les utilisateurs ne peuvent utiliser leur cagnotte. C’est notre prochaine étape : permettre au client WooCommerce d’utiliser sa cagnotte comme réduction !

2 commentaires ont été rédigés, ajoutez le votre.

  1. Rétrolien: Utiliser une cagnotte de gains dans WooCommerce comme promotion sur une commande

  2. Rétrolien: Développer un formulaire WordPress : proposer un produit WooCommerce

Laisser un commentaire