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

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020

Latest news

  • ProcessWire Weekly #306
    In the 306th issue of ProcessWire Weekly we'll check out ProcessWire 3.0.153, introduce a new third party module called Image Crop Ratios, highlight some recent module updates, and more. Read on!
    Weekly.pw / 21 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 2020
  • 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