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

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull