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

Twitter updates

  • Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
    1 January 2021
  • In this week’s blog post we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field: More
    4 December 2020
  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020

Latest news

  • ProcessWire Weekly #347
    In the 347th issue of ProcessWire Weekly we'll check out ProcessWire 3.0.170, introduce the PDF Fieldtype/Inputfield module, and more. Read on!
    Weekly.pw / 2 January 2021
  • ProcessWire 3.0.170 core updates
    Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021?
    Blog / 1 January 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