vendredi 25 septembre 2026

À propos

Contact

Lexique · Extensions & API WordPress

API des tableaux de bord

En anglais : « Dashboard widgets API »

Fonctions WordPress permettant à une extension d'ajouter, de repositionner ou de retirer des encarts d'information sur l'écran d'accueil de l'administration.

L’écran d’accueil que voit un administrateur en se connectant n’est pas figé : chaque encart (activité récente, état du site, flux RSS) est un module indépendant, et une extension peut y ajouter le sien pour afficher ses propres statistiques ou raccourcis.

Ajouter un encart

La fonction centrale est wp_add_dashboard_widget(), appelée sur le hook wp_dashboard_setup. Elle prend un identifiant, un titre et une fonction de rendu :

add_action( 'wp_dashboard_setup', function () {
  wp_add_dashboard_widget(
    'mon_encart_stats',
    'Statistiques du site',
    'afficher_encart_stats'
  );
} );

function afficher_encart_stats() {
  echo '<p>' . esc_html( get_option( 'blogname' ) ) . '</p>';
}

La fonction de rendu peut afficher n’importe quel HTML, y compris des graphiques ou des liens vers une page de réglages dédiée.

Contrôler l’ordre et la visibilité

L’ordre des encarts est mémorisé par utilisateur et modifiable par glisser-déposer ; il n’est donc pas garanti par le code. Pour retirer un encart existant, y compris ceux du cœur de WordPress, on utilise remove_meta_box() sur l’écran dashboard.

Bon à savoir

  • Chaque utilisateur peut masquer un encart via le menu « Options de l’écran », sans que cela affecte les autres comptes.
  • Ces encarts partagent la même mécanique interne que les boîtes méta des écrans d’édition (les « meta boxes »).
  • Un encart peut aussi accepter un rappel de configuration comme cinquième argument de wp_add_dashboard_widget(), utile pour afficher un lien de réglages directement dans son en-tête.