$forms API variable / FormBuilder class

Create or edit forms and manage submitted entries.

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

Show $var?             Show args?        

Common

NameReturnSummary 
$forms->addNew(string $formName)
FormBuilderFormAdd a new form with the given name
$forms->akismetKey string 
$forms->count()
intReturn number of forms here, per Countable interface 
$forms->countEntries($id)
intReturn the number of entries for the given form ID 
$forms->csvDelimiter string Delimeter to use for CSV files 
$forms->csvUseBOM bool Include a UTF-8 BOM at the beginning of CSV files? 
$forms->delete(FormBuilderForm $form)
boolDelete the given $form
$forms->embed($formName)
stringGet the embed code for a given form 
$forms->embedCode string 
$forms->embedFields array Fields allowed for easy-embed 
$forms->embedTag string Easy embed tag 
$forms->entryToForm($entry)
bool FormBuilderFormGiven an entry array or ID return the FormBuilderForm object that it belongs to 
$forms->exportJSON($form)
stringReturn the JSON schema for the given form ID 
$forms->filesPath string Path for file attachments 
$forms->findEntries(string $keywords)
arrayFind form entries across all forms (or on specific form if specified) 
$forms->finished()
(nothing)Called when request has finished 
$forms->form($form)
FormBuilderFormConvert given value to FormBuilderForm if it isn’t already 
$forms->formID($formID)
intConvert given value to form ID if is isn’t already 
$forms->formLog($form, string $str)
WireLogRecord a log entry for FormBuilder 
$forms->formName($formName)
intConvert given value to form name if is isn’t already 
$forms->forms()
FormBuilderMainPlaceholder function for FormBuilderMain variable to ensure it's only instantiated when needed 
$forms->frameworksPath()
stringReturn the path where frameworks are stored 
$forms->frameworksURL()
stringReturn the URL where frameworks are stored 
$forms->fromEmail string Default from email for sent emails 
$forms->get(string $key)
mixedRetrieve a config variable or a form, depending on the key 
$forms->getEmbedVersion()
stringReturns a form embed key for matching request to response 
$forms->getEntry(int $entryID)
array boolGet a form entry by ID 
$forms->getFileFromKey(string $key)
bool stringRetrieve a filename from a transportable key 
$forms->getFileKey($formID, int $entryID, string $filename)
bool stringGenerate a transportable key for the given filename within a form and entry 
$forms->getFileURL($formID, int $entryID, string $filename)
bool stringReturn a URL where the given file can be viewed 
$forms->getFilesPath()
stringReturn path that FormBuilder uses for storing files
$forms->getFormName($id)
stringGet the name of a form 
$forms->getFormNames()
array stringGet names of all forms (indexed by form ID) 
$forms->getFramework(FormBuilderForm $form)
FormBuilderFramework nullGet the framework used by the given $form 
$forms->getFromURL()
FormBuilderForm FormBuilderRender stringLoad form from URL (for embed method a or b) 
$forms->getHelpers(string $for)
arrayRetrieve all themes or frameworks files 
$forms->getIterator()
ArrayObjectMake this module iterable, as required by the IteratorAggregate interface 
$forms->getTemplateVersion()
intGet the template version set from form-builder.php 
$forms->hasPermission(string $name, $form)
boolCheck if the current user has the permission name for the given $form 
$forms->helperPath(string $for)
stringGet path for 'themes' or 'frameworks' helpers 
$forms->importJSON($form, string $json)
boolImport to form ID the given JSON schema 
$forms->inputfieldClasses array Inputfield classes allowed for form fields 
$forms->installer()
FormBuilderInstall@return FormBuilderInstall 
$forms->isForm($id)
boolGiven a form ID or name, returns true if is used by a form, false if not 
$forms->isReservedName(string $name)
boolReturns whether or not the given $name may be used or a form or field name 
$forms->isValidLicense()
(nothing) 
$forms->lastMaint int Timestamp of the last time maintenance was performed 
$forms->licenseKey string  
$forms->load($id)
FormBuilderForm array nullRetrieve a form by $id, $name or specify boolean true to return all forms
$forms->loadAll()
arrayLoad all forms 
$forms->loadHooksFile()
(nothing)Load the optional /site/templates/form-builder.inc hooks file 
$forms->mailer string WireMail mailer to use for sending email, 'WireMail' to force native PHP mail(), or blank for auto-detect.  
$forms->maintenance()
NumberPerform form maintenance on all forms (or a specific form, if given) 
$forms->render($form)
FormBuilderRenderRender a form directly (embed method C)
$forms->save(FormBuilderForm $form)
boolSave the given $form
$forms->saveEntry(array $entry)
bool intSave a form entry 
$forms->setTemplateVersion(int $version)
(nothing)Set the form-builder.php template version, to be called from form-builder.php 
$forms->themesPath()
stringReturn the path where themes are stored 
$forms->themesURL()
stringReturn the URL where themes are stored 
$forms->upgrade($fromVersion, $toVersion)
(nothing)Upgrade the module
$forms->useRoles int bool Enable access control? 
$forms->viewFile(string $key)
(nothing)Outputs the given file, must be located under getFilesPath() 
$forms->wired()
(nothing)Wired to API 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • 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.