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

Twitter updates

  • ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages— More
    5 March 2021
  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021
  • ProcessWire 3.0.171 dev branch core updates – More
    22 January 2021

Latest news

  • ProcessWire Weekly #356
    In the 356th issue of ProcessWire Weekly we'll cover the latest core updates (ProcessWire 3.0.173), introduce new third party modules RockCalculator and RockIframe, and take a closer look at a brand new site of the week. Read on!
    Weekly.pw / 6 March 2021
  • ProcessWire 3.0.173 core updates: New URL hooks
    ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages.
    Blog / 5 March 2021
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer