$sanitizer->fieldName() method

Sanitize consistent with names used by ProcessWire fields and/or PHP variables

  • Allows upper and lowercase ASCII letters, digits and underscore.
  • ProcessWire field names follow the same conventions as PHP variable names, though digits may lead.
  • This method is the same as the varName() sanitizer except that it supports beautification and max length.
  • Unlike other name formats, hyphen and period are excluded because they aren't allowed characters in PHP variables.

Example

$test = "Hello world";
echo $sanitizer->fieldName($test); // outputs: Hello_world

Usage

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

// usage with all arguments
$string = $sanitizer->fieldName(string $value, $beautify = false, int $maxLength = 128);

Arguments

NameType(s)Description
valuestring

Value you want to sanitize

beautify (optional)bool, int

Should be true when using the name for a new field (default=false). You may also specify constant Sanitizer::translate (or number 2) for the $beautify param, which will make it translate letters based on the system page name translation settings.

maxLength (optional)int

Maximum number of characters allowed in the name (default=128).

Return value

string

Sanitized string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.167

Twitter updates

  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020
  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020

Latest news

  • ProcessWire Weekly #336
    In the 336th issue of ProcessWire Weekly we're going to introduce the Stripe action for FormBuilder, highlight some recent forum topics and other online resources, and more. Read on!
    Weekly.pw / 17 October 2020
  • Stripe Payment Processor for FormBuilder
    This week a second new module for processing Stripe payments has been added to FormBuilder. We’ll take a closer look at it in this blog post, plus we’ve got a demo of it here too.
    Blog / 16 October 2020
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer