ProcessField class

Edit individual fields that hold page data

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

Show class?             Show args?        

Common

NameReturnSummary 
ProcessField::allowFieldInTemplate(Field $field, Template $template)
boolFor hooks to modify if they want to specific prevent a field from being added to a template from here
ProcessField::buildEditForm()
InputfieldForm
ProcessField::buildEditFormActions(InputfieldForm $form)
InputfieldWrapper
ProcessField::buildEditFormAdvanced()
InputfieldWrapper
ProcessField::buildEditFormBasics()
InputfieldWrapper
ProcessField::buildEditFormDelete()
InputfieldWrapper
ProcessField::buildEditFormInfo($form)
InputfieldWrapperDeprecated, hook buildEditFormActions() instead.
ProcessField::execute()
stringRender a list of current fields
ProcessField::executeAdd()
(nothing)Add a new field
ProcessField::executeChangeType()
stringExecuted when a field type change is requested and provides an informative confirmation form
ProcessField::executeEdit()
(nothing)Edit an existing Field
ProcessField::executeExport()
stringExecute export
ProcessField::executeImport()
stringExecute import
ProcessField::executeNavJSON()
string arrayOutput JSON list of navigation items for this (intended to for ajax use)
ProcessField::executeSave()
(nothing)Save the results of a Field Edit
ProcessField::executeSaveChangeType()
(nothing)Save a changed field type
ProcessField::executeSendTemplates()
stringExecute send field to template(s)
ProcessField::executeSendTemplatesSave()
(nothing)Process the form from executeSendTemplates and redirect back to editor
ProcessField::executeTags()
stringHandle the “Manage Tags” actions 
ProcessField::fieldAdded(Field $field)
(nothing)For hooks to listen to when a new field is added
ProcessField::fieldChangedContext(Field $field, Fieldgroup $fieldgroup, array $changes)
(nothing)Hook called when field context is changed and saved
ProcessField::fieldChangedType(Field $field)
(nothing)For hooks to listen to when a field type changes
ProcessField::fieldDeleted(Field $field)
(nothing)For hooks to listen to when a field is deleted
ProcessField::fieldSaved(Field $field)
(nothing)For hooks to listen to when any field is saved
ProcessField::getAfterLoginUrl(Page $page)
stringURL to redirect to after non-authenticated user is logged-in, or false if module does not support 
ProcessField::getField()
Field nullReturn the current field being edited, or NULL if it hasn't been set 
ProcessField::getListFilterForm()
InputfieldFormRenders filtering options when viewing a list of Fields
ProcessField::getListTable(array|Fields $fields)
MarkupAdminDataTable
ProcessField::getListTableRow(Field $field)
array
ProcessField::listAfterSave bool 
ProcessField::renderListJSON()
stringRender JSON map of all fields (old method, but should be kept for backwards compatibility) 
ProcessField::saveContext()
(nothing)
ProcessField::search(string $text)
arraySearch for items containing $text and return an array representation of them 
ProcessField::upgrade($fromVersion, $toVersion)
(nothing)Upgrade module from one version to another

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer