InputfieldText class

Single line of text

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldText class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Common

Name	Return	Summary
InputfieldText::getAttributes() InputfieldText::getAttributes() InputfieldText::getAttributes()	`array`	Get all attributes in an associative array
InputfieldText::getConfigAllowContext() InputfieldText::getConfigAllowContext(Field $field) InputfieldText::getConfigAllowContext(Field $field)	`array`	Get array of field names allowed for field/template context
InputfieldText::getConfigInputfields() InputfieldText::getConfigInputfields() InputfieldText::getConfigInputfields()	`InputfieldWrapper`	Get field configuration
InputfieldText::getDefaultMaxlength() InputfieldText::getDefaultMaxlength() InputfieldText::getDefaultMaxlength()	`int`	Get the default maxlength attribute value
InputfieldText::initValue	`string`	Optional initial/default value
InputfieldText::maxlength	`int`	Maximum allowed length of value
InputfieldText::minlength	`int`	Minimum allowed length of value (usually combined with 'required' option)
InputfieldText::noTrim	`bool`	By default whitespace is trimmed from value, set this to true to bypass that behavior (default=false).
InputfieldText::pattern	`string`	HTML5 pattern attribute
InputfieldText::placeholder	`string`	Placeholder attribute text
InputfieldText::processInput() InputfieldText::processInput(WireInputData $input) InputfieldText::processInput(WireInputData $input)	`$this`	Process input
InputfieldText::render() InputfieldText::render() InputfieldText::render()	`string`	Render Inputfield
InputfieldText::renderReady() InputfieldText::renderReady() InputfieldText::renderReady(Inputfield $parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldText::renderValue() InputfieldText::renderValue() InputfieldText::renderValue()	`string`	Render just the value (not input) in text/markup for presentation purposes.
InputfieldText::requiredAttr	`bool` `int`	When combined with "required" option, this also makes it use the HTML5 "required" attribute. (default=false)
InputfieldText::setAttribute() InputfieldText::setAttribute($key, $value) InputfieldText::setAttribute($key, $value)	`Inputfield` `InputfieldText` `this`	Set an attribute
InputfieldText::showCount	`int`	Show a character counter (1) or word counter (2) or neither (0). Recommended value is 1 when using minlength or maxlength.
InputfieldText::size	`int`	Size of input or 0 for full width
InputfieldText::stripTags	`bool`	Should HTML tags be stripped from value?
InputfieldText::type	`string`	Input type (typically "text")
InputfieldText::useLanguages	`bool`	When combined with multi-language support, setting this to true will provide one input per language. Get/set each language value with the "value[languageID]" property, and just "value" for default language.
InputfieldText::wired() InputfieldText::wired() InputfieldText::wired()	(nothing)	Wired to API

Additional methods and properties

In addition to the methods and properties above, InputfieldText also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Single line of text

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news