InputfieldForm class

Contains one or more fields in a form

Here is an example of creating an InputfieldForm using Inputfield modules. This particular example is an email subscription form.

$form = $modules->get('InputfieldForm');

$f = $form->InputfieldText;
$f->attr('name', 'your_name');
$f->label = 'Your Name';
$form->add($f);

$f = $form->InputfieldEmail;
$f->attr('name', 'your_email');
$f->label = 'Your Email Address';
$f->required = true;
$form->add($f);

$f = $form->InputfieldSubmit;
$f->attr('name', 'submit_subscribe');
$f->val('Subscribe');
$form->add($f);

// ProcessWire versions 3.0.205+
if($form->isSubmitted('submit_subscribe')) {
  if($form->process()) {
    $name = $form->getValueByName('your_name');
    $email = $form->getValueByName('your_email');
    echo "<h3>Thank you, you have been subscribed!</h3>";
  } else {
    echo "<h3>There were errors, please fix</h3>";
    echo $form->render();
  }
} else {
  // form not submitted, just display it
  echo $form->render();
}

// same as above but works in any ProcessWire version
if($input->post('submit_subscribe')) {
  // form submitted
  $form->processInput($input->post);
  $errors = $form->getErrors();
  if(count($errors)) {
    // unsuccessful submit, re-display form
    echo "<h3>There were errors, please fix</h3>";
    echo $form->render();
  } else {
    // successful submit (save $name and $email somewhere)
    $name = $form->getChildByName('your_name')->attr('value');
    $email = $form->getChildByName('your_email')->attr('value');
    echo "<h3>Thank you, you have been subscribed!</h3>";
  }
} else {
  // form not submitted, just display it
  echo $form->render();
}

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

Show class?             Show args?        

Common

NameReturnSummary 
InputfieldForm::action string Form action attribute (default="./") 
InputfieldForm::appendMarkup string Optional markup to append to the form output 
InputfieldForm::columnWidthSpacing int Optionally set the column width spacing (pixels) 
InputfieldForm::confirmText string Confirmation text that precedes list of changes when class InputfieldFormConfirm is active 
InputfieldForm::description string Optionally set a description headline for the form 
InputfieldForm::getFormName()
stringGet name for this form 
InputfieldForm::getInput()
WireInputData nullReturn WireInputData provided to processInput() method or null if not yet applicable 
InputfieldForm::isSubmitted()
bool stringIs form submitted and ready to process? 
InputfieldForm::method string Form method attribute (default="post") 
InputfieldForm::prependMarkup string Optional markup to prepend to the form output 
InputfieldForm::process()
boolProcess the form
InputfieldForm::processInput(WireInputData $input)
InputfieldWrapperProcess input
InputfieldForm::protectCSRF bool Set to false to disable automatic CSRF protection 
InputfieldForm::render()
stringRender form
InputfieldForm::renderOrProcessReady($type)
(nothing)Hook called before form render or process (3.0.171+)

Errors

NameReturnSummary 
InputfieldForm::getErrors()
arrayReturn an array of errors that occurred on any of the children during input processing. 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani