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 #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK