InputfieldSubmit class

Form submit button

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.

Show class?             Show args?        

Common

NameReturnSummary 
addActionLink(string $url, string $label)
(nothing)Add a dropdown action item that links to a URL 
addActionValue(string $value, string $label)
(nothing)Add a dropdown action item that populates a new 'value' for the submit button 
get($key)
mixed nullGet a property or attribute from the Inputfield 
header bool Whether or not button will also appear in header (default=false).  
html string Button inner HTML label (default='') @since 3.0.134 
processInput(WireInputData $input)
$thisProcess input
render()
stringRender the button
renderReady()
boolRender ready 
secondary bool Whether or not button is secondary (default=false).  
set($key, $value)
Inputfield WireDataSet a property or attribute to the Inputfield 
setAttribute($key, $value)
(nothing) 
setSecondary()
$thisMake this button secondary? (slightly faded) 
setSmall()
$thisMake this button small? 
showInHeader()
$thisShow another copy of this button in the header? 
small bool Whether or not button should be small, where supported (default=false).  
submitValue string false Value that was submitted if clicked (default=false) @since 3.0.134 
text string Button inner TEXT label, if $html not provided. (default='') @since 3.0.134 
textClass string Class applied to span for inner html/text, omitted if blank (default='ui-button-text') @since 3.0.134 
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.244

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.