mode d\'emplois de custer

dans les emails, aussi bien dans le message, que dans le sujet ou la personne destinataire, on peut utiliser un mot-clé custer.

Qu\'est-ce que c\'est que ça ;) ?

C\'est simplement un mot-clé écrit entre doubles dollars : $$mot-clé$$
Lorsque un email contient ce schéma de mot entouré par des doubles dollars, il essaye de trouver la valeur associée à ce mot-clé.
Ces mots-clés correspondent en fait aux données que wordpress enregistre sur chaque personne.

Ce n\'est pas toujours facile de savoir les mots-clés qui sont disponibles, sans aller voir le code directement, donc voici un exemple de liste de mots-clés pour une utilisatrice fictive :

    admin_color : fresh
    adresse_1 : 11 avenue Pauline
    adresse_2 :
    cgv : [\"\"]
    code_postal : 92700
    comment_shortcuts : false
    compte-actif : Actif
    description :
    dismissed_wp_pointers :
    display_name : AnneM
    email_asso : prez@asso.fr
    etablissement : École secondaire Waratinak
    etat_carte : Renouvellement
    etat_compte : carte valide
    etat_paiement : aucun
    etat_virement : [\"\"]
    fin_de_validite : 19/03/2094
    first_name : Anne
    fonction : Prof
    ID : 154
    image_test_ratio :
    justificatif : https://local-cipf-plugin.com/wp-content/uploads/de_fb_uploads/Attestation-1.pdf
    last_name : Martin
    livraison : Je préfère régler un supplément de 5 euros pour recevoir ma carte plastifiée
    locale :
    nickname : AnneM
    niveau_denseignement : Secondaire
    nom_asso : Mon asso
    numero_de_la_carte : 20240403154
    observations : J\'aime les bananes
    paiement : Paypal
    pays : Canada
    photo_du_profil : https://local-cipf-plugin.com/wp-content/uploads/de_fb_uploads/Exemple_profil.jpg
    president_asso : Le prez
    rich_editing : true
    session_tokens : {\"4003e23126f1697d7779ed03c9e45a70f2f6b34ce647a4507f573634d3c5469d\":{\"expiration\":1712437416,\"ip\":\"172.20.0.1\",\"ua\":\"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:124.0) Gecko/20100101 Firefox/124.0\",\"login\":1712264616},\"0b63f8dbef4446bcf94af3f007df0595c8bc39095eea4c9c5042cdb066c3aeef\":{\"expiration\":1712479930,\"ip\":\"172.20.0.1\",\"ua\":\"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:124.0) Gecko/20100101 Firefox/124.0\",\"login\":1712307130}}
    show_admin_bar_front : true
    somme_a_regler : 20
    syntax_highlighting : true
    tarif : Je suis hors réseau FIPF et je souhaite commander la carte à 15 €
    telephone :
    user_activation_key :
    user_email : temlevorku@gufum.com
    user_login : AnneM
    user_login(1) :
    user_nicename : annem
    user_pass : $P$BwMtApJkSSYdE38By6PcLbs3Xk9crj.
    user_registered : 14/03/2024
    user_status :
    user_url :
    use_ssl :
    ville : Colombes
    wp_503463_capabilities : 1
    wp_503463_user_level :
    xoo-el-password :
    xoo-el-rp-pass :
    xoo-el-rp-pass-again :
    xoo-el-sing-user :
    xoo-el-username :
    xoo_el_reg_email :
    xoo_el_reg_fname :
    xoo_el_reg_lname :
    xoo_el_reg_pass :
    xoo_el_reg_pass_again :
    xoo_el_reg_terms :
    xoo_el_reg_username :
    __admin_email__ : hugulumu@protonmail.com
    __author_page_url__ : https://local-cipf-plugin.com/author/annem/
    __base_url__ : https://local-cipf-plugin.com
    __user_post_url__ : 
      

On peut remarquer que certains mot-clés sont sous la forme \'__mot_clé__\' avec deux doubles underscores avant et apres : "__"moit-clé"__"
Ce sont des mot-clés qui ne sont pas définis par worpdress de base, mais rajoutés par ce plugin (custer), plus d\'explication plus bas, dans la section suivante 1.3.

Une méthode pour voir tous les mots-clés disponibles pour une personne connectée, c\'est d\'utiliser le shortcode [custer_user_info], comme expliqué dans la partie 2 de ce mode d\'emplois.

Certains mot-clés sont entourés par des doubles underscore : __mot_clé__, ce sont des mot-clés definis par custer, voici leur signification :

• __admin_email__ : l\'adresse email définie dans le menu \'Réglages\' > \'Général\' > \'Adresse e-mail d’administration\'
• __author_page_url__ : la page de profil de la personne connectée, appellée \'page auteur\' par wordpress (c\'est une page un peu speciale, qui ne peut pas être construite comme les autres pages, mais par le theme directement) -> ici elle sert pour les profs, c\'est leur page de profile
• __user_post_url__ : l\'adresse du plus récent article de la personne connectée -> ici ça correspond a la page de profil des partenaires, qui est construite comme un article, avec chaque partenaire n\'ayant droit qu\'à un seul article
• __base_url__ : l\'url de base du site, typiquement \'www.quelque-chose.com\'

Un exemple d\'utilisation dans un email, avec les données de l\'exemple précédent :

et une fois les mot-clés convertis, cet email devient :

Les shortcodes sont des \'petits codes\' qu\'on peut ecrire sur les pages front de wordpress, et qui vont executer un code côté serveur, et souvent être remplacés par le resultat de ce code.

C\'est à dire, plus concretement, qu\'on peut écrire un shortcode [mon-shortcode], et qu\'il se transformera en autre chose, par exemple \'salut\'.

Le shortcode de custer s\'appelle \'custer_user_info\', et il permet de retrouver la valeur du mot-clé qu\'on lui donne, les mêmes mots-clés que décrits dans la partie 1 de ce mode d\'emplois, à propos des emails.
Cette fois-ci, au lieu d\'ecrire le mot-clé entre double dollars $$mot_clé$$, on l\'écrit dans le shortcode : [custer_user_info mot-clé].

Le shortcode de custer possède plus d\'options que le simple mot-clé des emails, elles sont décrites dans les sections suivantes.
Mais pourquoi utiliser un shortcode ET une version avec les doubles dollars ? Tout simplement parce que dans les emails les shortcodes ne marchent pas :)

En utilisant le shortcode seul, c\'est à dire uniquement avec son nom et sans aucun autre argument : [custer_user_info], on obtient une liste de tous les mots-clés et leur valeur de quelqu\'un. De qui ? He bien, soit de la personne connectée, soit de la personne qui à ecrit la page, mais ce point est expliqué dans la section 2.4.

C\'est cette méthode, le shortcode de base, qui a été utilisée pour obtenir la liste montrée plus haut dans la section email, et qui donne quelque chose comme :

display_name : AnneM
etat_compte : carte valide
fin_de_validite : 19/03/2094
first_name : Anne
fonction : Prof
ID : 154
nickname : AnneM
... 
			

Ce n\'est pas prévu pour être vraiment utilisé sur le site finale, uniquement comme un outil pour voir les valeurs disponibles.

C\'est sous cette forme de base que le shortcode va fonctionner : afficher la valeur d\'un mot-clé.

Par exemple, si la prof connectée s\'appelle AnneM sur le site, on peut obtenir ce surnom en ecrivant [custer_user_info nickname]

exemples :

• [custer_user_info nickname] --> AnneM
• [custer_user_info first-name] --> Anne
• [custer_user_info fonction] --> Prof

C\'est assez simple, cependant il y à un point important qui est expliqué dans la section suivante, c\'est de choisir de qui on affiche les infos.

Il y a un petit piège dans la version de base du shortcode avec juste le mot-clé ([custer_user_info nickname]) :
on ne veut pas obligatoirement que s\'affiche les infos de la personne connectée.

Comment ca ?

En effet, par exemple sur une page de profil, si elle peut être vue par d\'autre personnes que simplement soi-même, alors on ne veut pas voir ses propres informations quand on va sur le profil de quelqu\'un d\'autre. Pourtant, si le shortcode affiche le nom de la personne connectée, on à beau visiter la page de quelqu\'un d\'autre, c\'est bien nous la personne connectée.
Généralement les pages de profils ne sont pas visibles publiquement, mais une personne avec les droits d\'administration peut y avoir accès, et rencontrer ce probleme.

Le même probleme apparait, et de manière encore plus courante, sur un article : si on veut afficher le nom de la personne qui a écrit l\'article par exemple, on ne veut pas que ce soit le nom de la personne connectée qui s\'affiche, encore une fois !

Donc, pour palier à ce probleme, le shortcode possede 2 status : la personne connectée, ou la personne autrice de la page.

Et en fait, comme la plupart du temps ce qu\'on veut ce sont les infos de la personnes qui a crée la page, le shortcode est configuré par defaut pour afficher ces infos-la, et non pas les infos de la personne connectée. C\'est ça le piège ;)

Donc, pour choisir si on veut la valeur de la personne connectée ou de la personne à qui appartient la page, on peut rajouter un argument : \'id\' qui peut avoir deux valeurs :

• id=\'logged_in\' : l\'info affiché sera celle de la personne connectée
• id=\'\'author (par défaut) : l\'info affichée sera celle de la personne ayant crée la page

Exemple, je suis connecté en tant que hugogogo et je vais voir la page de profil de AnneM :

• [custer_user_info nickname] -> AnneM
• [custer_user_info nickname id=\'logged_in\'] -> hugogogo
• [custer_user_info nickname id=\'author\'] -> AnneM

Il y a un autre argument qu\'on peut rajouter à ce shortcode, c\'est la valeur qu\'on veut voir si le mot-clé ne trouve aucune valeur correspondante.

En effet, si on demande la description d\'une personne par exemple, et qu\'elle n\'est pas remplie, le shortcode va juste retourner rien du tout, par defaut.

Mais peut-etre qu\'on prefèrerait qu\'il affiche quelque chose comme \'description non-fournie\' ?

Dans ce cas c\'est très simple, il suffit de le préciser dans l\'arguement if_empty=\'description non-fournie\' (ça fonctionne avec id=\'\' aussi)

Exemples si Hugo visite la page d\'une personne qui n\'a pas de description, et la description de Hugo est "hugogogo est un rigolo" :

• [custer_user_info description] ->
• [custer_user_info description if_empty=\'pas de description\'] -> pas de description
• [custer_user_info description id=\'logged_in\'] -> hugogogo est un rigolo
• [custer_user_info description id=\'logged_in\' if_empty=\'pas de description\'] -> hugogogo est un rigolo
• [custer_user_info description id=\'author\' if_empty=\'pas de description\'] -> pas de description

Celui-ci est très simple, il permet de changer momentanément la valeur de la personne connectée par celle de la personne autrice de la page.

Pour bien comprendre, il faut d\'abord voir un exemple :

--> connecté en tant que hugogogo, visite la page de AnneM :

ce code va donner le resultat suivant :

Qu\'est-ce qui s\'est passé ?

He bien en fait, lorsque le shortcode [custer_author_id] est ecrit, il modifie dans wordpress l\'information concernant la personne connectée, et il la rétablie lorsqu\'on ecrit le deuxième shortcode avec l\'argument \'off\' : [custer_author_id]

Mais attention ! Il modifie vraiment cette valeur pour tout wordpress, ce qui peut creer des problemes avec d\'autres éléments de la page, d\'autres plugins, d\'autres bout du thème, etc... Donc, il est recommandé de ne l\'utiliser que sur une courte portion de la page, pour un acte bien précis.

Et ce n\'est pas tout :p Si par hasard, vous avez besoin d\'utiliser ce shortcode sur une portion de la page, et que dans cette portion vous avez quand-même besoin de récupérer une info sur la personne connectée avec le shortcode [custer_user_info mot-clé], la vraie personne connectée, comment faire ? Il y a une solution, en ajoutant l\'argument important au shortcode. Exemple :

--> connecté en tant que hugogogo, visite la page de AnneM :

ce code va donner le resultat suivant :

On voit qu\'avec l\'argument important on retrouve la valeur de la vraie personne connectée

À noter que cet argument important n\'a pas d\'impact utilisé avec l\'autre id, ou en dehors du shortcode custer_author_id.