WireMail::get() method

Get property

  • 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 = $m->get(string $key);

Arguments

NameType(s)Description
keystring

Name of property you want to retrieve.

Return value

mixed null

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

See Also


$m methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #551
    In the 551st issue of ProcessWire Weekly we'll check out what's new in the core this week, share a new weekly poll, and more. Read on!
    Weekly.pw / 1 December 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH