Fieldtype::sanitizeValue() method

Sanitize the value for runtime storage and return it.

  • Implementation is required by Fieldtype modules, as this method is abstract.
  • This method should remove anything that's invalid from the given value. If it can't be sanitized, it should be made blank.
  • This method filters every value set to a Page instance, so it should do it's thing as quickly as possible.

Usage

$string = $fieldtype->sanitizeValue(Page $page, Field $field, $value);

Arguments

NameType(s)Description
pagePage
fieldField
valuestring, int, WireArray, object

Return value

string int WireArray object


Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK