sanitize_title( string $title, string $fallback_title = '', string $context = 'save' )
Nettoie et transforme une chaîne en slug qui peut être utilisé dans une url ou comme valeur d'attribut HTML.
Description
Par défaut la fonction sanitize_title()
enlève les accents et change les underscore (_) et les espaces en tirets (-) à travers le filtre 'sanitize_title'
.
Le contexte 'save' est le plus souvent utilisé quand une valeur est sauvegardée en base de donnée. Le contexte 'query' est utilisé par la fonction sanitize_title_for_query()
quand la valeur est utilisée pour la clause WHERE d'une requête.
Paramètres
$title
(string) (Requis) La chaîne à nettoyer.
$fallback_title
(string) (Optionnel) Un titre à utiliser si $title est vide.
Valeur par défaut : ''
$context
(string) (Optionnel) L'opération pour laquelle le titre est nettoyé. Quand réglé à 'save', $title passe par la fonction
remove_accents()
.Valeur par défaut : 'save'
Retourne
(string) La chaîne nettoyée.
Structure de la fonction sanitize_title()
Définie dans le fichier wp-includes/formatting.php à la ligne 2175 :
function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
$raw_title = $title;
if ( 'save' === $context ) {
$title = remove_accents( $title );
}
/**
* Filters a sanitized title string.
*
* @since 1.2.0
*
* @param string $title Sanitized title.
* @param string $raw_title The title prior to sanitization.
* @param string $context The context for which the title is being sanitized.
*/
$title = apply_filters( 'sanitize_title', $title, $raw_title, $context );
if ( '' === $title || false === $title ) {
$title = $fallback_title;
}
return $title;
}
Fonctions et Hook utilisés par sanitize_title()
sanitize_title
Filtre le titre nettoyé.
remove_accents()
Convertit les caractères accentués en caractères au format ASCII.
apply_filters()
Appel les fonctions qui ont été attaché à un filtre (hook).
Où trouver la fonction sanitize_title()
dans le CMS Wordpress
Exemple
Sources
Codex Wordpress : sanitize_title()
Autres fonctions dans le même fichier : wp-includes/formatting.php