FormBuilderField::getInputfield()

Get new Inputfield for this FormBuilderField (for public API usage)

Please note:

  • Returns a new Inputfield instance on every call.
  • Returned Inputfield has no value assigned yet.
  • This method is NOT used for forms rendered or processed by FormBuilder (see FormBuilderMaker::makeInputfield for that)
  • This method can be used by the entries CSV Export function for some Inputfield types.
  • This method is very similar to FormBuilderMaker::makeInputfield() and should mirror most of what it does, but the context is different enough that they need to be separate methods. The context of this method is more specific to public API usage or other cases where an Inputfield is needed, but we are not in a case where an entire form will be rendered or processed.

Available since version 0.4.4.

Usage

// basic usage
$inputfield = $formBuilderField->getInputfield();

// usage with all arguments
$inputfield = $formBuilderField->getInputfield(array $options = []);

Arguments

NameType(s)Description
$options (optional)array
  • language (Language|int|string): Optionally get for this non-default language
  • type (string): Type to use, or omit to use type assigned to this FormBuilderField

Return value

Inputfield

FormBuilderField methods and properties

API reference based on ProcessWire core version 3.0.251