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.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer