Fieldtype::isEmptyValue() method

Return whether the given value is considered empty or not.

This can be anything that might be present in a selector value and thus is typically a string. However, it may be used outside of that purpose so you shouldn't count on it being a string.

Example: an integer or text Fieldtype might not consider a "0" to be empty, whereas a Page reference would.

This method is primarily used by the PageFinder::whereEmptyValuePossible() method to determine whether to include non-present (null) rows.

3.0.164+: If given a Selector object for $value, PageFinder is proposing handling the empty-value match condition internally rather than calling the Fieldtype’s getMatchQuery() method. Return true if this Fieldtype would prefer to handle the match, or false if not. Fieldtype modules do not need to consider this unless they want to override the default empty value match behavior in PageFinder::whereEmptyValuePossible().

Usage

$bool = $fieldtype->isEmptyValue(Field $field, mixed $value);

Arguments

NameType(s)Description
fieldField
valuemixed

Return value

bool


Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #499
    In the 499th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called RockPdf, and more. Read on!
    Weekly.pw / 3 December 2023
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer