Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldSubmit class also inherits all the methods and properties of: Inputfield, WireData and Wire.
Common
| Name | Return | Summary | |
|---|
InputfieldSubmit::addActionLink() InputfieldSubmit::addActionLink(string $url, string $label) InputfieldSubmit::addActionLink(string $url, string $label, string $icon = '') | None | Add a dropdown action item that links to a URL | |
InputfieldSubmit::addActionValue() InputfieldSubmit::addActionValue(string $value, string $label) InputfieldSubmit::addActionValue(string $value, string $label, string $icon = '') | None | Add a dropdown action item that populates a new 'value' for the submit button | |
InputfieldSubmit::get() InputfieldSubmit::get($key) InputfieldSubmit::get($key) | None | | |
InputfieldSubmit::processInput() InputfieldSubmit::processInput(WireInputData $input) InputfieldSubmit::processInput(WireInputData $input) | $this | Process input | |
InputfieldSubmit::render() InputfieldSubmit::render() InputfieldSubmit::render() | string | Render the button | |
InputfieldSubmit::renderReady() InputfieldSubmit::renderReady() InputfieldSubmit::renderReady($parent = null, bool $renderValueMode = false) | bool | Render ready | |
InputfieldSubmit::set() InputfieldSubmit::set($key, $value) InputfieldSubmit::set($key, $value) | None | | |
InputfieldSubmit::setAttribute() InputfieldSubmit::setAttribute($key, $value) InputfieldSubmit::setAttribute($key, $value) | None | | |
InputfieldSubmit::setSecondary() InputfieldSubmit::setSecondary() InputfieldSubmit::setSecondary(bool $secondary = true) | $this | Make this button secondary? (slightly faded) | |
InputfieldSubmit::setSmall() InputfieldSubmit::setSmall() InputfieldSubmit::setSmall(bool $small = true) | $this | Make this button small? | |
| $this | Show another copy of this button in the header? | |
Properties
| Name | Return | Summary | |
|---|
| bool | Whether or not button will also appear in header .
DEFAULT: false | |
| InputfieldSubmit::html | string | Button inner HTML label 3.0.134
DEFAULT: '' | |
| InputfieldSubmit::secondary | bool | Whether or not button is secondary .
DEFAULT: false | |
| InputfieldSubmit::small | bool | Whether or not button should be small, where supported .
DEFAULT: false | |
| InputfieldSubmit::submitValue | string false | Value that was submitted if clicked 3.0.134
DEFAULT: false | |
| InputfieldSubmit::text | string | Button inner TEXT label, if $html not provided. 3.0.134
DEFAULT: '' | |
| InputfieldSubmit::textClass | string | Class applied to span for inner html/text, omitted if blank 3.0.134
DEFAULT: 'ui-button-text' | |
| InputfieldSubmit::value | string | Button value attribute and inner TEXT label, if $text it provided
DEFAULT: 'Submit' | |
Additional methods and properties
In addition to the methods and properties above, InputfieldSubmit also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.252