$sanitizer->fieldSubfield() method

Sanitize as a field name but with optional subfield(s) like “field.subfield”

  • Periods must be present to indicate subfield(s), otherwise behaves same as fieldName() sanitizer.
  • By default allows just one subfield. To allow more, increase the $limit argument.
  • To allow any quantity of subfields, specify -1.
  • To reduce a field.subfield... combo to just field specify 0 for limit argument.
  • Maximum length of returned string is (128 + ($limit * 128)).

Available since version 3.0.126.

Example

echo $sanitizer->fieldSubfield('a.b.c'); // outputs: a.b (default behavior)
echo $sanitizer->fieldSubfield('a.b.c', 2); // outputs: a.b.c
echo $sanitizer->fieldSubfield('a.b.c', 0); // outputs: a
echo $sanitizer->fieldSubfield('a.b.c', -1); // outputs: a.b.c (any quantity)
echo $sanitizer->fieldSubfield('foo bar.baz'); // outputs: foo_bar.baz
echo $sanitizer->fieldSubfield('foo bar baz'); // outputs: foo_bar_baz

Usage

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

// usage with all arguments
$string = $sanitizer->fieldSubfield(string $value, int $limit = 1);

Arguments

NameType(s)Description
valuestring

Value to sanitize

limit (optional)int

Max allowed quantity of subfields, or use -1 for any quantity (default=1).

Return value

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020
  • ProcessWire 3.0.165 core updates (master and dev branch) and reCAPTCHA for FormBuilder module— More
    21 August 2020
  • What's coming in ProcessWire 3.0.165, plus a brief preview ProCache and FormBuilder versions coming within the next couple of weeks— More
    14 August 2020

Latest news

  • ProcessWire Weekly #330
    In the 330th issue of ProcessWire Weekly we'll take a quick peek at the new release of the FormBuilder module, cover some recent form highlights, and more. Read on!
    Weekly.pw / 5 September 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer