Inputfield::wrapAttr() method

Get or set attribute for the element wrapping this Inputfield

Use this method when you need to assign some attribute to the outer wrapper of the Inputfield.

Usage

// basic usage
$inputfield = $inputfield->wrapAttr();

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

Arguments

NameType(s)Description
key (optional)string, null, bool

Specify one of the following for $key:

  • Specify string containing name of attribute to set.
  • Omit (or null or true) to get all wrap attributes as associative array.
value (optional)string, null, bool

Specify one of the following for $value:

  • Omit if getting an attribute.
  • Value to set for $key of setting.
  • Boolean false to remove the attribute specified for $key.

Return value

Inputfield string array null

Returns one of the following:

  • If getting, returns attribute value of NULL if not present.
  • If setting, returns $this.

See Also


Inputfield methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer