$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

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer