$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.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.