Accepted Args

Définition : Accepted Args désigne le nombre d’arguments qu’un callback WordPress déclare vouloir recevoir lorsqu’il est enregistré sur un hook. Ce nombre se règle avec le quatrième paramètre de add_action() ou add_filter().

Terminologie

Terme : Accepted Args

Autres appellations : Arguments acceptés, Nombre d’arguments de callback

À quoi cela sert

Un hook peut fournir plusieurs arguments, mais WordPress ne transmet à chaque callback que le nombre autorisé lors de son inscription. Le réglage par défaut est 1 ; le callback doit disposer d’une signature compatible avec le nombre et l’ordre des données réellement fournies.

Dans quel contexte l’utiliser

L’utiliser lorsqu’un traitement exige un contexte supplémentaire, comme l’identifiant d’un article, son objet et l’indication d’une mise à jour. Toujours consulter la signature officielle du hook pour éviter les paramètres absents ou mal interprétés.

Exemple concret

Un plugin réagit à save_post et doit distinguer une création d’une mise à jour, sans enregistrer d’information supplémentaire.

Exemple de code commenté

<?php
add_action( 'save_post', function ( $post_id, $post, $update ) {
    if ( ! $update || 'post' !== $post->post_type ) {
        return;
    }
    // Ici, les trois informations ont été reçues.
}, 10, 3 ); // 3 arguments acceptés.

Explication de l’exemple

Le quatrième paramètre 3 autorise WordPress à transmettre id, objet WP_Post et indicateur de mise à jour. Sans cette précision, la fonction ne recevrait par défaut qu’un seul argument.

Précautions et limites

Le nombre autorisé ne fabrique pas de paramètres : le hook doit effectivement les fournir. Éviter aussi de déclarer des paramètres obligatoires en surnombre.