Skip to content

Str::slug()

Convert a string to a safe version to be used in a URL

Str::slug(string $string = null, string $separator = null, string $allowed = null, int $maxlength = 128): string

Parameters

Name Type Default Description
$string string null The unsafe string
$separator string null To be used instead of space and
other non-word characters.
$allowed string null List of all allowed characters (regex)
$maxlength int 128 The maximum length of the slug

Return type

string

Parent class

Kirby\Toolkit\Str