Inputfield::attr() method

Get or set an attribute (or multiple attributes)

  • To get an attribute call this method with just the attribute name.
  • To set an attribute call this method with the attribute name and value to set.
  • You can also set multiple attributes at once, see examples below.
  • To get all attributes, just specify boolean true as first argument (since 3.0.16).

Example

// Get the "value" attribute
$value = $inputfield->attr('value');

// Set the "value" attribute
$inputfield->attr('value', 'Foo and Bar');

// Set multiple attributes
$inputfield->attr([
  'name' => 'foobar',
  'value' => 'Foo and Bar',
  'class' => 'foo-bar',
]);

// Set name and id attribute to "foobar"
$inputfield->attr("name+id", "foobar");

// Get all attributes in associative array (since 3.0.16)
$attrs = $inputfield->attr(true); 

Usage

// basic usage
$inputfield = $inputfield->attr($key);

// usage with all arguments
$inputfield = $inputfield->attr($key, $value = null);

Arguments

NameType(s)Description
keystring, array, bool

Specify one of the following:

  • Name of attribute to get (if getting an attribute).
  • Name of attribute to set (if setting an attribute, and also specifying a value).
  • Aassociative array to set multiple attributes.
  • String with attributes split by "+" or "|" to set them all to have the same value.
  • Specify boolean true to get all attributes in an associative array.
value (optional)string, int, bool, null

Value to set (if setting), omit otherwise.

Return value

Inputfield array string int object float

If setting an attribute, it returns this instance. If getting an attribute, the attribute is returned.

See Also


Inputfield methods and properties

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • 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