| FormBuilderProcessor::action2 | string | URL to send duplicate submission to | |
| FormBuilderProcessor::action2_add | array | array of name=value to add to duplicate submission | |
| FormBuilderProcessor::action2_remove | array | array of field names to remove from duplicate submission | |
| FormBuilderProcessor::action2_rename | array | array of field names rename before duplicate submission | |
FormBuilderProcessor::addEntryReady() FormBuilderProcessor::addEntryReady(array $data, InputfieldForm $form) FormBuilderProcessor::addEntryReady(array $data, InputfieldForm $form) | array | Called when new entry is about to be added. Return value is entry data that will be saved. | |
FormBuilderProcessor::addError() FormBuilderProcessor::addError(string $text) FormBuilderProcessor::addError(string $text, bool $prepend = false) | (nothing) | Add an error message that is shown to the user | |
FormBuilderProcessor::addWarning() FormBuilderProcessor::addWarning(string $text) FormBuilderProcessor::addWarning(string $text, bool $prepend = false) | (nothing) | Add a warning that can be shown to user but does not prevent form submission | |
FormBuilderProcessor::addedEntry() FormBuilderProcessor::addedEntry(array $data, InputfieldForm $form) FormBuilderProcessor::addedEntry(array $data, InputfieldForm $form) | array | Hook called after new entry has been added | |
FormBuilderProcessor::adminError() FormBuilderProcessor::adminError(string $text) FormBuilderProcessor::adminError(string $text) | (nothing) | Add an error message that is ony shown if user has form-builder permission | |
| FormBuilderProcessor::akismet | string | CSV string containing field names of: "name,email,content" (in that order) | |
| FormBuilderProcessor::allowPreset | bool | allow form field values to be pre-set from GET variables? | |
FormBuilderProcessor::allowSavePageField() FormBuilderProcessor::allowSavePageField(Page $page, string $pageFieldName, string $formFieldName, string $value, array $entry) FormBuilderProcessor::allowSavePageField(Page $page, string $pageFieldName, string $formFieldName, string $value, array $entry) | bool | Returns true if given value should be saved, false if not | |
FormBuilderProcessor::appendMarkup() FormBuilderProcessor::appendMarkup(string $markup) FormBuilderProcessor::appendMarkup(string $markup) | (nothing) | Add markup to append to the form | |
FormBuilderProcessor::clearErrors() FormBuilderProcessor::clearErrors() FormBuilderProcessor::clearErrors(bool $all = true) | (nothing) | Clear all errors and warnings | |
FormBuilderProcessor::emailForm() FormBuilderProcessor::emailForm(InputfieldForm $form, array $data) FormBuilderProcessor::emailForm(InputfieldForm $form, array $data, string $emailTo = '') | bool int | Email the form result to the administrator(s) | |
FormBuilderProcessor::emailFormPopulateSkipFields() FormBuilderProcessor::emailFormPopulateSkipFields(FormBuilderEmail $email, InputfieldForm $form) FormBuilderProcessor::emailFormPopulateSkipFields(FormBuilderEmail $email, InputfieldForm $form) | (nothing) | Called for all emails to specify field names to skip sending in email, i.e. `$email->setSkipFieldName($name);` | |
FormBuilderProcessor::emailFormReady() FormBuilderProcessor::emailFormReady(InputfieldForm $form, FormBuilderEmail $email) FormBuilderProcessor::emailFormReady(InputfieldForm $form, FormBuilderEmail $email) | bool | Called when $email object is ready, but message not yet sent. | |
FormBuilderProcessor::emailFormResponder() FormBuilderProcessor::emailFormResponder(InputfieldForm $form, array $data) FormBuilderProcessor::emailFormResponder(InputfieldForm $form, array $data) | bool | Email the form result to the sending (auto-responder) | |
FormBuilderProcessor::emailFormResponderReady() FormBuilderProcessor::emailFormResponderReady(InputfieldForm $form, FormBuilderEmail $email) FormBuilderProcessor::emailFormResponderReady(InputfieldForm $form, FormBuilderEmail $email) | bool | Called when $email object ready, but message not yet sent. | |
| FormBuilderProcessor::emailFrom | string | email address (or field name where it resides) to use as the reply-to address for the email. | |
| FormBuilderProcessor::emailFrom2 | string | email from address, if different the one specified in module settings and reply-to address. | |
| FormBuilderProcessor::emailSubject | string | subject of email that gets sent | |
| FormBuilderProcessor::emailTo | string | email address to send form submissions to, may also be multiple (1 per line) or conditional (1 condition per line) | |
| FormBuilderProcessor::embedVer | string | | |
FormBuilderProcessor::entries() FormBuilderProcessor::entries() FormBuilderProcessor::entries() | FormBuilderEntries | Get the FormBuilderEntries object for the current form
Can also be used as property: FormBuilderProcessor::entries | |
| FormBuilderProcessor::errorMessage | string | message to display when a form error occurred | |
FormBuilderProcessor::executePluginActions() FormBuilderProcessor::executePluginActions(string $methodName) FormBuilderProcessor::executePluginActions(string $methodName, $data = null) | array | Run a method on all FormBuilderProcessorAction (pluginAction) modules | |
| FormBuilderProcessor::fbForm | FormBuilderForm | | |
| FormBuilderProcessor::fbRender | FormBuilderRender | | |
| FormBuilderProcessor::formName | string | name of the form | |
FormBuilderProcessor::formToEntry() FormBuilderProcessor::formToEntry(InputfieldForm $form) FormBuilderProcessor::formToEntry(InputfieldForm $form, int $id = 0, bool $merge = false) | array | Converts the submitted InputfieldForm object to an entry data array | |
| FormBuilderProcessor::forms | FormBuilder | FormBuilder API variable | |
| FormBuilderProcessor::framework | string | form framework, if in use | |
FormBuilderProcessor::get() FormBuilderProcessor::get(string $key) FormBuilderProcessor::get(string $key) | mixed | Get property | |
FormBuilderProcessor::getEntries() FormBuilderProcessor::getEntries() FormBuilderProcessor::getEntries() | FormBuilderEntries | Get the FormBuilderEntries object for the current form (legacy alias) | |
FormBuilderProcessor::getEntry() FormBuilderProcessor::getEntry() FormBuilderProcessor::getEntry(int $id = 0) | array null | Get the current form entry, or null if not present | |
FormBuilderProcessor::getEntryID() FormBuilderProcessor::getEntryID() FormBuilderProcessor::getEntryID() | int | Get the current entry ID, or 0 if not present | |
FormBuilderProcessor::getErrors() FormBuilderProcessor::getErrors() FormBuilderProcessor::getErrors(bool $all = true, bool $clear = false) | array | Return an array of errors that occurred (strings) | |
FormBuilderProcessor::getFbForm() FormBuilderProcessor::getFbForm() FormBuilderProcessor::getFbForm() | FormBuilderForm | Get current FormBuilderForm object | |
FormBuilderProcessor::getFormArray() FormBuilderProcessor::getFormArray() FormBuilderProcessor::getFormArray() | array | Get the array upon which this form is based (same as what was passed to constructor) | |
FormBuilderProcessor::getFormUrl() FormBuilderProcessor::getFormUrl() FormBuilderProcessor::getFormUrl(array $options = []) | string | Get the URL for the given form | |
FormBuilderProcessor::getInputfieldsForm() FormBuilderProcessor::getInputfieldsForm() FormBuilderProcessor::getInputfieldsForm() | InputfieldForm | Get the constructed form | |
FormBuilderProcessor::getSavePage() FormBuilderProcessor::getSavePage() FormBuilderProcessor::getSavePage() | NullPage Page | Get page that was saved | |
FormBuilderProcessor::getSubmitType() FormBuilderProcessor::getSubmitType() FormBuilderProcessor::getSubmitType() | bool int null | Get the form submit type | |
FormBuilderProcessor::getValues() FormBuilderProcessor::getValues() FormBuilderProcessor::getValues() | array | Get an array of all values from this form | |
FormBuilderProcessor::getWarnings() FormBuilderProcessor::getWarnings() FormBuilderProcessor::getWarnings(bool $clear = false) | array | Return an array of warnings that occurred (strings) | |
| FormBuilderProcessor::googleSheetsResponseField | string | | |
| FormBuilderProcessor::googleSpreadsheetFields | array | | |
| FormBuilderProcessor::googleSpreadsheetUrl | string | | |
FormBuilderProcessor::hasErrors() FormBuilderProcessor::hasErrors() FormBuilderProcessor::hasErrors() | bool | Are there any errors present on form or in this processor? | |
| FormBuilderProcessor::honeypot | string | name of field that, when populated, invalidates the form submission | |
| FormBuilderProcessor::id | int | Form ID number | |
FormBuilderProcessor::initError() FormBuilderProcessor::initError(string $text) FormBuilderProcessor::initError(string $text) | (nothing) | Add an initialization error, must be called during initialization to be shown | |
FormBuilderProcessor::isAdmin() FormBuilderProcessor::isAdmin() FormBuilderProcessor::isAdmin() | bool | Are we currently in the FormBuilder admin? | |
FormBuilderProcessor::isSpam() FormBuilderProcessor::isSpam() FormBuilderProcessor::isSpam() | bool string | Returns name of triggered spam filter when entry detected as spam | |
FormBuilderProcessor::isSubmitted() FormBuilderProcessor::isSubmitted() FormBuilderProcessor::isSubmitted() | bool | Was the form successfully submitted? (for public API) | |
FormBuilderProcessor::loadEntry() FormBuilderProcessor::loadEntry($entryID) FormBuilderProcessor::loadEntry($entryID) | InputfieldForm | Load entry by ID or name and populate to form | |
| FormBuilderProcessor::mailer | string | Name of WireMail module to use for sending email, 'WireMail' for native PHP mail(), or blank for auto-detect. | |
FormBuilderProcessor::maker() FormBuilderProcessor::maker() FormBuilderProcessor::maker() | FormBuilderMaker | @return FormBuilderMaker
Can also be used as property: FormBuilderProcessor::maker | |
FormBuilderProcessor::pageSaver() FormBuilderProcessor::pageSaver() FormBuilderProcessor::pageSaver() | FormBuilderProcessorSavePage | @return FormBuilderProcessorSavePage | |
| FormBuilderProcessor::partialEntries | FormBuilderPartialEntries | | |
| FormBuilderProcessor::pluginActions | array | | |
FormBuilderProcessor::populate() FormBuilderProcessor::populate(array $data) FormBuilderProcessor::populate(array $data, int $entryID = 0) | InputfieldForm | Populate the form with the key=value data given in the array | |
FormBuilderProcessor::postAction2() FormBuilderProcessor::postAction2(array $data) FormBuilderProcessor::postAction2(array $data) | bool | Sends data to external URL specified in action2_* form settings. | |
FormBuilderProcessor::postAction2Ready() FormBuilderProcessor::postAction2Ready($http, array $data, $method, $url, array $headers) FormBuilderProcessor::postAction2Ready($http, array $data, $method, $url, array $headers) | bool string | Called when ready to send to external URL. Returns response string or boolean false on fail. | |
FormBuilderProcessor::processInput() FormBuilderProcessor::processInput($id, $submitType) FormBuilderProcessor::processInput($id, $submitType) | bool | Process input for submitted form. If $id is populated, it is the id of existing form entry. | |
FormBuilderProcessor::processInputDone() FormBuilderProcessor::processInputDone(InputfieldForm $form) FormBuilderProcessor::processInputDone(InputfieldForm $form) | (nothing) | Called after $form->processInput() and spam filtering is completed. | |
FormBuilderProcessor::processInputIsSpam() FormBuilderProcessor::processInputIsSpam(InputfieldForm $form) FormBuilderProcessor::processInputIsSpam(InputfieldForm $form) | string | Checks for spam and returns name of spam filter that was triggered, or blank string if not spam. | |
FormBuilderProcessor::processInputReady() FormBuilderProcessor::processInputReady(InputfieldForm $form, $submitType) FormBuilderProcessor::processInputReady(InputfieldForm $form, $submitType) | (nothing) | Called right before $form->processInput() is called. | |
FormBuilderProcessor::processInputSpammed() FormBuilderProcessor::processInputSpammed(InputfieldForm $form, string $spamType) FormBuilderProcessor::processInputSpammed(InputfieldForm $form, string $spamType) | (nothing) | Hook called when processInput fails due to being spammed | |
FormBuilderProcessor::render() FormBuilderProcessor::render() FormBuilderProcessor::render($id = null) | string | Return the rendered form output, whether an actual form or the success message after submitted. | |
FormBuilderProcessor::renderError() FormBuilderProcessor::renderError($error) FormBuilderProcessor::renderError($error, $errorTemplate = '') | string | Render single error message into markup. | |
FormBuilderProcessor::renderErrors() FormBuilderProcessor::renderErrors() FormBuilderProcessor::renderErrors($errors = [], bool $clear = false) | string | Render the given error messages for output | |
FormBuilderProcessor::renderErrorsReady() FormBuilderProcessor::renderErrorsReady(array $errors) FormBuilderProcessor::renderErrorsReady(array $errors) | array | Called when errors ready to render, hooks can optionally modify $event->return array of errors. | |
FormBuilderProcessor::renderOrProcessReady() FormBuilderProcessor::renderOrProcessReady(InputfieldForm $form, $submitType) FormBuilderProcessor::renderOrProcessReady(InputfieldForm $form, $submitType) | (nothing) | Called when ready to render OR process. Added 0.4.7 | |
FormBuilderProcessor::renderReady() FormBuilderProcessor::renderReady(InputfieldForm $form) FormBuilderProcessor::renderReady(InputfieldForm $form, $formFile = '', array $vars = array) | string | ) Called when ready to render, and returns rendered output. Note the $formFile and $vars arguments are only populated in embed method D. | |
FormBuilderProcessor::renderSubmitKey() FormBuilderProcessor::renderSubmitKey() FormBuilderProcessor::renderSubmitKey(string $submitKey = '') | string | Render the submitKey in a hidden form field, ready to be output | |
FormBuilderProcessor::renderSubmittedLandmark() FormBuilderProcessor::renderSubmittedLandmark() FormBuilderProcessor::renderSubmittedLandmark() | string | Render a markup landmark that indicates form was submitted (whether successfully or with errors) | |
FormBuilderProcessor::renderSuccess() FormBuilderProcessor::renderSuccess($message) FormBuilderProcessor::renderSuccess($message) | string | Render the given success message or success action string. | |
FormBuilderProcessor::renderSuccessMessage() FormBuilderProcessor::renderSuccessMessage($message) FormBuilderProcessor::renderSuccessMessage($message, $markupTemplate = '') | string | Render succcess message string only (called by renderSuccess). | |
FormBuilderProcessor::renderSuccessRedirect() FormBuilderProcessor::renderSuccessRedirect($url) FormBuilderProcessor::renderSuccessRedirect($url) | string | Render or execute a redirect to given $url (called by renderSuccess). | |
| FormBuilderProcessor::responderBody | string | Body for the responder email | |
| FormBuilderProcessor::responderFrom | string | Email address that the responder email should be from | |
| FormBuilderProcessor::responderFromName | string | Name responder should be from | |
| FormBuilderProcessor::responderReplyTo | string | Responder reply-to address | |
| FormBuilderProcessor::responderSubject | string | Subject line for the responder email | |
| FormBuilderProcessor::responderTo | string | field name (not email address) that WILL contain the submittor's email address (where the responder should be sent). CSV string for multiple. | |
FormBuilderProcessor::saveEntry() FormBuilderProcessor::saveEntry(array $data) FormBuilderProcessor::saveEntry(array $data) | int | Save form entry | |
| FormBuilderProcessor::saveFlags | int | Flags for saving form submission (default: self::saveFlagsDB) | |
FormBuilderProcessor::saveFlagsLabels() FormBuilderProcessor::saveFlagsLabels() FormBuilderProcessor::saveFlagsLabels($saveFlags = null, bool $getString = false) | array | Get array of labels for given saveFlags | |
FormBuilderProcessor::saveForm() FormBuilderProcessor::saveForm(InputfieldForm $form) FormBuilderProcessor::saveForm(InputfieldForm $form, $entry = 0, $submitType = null) | int | Save the form to the database entry, page, or email(s) per form action settings | |
FormBuilderProcessor::saveFormReady() FormBuilderProcessor::saveFormReady(InputfieldForm $form, array $entry, array $info) FormBuilderProcessor::saveFormReady(InputfieldForm $form, array $entry, array $info) | (nothing) | Hook called when form is about to be saved, has more info in arguments than saveForm() hook. Added 0.4.5 | |
FormBuilderProcessor::saveGoogleSheets() FormBuilderProcessor::saveGoogleSheets(InputfieldForm $form, array $data) FormBuilderProcessor::saveGoogleSheets(InputfieldForm $form, array $data) | bool | | |
FormBuilderProcessor::saveGoogleSheetsReady() FormBuilderProcessor::saveGoogleSheetsReady(GoogleSheets $sheets, array $row, array $data) FormBuilderProcessor::saveGoogleSheetsReady(GoogleSheets $sheets, array $row, array $data) | array | | |
FormBuilderProcessor::saveLog() FormBuilderProcessor::saveLog(string $message) FormBuilderProcessor::saveLog(string $message) | (nothing) | Save a log entry to the form-builder log | |
FormBuilderProcessor::savePage() FormBuilderProcessor::savePage(array $data) FormBuilderProcessor::savePage(array $data, int $status = null, $onlyFields = null) | Page null | Save the form entry to a Page | |
| FormBuilderProcessor::savePageAdjustName | bool int | Adjust page name as needed to ensure it is unique? (default=true) | |
FormBuilderProcessor::savePageCheckName() FormBuilderProcessor::savePageCheckName(Page $page) FormBuilderProcessor::savePageCheckName(Page $page) | bool | Check and update page name as needed for uniqueness | |
FormBuilderProcessor::savePageDone() FormBuilderProcessor::savePageDone(Page $page, array $data, bool $isNew, $onlyFields) FormBuilderProcessor::savePageDone(Page $page, array $data, bool $isNew, $onlyFields) | array | Hook called right after a page is saved | |
FormBuilderProcessor::savePageField() FormBuilderProcessor::savePageField(Page $page, string $name, string $value, array $entry) FormBuilderProcessor::savePageField(Page $page, string $name, string $value, array $entry) | bool | Returns true if given value should be saved, false if not (DEPRECATED) | |
| FormBuilderProcessor::savePageFields | array | array of 'processwire_field_id' => 'form_field_name' | |
FormBuilderProcessor::savePageFileField() FormBuilderProcessor::savePageFileField(Page $page, Field $field, array $filenames, string $formFieldName) FormBuilderProcessor::savePageFileField(Page $page, Field $field, array $filenames, string $formFieldName) | int | Save an individual files field to a Page | |
FormBuilderProcessor::savePageInit() FormBuilderProcessor::savePageInit(array $data, $status, $onlyFields) FormBuilderProcessor::savePageInit(array $data, $status, $onlyFields) | array | Get settings for saving a page | |
| FormBuilderProcessor::savePageParent | string | id of parent page | |
| (nothing) | Hook called right before a Page is about to be saved | |
| FormBuilderProcessor::savePageStatus | int | status of saved page (0 = don't save page now) | |
| FormBuilderProcessor::savePageSubfields | string | Newline separated string in format: form_field_name=page_field_name.subfield | |
| FormBuilderProcessor::savePageTemplate | string | name of template | |
FormBuilderProcessor::sessionGet() FormBuilderProcessor::sessionGet(string $key) FormBuilderProcessor::sessionGet(string $key, $default = null) | mixed null | Get a session value unique for this form | |
FormBuilderProcessor::sessionRemove() FormBuilderProcessor::sessionRemove(string $key) FormBuilderProcessor::sessionRemove(string $key) | (nothing) | Remove a session value unique for this form | |
FormBuilderProcessor::sessionSet() FormBuilderProcessor::sessionSet(string $key, mixed $value) FormBuilderProcessor::sessionSet(string $key, mixed $value) | (nothing) | Set a session value unique for this form | |
FormBuilderProcessor::set() FormBuilderProcessor::set(string $key, mixed $value) FormBuilderProcessor::set(string $key, mixed $value) | WireData | Set form processor setting | |
FormBuilderProcessor::setEntry() FormBuilderProcessor::setEntry(array $data) FormBuilderProcessor::setEntry(array $data) | (nothing) | Set current entry data | |
FormBuilderProcessor::setFbForm() FormBuilderProcessor::setFbForm(FormBuilderForm $fbForm) FormBuilderProcessor::setFbForm(FormBuilderForm $fbForm) | (nothing) | Set the FormBuilderForm instance | |
FormBuilderProcessor::setFbRender() FormBuilderProcessor::setFbRender(FormBuilderRender $renderer) FormBuilderProcessor::setFbRender(FormBuilderRender $renderer) | (nothing) | Set the FormBuilderRender instance | |
FormBuilderProcessor::setInputfieldsForm() FormBuilderProcessor::setInputfieldsForm(InputfieldForm $form) FormBuilderProcessor::setInputfieldsForm(InputfieldForm $form) | (nothing) | Set the InputfieldForm | |
FormBuilderProcessor::setSubmitType() FormBuilderProcessor::setSubmitType($submitType) FormBuilderProcessor::setSubmitType($submitType) | (nothing) | Set the form submit type | |
| FormBuilderProcessor::showHidden | bool | Show input[type=hidden] as type=text instead? Option may only be modified in construct $options. (default=false) | |
| FormBuilderProcessor::skipSessionKey | bool | Require a unique session key for each form submission (for security) | |
| FormBuilderProcessor::spamFlags | int | Spam flags | |
| FormBuilderProcessor::spamWords | array | Keywords that flag a form submission as spam. | |
FormBuilderProcessor::spammer() FormBuilderProcessor::spammer() FormBuilderProcessor::spammer() | FormBuilderProcessorSpam | @return FormBuilderProcessorSpam | |
| FormBuilderProcessor::submitText | string | text that appears on the submit button | |
| FormBuilderProcessor::successMessage | string | message to display on successful form submission, assuming no successUrl was set | |
| FormBuilderProcessor::successUrl | string | URL to redirect to on successful form submission | |
| FormBuilderProcessor::turingTest | array | array containing list of field names and required answers | |
FormBuilderProcessor::updateEntryReady() FormBuilderProcessor::updateEntryReady(array $data, InputfieldForm $form) FormBuilderProcessor::updateEntryReady(array $data, InputfieldForm $form) | array | Hook called when existing entry is about to be updated | |
FormBuilderProcessor::updatedEntry() FormBuilderProcessor::updatedEntry(array $data, InputfieldForm $form) FormBuilderProcessor::updatedEntry(array $data, InputfieldForm $form) | array | Hook called after existing entry has been updated | |
| FormBuilderProcessor::useCookies | bool | Remember input values? | |
FormBuilderProcessor::validSubmitKey() FormBuilderProcessor::validSubmitKey() FormBuilderProcessor::validSubmitKey(array $options = []) | bool string | Was posted submit key valid? | |
| FormBuilderProcessor::validateNumFields | bool | Validate quantity of fields present in form as part of the _submitKey? | |
FormBuilderProcessor::wrapOutput() FormBuilderProcessor::wrapOutput(string $out) FormBuilderProcessor::wrapOutput(string $out) | string | Wraps all FormBuilder output | |