$sanitizer->hyphenCase() method

Convert string to be all hyphenated-lowercase (aka kabab-case, hyphen-case, dash-case, etc.)

For example, "Hello World" or "helloWorld" becomes "hello-world".

Usage

// basic usage
$string = $sanitizer->hyphenCase(string $value);

// usage with all arguments
$string = $sanitizer->hyphenCase(string $value, array $options = []);

Arguments

NameType(s)Description
valuestring
options (optional)array
  • hyphen (string): Character to use as the hyphen (default='-')
  • allow (string): Characters to allow or range of characters to allow, for placement in regex (default='a-z0-9').
  • allowUnderscore (bool): Allow underscores? (default=false)

Return value

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.244

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer