add_shortcode, Créer un shortcode en PHP pour WordPress

Après avoir fait le tour des forums, des documentations, vous vous rendez compte qu’aucun shortcode de WordPress ne répond à votre besoin ?

C’est le moment idéal pour commencer la création de votre premier shortcode pour WordPress, et donner des superpouvoirs à votre site, et tout ça en 5 minutes seulement !

Qu’est ce qu’un Shortcode ?

Avant de rentrer dans le vif du sujet, petit retour en arrière et un peu de contexte !

Les shortcodes font parti intégrante de WordPress, depuis sa création, et permet aux éditeurs de rajouter directement dans une page de contenu, un bloc (sous cette forme : [monshortcode] ), qui sera « simplement » remplacé par du contenu généré dynamiquement !

Les shortcodes permettent de répondre à de nombreux besoins tels que :

• Afficher le nom d’un utilisateur loggué sur votre site, à un endroit précis,
• Faire des calculs de manière « invisible » et afficher le résultat à l’utilisateur,
• Personnaliser l’expérience de navigation,
• …

Comment et où créer votre Shortcode ?

Le code permettant la déclaration de votre shortcode va pouvoir se trouver à deux endroits différent : dans le fichier functions.php de votre thème, ou directement dans un plugin que vous avez créé.

Pour ce tutoriel, nous allons choisir d’utiliser la première méthode : ajouter le code dans le fichier functions.php

1ère étape : Localisez et modifiez votre fichier functions.php

Pour commencer, il est nécessaire de localiser le fichier functions.php de votre thème, il va se trouver dans la racine du thème que vous utilisez !

Tous les thèmes sont stockés à cette adresse : /wp-content/themes/nom-de-votre-theme

/!\ Attention : assurez-vous de bien disposer d’un thème enfant, ne modifiez jamais votre thème original ! (si ça ne vous dit rien, je vous invite à suivre ce tutoriel, et de revenir ici ensuite : comment créer un thème enfant)

Connectez-vous à votre serveur et modifiez ce functions.php avec un éditeur de texte / votre IDE préféré.

2ème étape : Déclarez et utilisez votre Shortcode

Maintenant que le fichier functions.php est ouvert, il est temps de déclarer votre Shortcode, pour l’enregistrer au niveau de WordPress, et pouvoir l’utiliser dans votre site.

Pour ce faire, voici l’extrait du code qui vous permet de déclarer et retourner une valeur lors de l’insertion de votre shortcode dans votre site :

function myFirstShortCode() {
    $name='Rémi';
    return 'Salut ' . $name . ', voici mon premier Shortcode';
}
add_shortcode('myshortcode', 'myFirstShortCode');

En ajoutant ce code et en enregistrant votre fichier, vous venez de créer votre premier shortcode !

Une petite explication du code s’impose :

• add_shortcode : fonction interne permettant au développeur d’enregistrer un nouveau shortcode.
  • Il prend en premier argument le nom du shortcode à utiliser sur votre site (ici : [myshortcode])
  • Le second argument est un argument de callback, c’est le nom de la fonction qui sera appelée lors de l’utilisation du shortcode
• myFirstShortCode : la fonction qui sera donc invoquée lors de l’usage du shortcode, un simple return vous permet de renvoyer l’information qui sera affichée à l’internaute !

Voici donc ce que ça donne du côté WP dès que je l’insère sur une page :

Tadam ! Tout fonctionne, et vous pouvez dès maintenant exploiter le potentiel des shortcodes directement dans votre WordPress !

Exemples de shortcodes utiles

En quelques lignes vous pouvez ainsi créer une véritable boîte à outils pour améliorer votre site et donner des superpouvoirs à votre WP 🙂 !

Afficher la date du jour

function today_date() {
    $date = date_i18n('d F Y');
    return 'Bonjour, nous sommes le : ' . $date;
}
add_shortcode('date_shortcode', 'today_date');

Afficher le nom de l’utilisateur connecté

function shortcode_current_user() {
    $user = wp_get_current_user();
    return 'Nom d\'utilisateur actuel : ' . $user->display_name;
}
add_shortcode('current_user_shortcode', 'shortcode_current_user');

Afficher le nombre d’articles publiés

function shortcode_published_articles_count() {
    $count = wp_count_posts()->publish;
    return 'Nombre d\'articles publiés : ' . $count;
}
add_shortcode('published_articles_count_shortcode', 'shortcode_published_articles_count');

Afficher l’IP du visiteur de votre site

function shortcode_visitor_ip() {
    $ip = $_SERVER['REMOTE_ADDR'];
    return 'IP du visiteur : ' . $ip;
}
add_shortcode('visitor_ip_shortcode', 'shortcode_visitor_ip');

Le mot de la fin

Les Shortcodes sont incroyablement puissants, et vous offrent la possibilité d’afficher des informations à n’importe quel endroit, sans trop de contraintes !

J’espère que cet article vous a plu, si c’est le cas n’hésitez pas à le partager ou à laisser un petit commentaire, à très vite !