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

Twitter updates

  • ProcessWire 3.0.142 has a lot of updates but the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look at that, and also outline all of the new features in the just-released FormBuilder v40— More
    11 October 2019
  • This week’s dev branch version brings you improvements to ProcessWire’s input->cookie API variable, plus it adds the ability to modify system URLs and paths at runtime. This post also includes some examples to demonstrate just how useful this can be— More
    20 September 2019
  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019

Latest news

  • ProcessWire Weekly #283
    The 283rd issue of ProcessWire Weekly introduces ProcessWire 3.0.142 and FormBuilder v40, highlights some conference content, and features a new weekly poll continuing with the #processwireworks theme. Read on!
    Weekly.pw / 12 October 2019
  • ProcessWire 3.0.142 core updates
    This latest version of the core on the dev branch has a lot of updates, bnd the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look and also outline all of the new features in the just-released FormBuilder v40.
    Blog / 11 October 2019
  • 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