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, 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.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 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