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

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH