WordPress 2.5 et les ShortCodes #1 – Présentation

WordPress 2.5 regorge de nouveautés au niveau de l’interface graphique du gestionnaire mais également au niveau des fonctionnalités pour les développeurs de thèmes et de plugins. Une des plus intéressantes de ces nouveautés à mon avis est l’introduction d’une API pour les Shortcodes.

Le but de cette API est de proposer un ensemble de fonctions pour faciliter l’insertion de macro-commandes dans le contenu d’un billet. Ok j’en conviens, dis comme ça c’est assez abstrait, alors nous allons illustrer cela en codant une première petite fonction parfaitement inutile : un shortcode pour insérer un « Hello World » (histoire de faire original).

Il faut tout d’abord savoir qu’on peut programmer le code « exécutable » associé à un shortcode aussi bien au niveau du thème en éditant le fichier « functions.php » que dans un plugin. Pour se facilier la tâche, nous allons travailler dans le fichier « functions.php » de notre thème.

Dans votre fichier « functions.php » donc, ajoutez le code suivant :

// function associée au shortcode [hello]
function hello_func(){
    echo "Hello World !";
}
add_shortcode('hello', 'hello_func'); // ajout du shortcode hello appellant la fonction hello_func()

La fonction hello_func() représente le code qui sera exécuté lorsqu’on insérera le shortcode [hello] dans nos billets. La fonction add_shortcode quand à elle sert à définir le shortcode qui sera utilisé dans nos billets. Elle a deux arguments obligatoires, le premier étant le tag qui sera utilisé dans nos billets et le deuxième la fonction à exécuter : add_shortcode('tag_à_insérer', 'fonction_à_exécuter')

Donc si maintenant vous écrivez un nouveau billet, tapez dans votre texte le shortcode [hello] (notez bien l’utilisation des crochets pour délimiter le nom de la commande) et publiez votre billet.

Ajout d\'un shortcode dans un billet Rendu d\'un billet contenant un shortcode

Comme vous pouvez le constater, le shortcode [hello] a bien été remplacer par le texte « Hello World ! » dans notre billet.

Voilà pour cette introduction aux shortcodes dans WordPress 2.5. Nous verrons dans un prochain billet des exemples de shortcodes plus complexes et les applications un peu plus concrètes que l’on pourra en faire.

autres articles sur les shortcodes :

Continuez votre lecture

12 commentaires

gael a dit le 4 avril 2008 à 10:30

Très pratique pour les créateurs de plugins ça! Je pense notamment à l’insertion facilitée d’audio ou de vidéos.
Il existe un moyen d’envoyer des paramètres à ces fonctions créées?

RépondreRépondre
burningHat a dit le 4 avril 2008 à 10:38

Clairement oui ! D’autant que, on le verra par la suite, ce système supporte les paramètres, du contenu et l’imbrication… Bref, c’est que du bonheur !

RépondreRépondre
bruno bichet a dit le 4 avril 2008 à 17:10

Juste trois mots : burningHat, mon héro :) Excellent, j’ai hâte de lire la suite !!!

RépondreRépondre
burningHat a dit le 4 avril 2008 à 20:05

Roooh tu me flattes Bruno ! :D j’essayerais d’être à la hauteur de tes attentes dans la suite alors… Je découvre juste la puissance du joujou mais ça me donne 1000 idées ce truc franchement !

RépondreRépondre
Olivier a dit le 4 avril 2008 à 21:02

C’est le principe du pointeur de fonction, bien connu des développeurs et rudement efficace… Après, j’espère que c’est bien sécurisé…

RépondreRépondre
burningHat a dit le 4 avril 2008 à 21:44

Yep en fait c’est une nouvelle fonctionnalité dans les hooks filters de l’API WordPress… Celle-ci est nouvelle mais le principe est très largement utilisé dans le core de WordPress depuis un moment donc j’espère pour eux que c’est la moindre sécurisé aussi ;)

RépondreRépondre
Mat a dit le 5 avril 2008 à 17:59

Merci pour la fonction, vraiment bien pensé ça ;)

RépondreRépondre
burningHat a dit le 5 avril 2008 à 18:41

Bah de rien, c’est pas de moi… Je me suis contenté d’explorer la doc, de faire des tests et de les partager dans cette suite d’articles (qui ne fait que commencer ;) )

RépondreRépondre
Martin a dit le 5 mai 2008 à 15:47

Tiens, je ne connaissais pas les shortcodes de WordPress et ça a l’air carrément sympa, puisqu’ils font partie du thème. Or, justement, quand on essaye de fournir des fonctionnalités particulières aux thèmes, on se demande comment les fournir, sachant que thèmes et plugins ne sont pas dans les mêmes dossiers. Bien vu ! Merci ! :)

RépondreRépondre
burningHat a dit le 5 mai 2008 à 17:03

En fait ils font partie du core même de WordPress et sont donc utilisables indifféremment dans les thèmes et dans les plugins. (donc c’est encore plus fort ! :p)

RépondreRépondre
mathias a dit le 13 mai 2008 à 14:00

excellente cette astuce, wordpress regorge des petites functions et c’est sympa de partager. j’essaye ça bientot :)

RépondreRépondre
burningHat a dit le 13 mai 2008 à 14:51

De rien Mathias, c’est tout naturel ;)

RépondreRépondre

8 trackbacks

www.tomateo.com - 4 avril 2008 à 10:14

WordPress 2.5 et les ShortCodes #1 – Présentation…

Présentation de l’API Shortcode de WordPress 2.5…

Anonyme - 4 avril 2008 à 10:24

WordPress 2.5 et les ShortCodes #1 – Prsentation…

Prsentation de l’API Shortcode dans WordPress 2.5…

Jean-Marie Gall.com » Blog Archive » Ma Revue de Presse 2.0 | 16 - 5 avril 2008 à 10:33

[...] 2.5 et les ShortCodes # 1-Présentation by Burninghat.net [...]

WordPress 2.5 et les ShortCodes #2 - les paramètres « burningHat - 8 avril 2008 à 9:12

[...] y a quelques jours, je vous présentais brièvement les shortcodes de WordPress 2.5. Nous allons aujourd’hui voir comment passer des paramètres à nos shortcodes et afficher [...]

WordPress 2.5 et les ShortCodes #3 - contenu et imbrication « burningHat - 17 avril 2008 à 17:54

[...] dernier article de ma suite sur les shortcode dans WordPress 2.5. Nous avons vu précédemment ce qu’était un shortcode et comment lui passer des paramètres. Dans cet article, nous allons voir comment les utiliser pour [...]

» La revue de web de la semaine #1 « css4design : des css pour votre design html - 23 avril 2008 à 18:13

[...] l’explication en détail, je vous invite fortement à lire WordPress 2.5 et les ShortCodes et à vous abonner au flux RSS de burningHat, vous ne le regretterez pas [...]

WordPress 2.5.x: les shortcodes - Emmanuel GEORJON - 26 juin 2008 à 22:42

[...] (fr) WordPress 2.5 et les ShortCodes #1: Présentation – BurningHat.net [...]

WordPress : des archives à la façon de ShaunInman.com « burningHat - 20 août 2008 à 18:15

[...] même sous forme de ShortCode si vous en êtes tellement fan que vous voulez pouvoir les afficher un peu [...]