Shortcode API

Définition : La Shortcode API de WordPress permet de remplacer des marqueurs textuels insérés dans le contenu par un rendu produit par une fonction. Elle offre un mécanisme simple pour intégrer des composants dynamiques.

Terminologie

Terme officiel : Shortcode API

Autres appellations : API des codes courts

À quoi cela sert

Elle facilite l’insertion d’un petit composant dans un article ou une page : coordonnées, fiche, résultat calculé ou extrait de catalogue. Le rédacteur place un marqueur dans le contenu sans écrire directement du PHP.

Comment cela fonctionne

WordPress analyse les shortcodes présents dans le contenu traité et associe un nom enregistré à un callback. Le callback reçoit les attributs et, éventuellement, un contenu imbriqué ; il doit retourner le texte à insérer.

Dans quel contexte l’utiliser

Adaptée à des composants réutilisables simples, notamment pour les environnements anciens ou des intégrations compatibles shortcode. Pour une expérience d’édition moderne, envisager aussi un bloc Gutenberg.

Exemple concret

Une association souhaite afficher un encadré de contact depuis plusieurs pages à l’aide d’un même shortcode.

Exemple de code commenté

<?php
add_shortcode( 'atoolpha_contact', function ( $atts ) {
    $atts = shortcode_atts(
        array( 'nom' => 'ATOOLPHA' ),
        $atts,
        'atoolpha_contact'
    );
    return '<aside class="atoolpha-contact">' .
        esc_html( $atts['nom'] ) . '</aside>';
} );
// Dans le contenu : [atoolpha_contact nom="Support"]

Explication pas à pas de l’exemple

Le nom du marqueur est enregistré. shortcode_atts() applique la valeur par défaut puis lit le nom fourni par le rédacteur. esc_html() protège l’insertion dans le texte HTML et le callback retourne une chaîne plutôt que d’utiliser echo.

Résultat attendu

Le shortcode [atoolpha_contact nom="Support"] affiche un encadré contenant le texte Support à l’emplacement où WordPress l’évalue.

Précautions et limites

Ne pas supposer que les attributs sont fiables : assainir selon le besoin, puis échapper au rendu. Un shortcode coûteux répété dans une page peut ralentir son traitement.