FieldtypeModule::sanitizeValue() method

Sanitize value

  • 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

$int = $fieldtypeModule->sanitizeValue(Page $page, Field $field, $value);

Arguments

NameType(s)Description
pagePage
fieldField
valueint, object, WireArray, string

Return value

int bool null Module


FieldtypeModule methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.