sanitize_text_field( string $str )

Nettoie une chaîne provenant d'un champ de formulaire ou d'une base de donnée.

Paramètre

$str(string)requis

Chaîne à nettoyer.

Description / Informations supplémentaires

  • Vérifie si les caractères sont encodés en UTF-8
  • Convertie le caratère < en entité
  • Enlève toutes les balises html, ainsi que les balises <script> et <style> et php
  • Supprime les retours à la ligne, les tabulations et tous les types d'espaces
  • Enlève les octets

Retourne

(string) La chaîne nettoyée.

Déclaration et structure de la fonction sanitize_text_field()

function sanitize_text_field( $str ) {
    $filtered = _sanitize_text_fields( $str, false );

    /**
     * Filters a sanitized text field string.
     *
     * @since 2.9.0
     *
     * @param string $filtered The sanitized string.
     * @param string $str      The string prior to being sanitized.
     */
    return apply_filters( 'sanitize_text_field', $filtered, $str );
}
_sanitize_text_fields()

Fonction d'aide interne qui nettoie une chaîne provenant d'un champ de formulaire ou d'une base de donnée.

apply_filters()

Appel les fonctions qui ont été attaché à un filtre (hook).

sanitize_text_field

Filtre une chaîne nettoyée.

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

Exemple

Usage basique :
$str = "<h2>Titre</h2>";
sanitize_text_field( $str );
echo $str;
// Affichera "Titre" sans les balises

Sources

Codex WordPress : sanitize_text_field()

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

Retour