$sanitizer→fieldName()

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

Name	Type(s)	Description
`$value`	`string`	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.251