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

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

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