Documentation du code de SPIP et de ses plugins

API de vérification

slug.php

API de vérification : vérification de la validité d'un slug

Slug : court texte utilisable [...] pour décrire et identifier une ressource. https://en.wikipedia.org/wiki/Clean_URL#Slug

Tags
plugin

verifier

copyright

2018

author

Les Développements Durables

licence

GNU/GPL

Table of Contents

Functions

verifier_slug_dist()  : string
Vérifie la validité d'un slug

Functions

verifier_slug_dist()

Vérifie la validité d'un slug

verifier_slug_dist(string $valeur[, array<string|int, mixed> $options = [] ][, null &$valeur_normalisee = null ]) : string

Un slug est un court texte utilisé pour identifier une ressource. Il ne contient que des charactères alphanumérique ou un séparateur (par défaut, un underscore) Donc ni charactère accentué, ponctuation ou espace blanc.

Permet de normaliser la valeur, ou alternativement de ne faire qu'une suggestion dans le message d'erreur.

Parameters
$valeur : string

La valeur à vérifier.

$options : array<string|int, mixed> = []
  • (bool) normaliser : pour convertir automatiquement la chaîne au bon format.
  • (bool) normaliser_suggerer : pour suggérer la chaîne normalisée au lieu de la modifier (alternative à l'option précédente).
  • (string) separateur : un ou plusieurs charactères acceptés pour séparer les mots (sans espace), défaut = underscore Si multiples, on prend le 1er pour normaliser
  • (int) longueur_maxi : nombre maximal de charactères, défaut = 60
$valeur_normalisee : null = null

Si normalisation à faire, la variable sera remplie par la chaîne normalisée. Ex. : « Ô, toi, l’écureuil ! » devient « o_toi_l_ecureuil »

Tags
note

La normalisation nécéssite pour l'instant le plugin Bonux

Return values
string

Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.


        
On this page

Search results