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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer