Fieldtype::get() method

Get a property from this Fieldtype’s data

  • If the given $key is an object, it will cast it to a string.
  • If the given $key is a string with "|" pipe characters in it, it will try all till it finds a non-empty value.
  • If given an API variable name, it will return that API variable unless the class has direct access API variables disabled.

Example

// Retrieve the value of a property
$value = $item->get("some_property");

// Retrieve the value of the first non-empty property:
$value = $item->get("property1|property2|property2");

// Retrieve a value using array access
$value = $item["some_property"];

Usage

$mixed = $fieldtype->get(string $key);

Arguments

NameType(s)Description
keystring

Name of property you want to retrieve.

Return value

mixed

Returns value of requested property, or null if the property was not found.

See Also


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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull