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

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani