Jump to main content Jump to doc navigation

xPDOObject::getField

Resolves a field name or alias to the actual field name of the object. If $key is a declared field, it is returned unchanged; if it is a field alias, the aliased field is returned.

Syntax

string|boolean getField (string $key, [boolean $validate = false])
  • $key — the field name or alias to resolve.
  • $validate — when true, returns false if the key is neither a field nor an alias; when false (the default), the key is returned as passed.

Example

$store = $xpdo->getObject('sfStore', 1);
echo $store->getField('postalcode');
// 'zip'

See Also

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • STERC
  • Digital Penguin
  • Jens Wittmann – Gestaltung & Entwicklung
  • CrewMark
  • Fabian Christen
  • Sepia River Studios
  • Dannevang Digital
  • Alex
  • A. Moreno
  • Chris Fickling
  • Stéphane Jäggi
  • Murray Wood
  • Anton Tarasov
  • JT Skaggs
  • deJaya
  • Lefthandmedia
  • eydolan
  • Following Sea
  • Guido Gallenkamp
  • YJ
  • Raffy
  • Snow Creative
  • Nick Clark
  • Guest
  • Helen
  • krisznet
  • Yanni
  • Richard

Budget

$194 per month—let's make that $500!

Learn more