remove_filter( string $tag, callable $function_to_remove, int $priority = 10 )

Supprime une fonction attachée au hook d'un filtre.

Paramètres

$tag(string)requis

Nom du hook du filtre.

$function_to_remove(callable)requis

Le nom de la fonction que l'on veut supprimer.

$priority(int)optionnel

Priorité de la fonction à supprimer.

Valeur par défaut : 10

Description / Informations supplémentaires

Cette fonction peut être utilisée pour supprimer des fonctions attachées par défaut à certains hooks et éventuellement les remplacer par des fonctions personnalisées.

$function_to_remove et $priority doivent correspondre au hook ajouté. Aucune alerte ne sera donnée si la suppression ne fonctionne pas.

Retourne

(bool) True si la fonction qui existait avant a bien été supprimé.

Déclaration et structure de la fonction remove_filter()

function remove_filter( $hook_name, $callback, $priority = 10 ) {
    global $wp_filter;

    $r = false;

    if ( isset( $wp_filter[ $hook_name ] ) ) {
        $r = $wp_filter[ $hook_name ]->remove_filter( $hook_name, $callback, $priority );

        if ( ! $wp_filter[ $hook_name ]->callbacks ) {
            unset( $wp_filter[ $hook_name ] );
        }
    }

    return $r;
}

Où est utilisée la fonction remove_filter() dans le CMS WordPress

Exemples

remove_filter( 'the_content', 'wpautop' );
Si un filtre a été ajouté au sein d'une classe, il faut accéder à celle-ci pour supprimer ce filtre :
global $my_class;
remove_filter( 'the_content', array($my_class, 'class_filter_function') );

Sources

Codex WordPress : remove_filter()

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

Retour