do_action()

Définition : do_action() déclenche une action WordPress en appelant tous les callbacks enregistrés sous un nom donné. Elle sert aussi à créer des points d’extension personnalisés dans une extension, sans imposer de dépendance directe entre modules.

Terminologie

Terme : do_action()

Autres appellations : Déclenchement d’action, Custom Action

À quoi cela sert

Lorsque le code atteint un appel do_action(), le moteur consulte les callbacks associés au hook, les exécute selon leurs priorités et leur transmet les éventuels arguments. Contrairement à apply_filters(), cette fonction n’expose pas de valeur transformée.

Dans quel contexte l’utiliser

L’utiliser lors d’une étape métier importante que d’autres modules peuvent observer : validation d’un document, fin de traitement ou changement d’état. Préfixer les noms des hooks personnalisés pour réduire les collisions.

Exemple concret

Après avoir validé une fiche dans un plugin, le module déclenche un événement auquel un autre module peut s’abonner.

Exemple de code commenté

<?php
add_action( 'atoolpha_fiche_validee', function ( $fiche_id ) {
    // Exemple : réagir à une fiche validée.
    // Ici, aucune écriture n’est effectuée.
}, 10, 1 );

$fiche_id = 42; // Valeur fictive dans ce scénario.
do_action( 'atoolpha_fiche_validee', $fiche_id );

Explication de l’exemple

Le premier bloc enregistre l’écouteur ; le second simule l’événement de validation. La valeur entière est fournie au callback et pourrait ensuite servir à tracer l’opération si un auditeur a été branché.

Précautions et limites

Un hook ne remplace pas les contrôles d’autorisation ou de cohérence de l’opération qui le précède. Ne jamais exposer de données privées dans des arguments destinés à des tiers non maîtrisés.

Termes associés

  • Action
  • add_action()
  • apply_filters()

Références officielles

Bouton retour en haut de la page