29.1 Qu'est-ce qu'un « shortcode » ?

Un « shortcode » WordPress, c'est un petit bout de code (non, sans blague ;-)) qui est exécuté lorsqu'une série de caractères donnée est rencontrée. La série de caractères sera toujours entourée de crochets carrés (ex : [gallery]). Dans les faits, c'est cette série de caractères entourée de crochets carrés qu'on appelle shortcode.

Un de mes étudiants a proposé une définition intéressante (merci Seydou !) :

Les shortcodes sont comme des variables qui contiennent du code exécutable.

Lorsqu'on entre le shortcode dans une page, un article, un pied de page, etc., le noyau WordPress remplace les caractères du shortcode par l'information générée par le code qui lui est associé.

Le shortcode peut afficher un simple texte. Il peut également effectuer un traitement plus ou moins complexe à partir d'informations pouvant être tirées de la BD.

Par exemple, si vous entrez le shortcode [gallery] dans le texte d'un article ou d'une page, WordPress affichera les images associées à l'article ou à la page.

Il est parfois possible de personnaliser le shortcode en lui indiquant certaines valeurs, comme par exemple : [gallery columns="2" size="medium"]. La possibilité de personnaliser un shortcode dépend de la façon dont il a été programmé.

Comment ajouter un shortcode dans une page ou un article?

Dans le tableau de bord, éditez la page ou l'article dans lequel vous désirez ajouter le shortcode.

Pour ajouter le shortcode, utilisez l'une de ces options.

• Ajoutez un bloc de type Shortcode et entrez-y le nom du shortcode entouré de crochets carrés. 

  

• Ajoutez un bloc de type Paragraphe et entrez-y le nom du shortcode entouré de crochets carrés.
• Passez en mode éditeur de code (clic sur les trois points verticaux / Éditeur de code) puis, à l'endroit désiré, entrez le nom du shortcode entouré de crochets carrés. Idéalement, le shortcode devrait être ajouté à l'intérieur d'une zone délimitée par <!-- wp:... --> et <!-- /wp:... --> afin de ne pas nuire au bon fonctionnement de l'éditeur de blocs.

  

Où sont programmés les shortcodes?

• Certains shortcodes, comme [gallery], font partie du noyau WordPress.
• D'autres sont codés dans un thème ou dans une extension. C'est donc le programmeur qui décide de ce que le shortcode affichera.

C'est à cette dernière catégorie que nous nous intéresserons ici.

Pour plus d'information

« Shortcode API ». WordPress. https://codex.wordpress.org/Shortcode_API