shortcode_atts()

Définition : shortcode_atts() combine les valeurs par défaut d’un shortcode WordPress avec les attributs fournis dans le contenu. Elle facilite la gestion de paramètres facultatifs avant leur validation et leur utilisation dans le rendu.

Terminologie

Terme officiel : shortcode_atts()

Autres appellations : Attributs de shortcode

À quoi cela sert

Elle permet au développeur d’imposer des noms d’attributs attendus et d’obtenir des valeurs de secours fiables. Les attributs non prévus ne sont pas repris dans le tableau retourné, ce qui simplifie le contrat d’un composant.

Comment cela fonctionne

La fonction reçoit un tableau de valeurs par défaut, les attributs entrants et éventuellement le nom du shortcode pour un filtre dédié. Elle ne valide pas automatiquement les types et ne protège pas la sortie HTML.

Dans quel contexte l’utiliser

À utiliser dans un callback de shortcode lorsqu’un composant comporte plusieurs réglages facultatifs : titre, taille ou variante visuelle.

Exemple concret

Un encadré d’information doit prendre un titre par défaut et limiter sa variante aux options info et attention.

Exemple de code commenté

<?php
add_shortcode( 'atoolpha_note', function ( $atts ) {
    $opts = shortcode_atts( array(
        'titre' => 'Information',
        'style' => 'info',
    ), $atts, 'atoolpha_note' );
    $style = in_array( $opts['style'], array( 'info', 'attention' ), true )
        ? $opts['style'] : 'info';
    return '<div class="atoolpha-' . esc_attr( $style ) . '">' .
        esc_html( $opts['titre'] ) . '</div>';
} );

Explication pas à pas de l’exemple

Le shortcode reçoit deux valeurs connues. La liste blanche limite style à deux chaînes. esc_attr() protège l’attribut class et esc_html() protège le titre. Un troisième attribut non déclaré n’est pas utilisé.