InputfieldWrapper::get() method

Get a child Inputfield having a name attribute matching the given $key.

This method can also get settings, attributes or API variables, so long as they don't collide with an Inputfield name. For that reason, you may prefer to use the Inputfield::getSetting(), Inputfield::attr() or Wire::wire() methods for those other purposes.

If you want a method that can only return a matching Inputfield object, use the InputfieldWrapper::getChildByName() method .

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

$inputfield = $inputfieldWrapper->get(string $key);

Arguments

NameType(s)Description
keystring

Name of Inputfield or setting/property to retrieve.

Return value

Inputfield mixed

Value of property or attribute, or NULL if not found.

Exceptions

Method can throw exceptions on error:

  • WireException - Only in core development/debugging, otherwise does not throw exceptions.

See Also


InputfieldWrapper methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #544
    In the 150th issue of ProcessWire Weekly we'll check out brand-new third party module called Inputfield Dependency Helper, share some recent highlights from the support forum, and more. Read on!
    Weekly.pw / 12 October 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

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits