add_action( string $tag, callable $function_to_add, int $priority = 10, int $accepted_args = 1 )

Attache une fonction à une action spécifique.

Description

Les actions sont les hooks que WordPress lance à des points précis durant son exécution ou quand des évènements spécifiques se produisent.

Paramètres

$tag

(string) (Requis) Nom de l'action.

$function_to_add

(callable) (Requis) Nom de la fonction à attacher à $tag.

$priority

(int) (Optionnel) Utilisé pour spécifier l'ordre dans lequel les fonctions attachées à $tag doivent être exécutées.

Valeur par défaut : 10

$accepted_args

(int) (Optionnel) Le nombre d'arguments que la fonction accepte.

Valeur par défaut : 1

Retourne

(bool) Retourne toujours true.

Structure de la fonction add_action()

Définie dans le fichier wp-includes/plugin.php à la ligne 403 :

function add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
    return add_filter( $tag, $function_to_add, $priority, $accepted_args );
}

Fonction utilisée par add_action()

add_filter()

Attache une fonction ou une méthode à un filtre spécifique.

Où trouver la fonction add_action() dans le CMS Wordpress

Exemples

Usage basique :
function wpdocs_save_post( $post_ID, $post, $update ) {
   // code ici...
}
add_action( 'save_post', 'wpdocs_save_post', 10, 3 );
Utilisation au sein d'une classe :
class WP_Docs_Class {
 
    /* Constructor */
    
    public function __construct() {
        add_action( 'save_post', array( $this, 'wpdocs_save_posts' ) );
    }
 
    public function wpdocs_save_posts() {
        // code ici...
    }
}
 
return new WP_Docs_Class();

Sources

Codex Wordpress : add_action()

Autres fonctions dans le même fichier : wp-includes/plugin.php

Retour