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

Twitter updates

  • 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
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    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.
    Blog / 20 November 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