Field represents a custom field that is used on a Page.

// Get an instance of Field
$field = $fields->get('field_name');

Field objects are managed by the $fields API variable.


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

Retrieval / Manipulation / Access / Advanced / Flags / Properties

Show “$field”             Show Arguments        

Retrieval

NameReturnSummary 
$field->get(string $key)
mixedGet a Field setting or dynamic data property
$field->getConfigInputfields()
InputfieldWrapperGet any Inputfields needed to configure the field in the admin.
$field->getDescription()
stringReturn field description for current language, or another specified language.
$field->getFieldgroups()
FieldgroupsArrayReturn the list of Fieldgroups using this field.
$field->getFieldtype()
Fieldtype or nullReturn the Fieldtype module representing this field’s type.
$field->getIcon()
mixed or stringReturn the icon used by this field, or blank if none.
$field->getInputfield(Page $page)
Inputfield or nullGet the Inputfield module used to collect input for this field.
$field->getLabel()
stringGet field label for current language, or another specified language.
$field->getNotes()
stringReturn field notes for current language, or another specified language.
$field->getTable()
stringGet the database table used by this field.
$field->getTemplates()
TemplatesArrayReturn the list of of Templates using this field.
$field->numFieldgroups()
intReturn the number of Fieldgroups this field is used in.

Manipulation

NameReturnSummary 
$field->save()
boolSave this field’s settings and data in the database.
$field->set(string $key, mixed $value)
Field or WireDataSet a native setting or a dynamic data property for this Field
$field->setDescription(string $text)
(nothing)Set description, optionally for a specific language
$field->setFieldtype($type)
FieldSet what type of field this is (Fieldtype).
$field->setIcon(string $icon)
$thisSet the icon for this field
$field->setLabel(string $text)
(nothing)Set label, optionally for a specific language
$field->setName(string $name)
FieldSet the field’s name
$field->setNotes(string $text)
(nothing)Set notes, optionally for a specific language
$field->setRoles(string $type, $roles)
(nothing)Set the roles that are allowed to view or edit this field on pages.

Access

NameReturnSummary 
$field->editRoles array Role IDs with edit access, applicable only if access control is enabled.
$field->editable()
boolIs this field editable?
$field->useRoles bool Whether or not access control is enabled
$field->viewRoles array Role IDs with view access, applicable only if access control is enabled.
$field->viewable()
boolIs this field viewable?

Advanced

NameReturnSummary 
$field->setTable()
(nothing)Set an override table name, or omit (or null) to restore default table name

Flags

NameReturnSummary 
$field->addFlag(int $flag)
$thisAdd the given bitmask flag
Field::flagAccess const32Field is access controlled
Field::flagAccessAPI const64If field is access controlled, this flag says that values are still front-end API accessible Without this flag, non-viewable values are made blank when output formatting is ON.
Field::flagAccessEditor const128If field is access controlled and user has no edit access, they can still view in the editor (if they have view permission) Without this flag, non-editable values are simply not shown in the editor at all.
Field::flagAutojoin const1Field should be automatically joined to the page at page load time
Field::flagFieldgroupContext const2048Field has been placed in a runtime state where it is contextual to a specific fieldgroup and is no longer saveable
Field::flagGlobal const4Field used by all fieldgroups - all fieldgroups required to contain this field
Field::flagPermanent const16Field is permanent in any fieldgroups/templates where it exists - it may not be removed from them
Field::flagSystem const8Field is a system field and may not be deleted, have it's name changed, or be converted to non-system
Field::flagSystemOverride const32768Set this flag to override system/permanent flags if necessary - once set, system/permanent flags can be removed, but not in the same set().
$field->hasFlag(int $flag)
boolDoes this field have the given bitmask flag?
$field->removeFlag(int $flag)
$thisRemove the given bitmask flag

Properties

NameReturnSummary 
$field->columnWidth int or null The Inputfield column width (percent) 10-100.
$field->description string Longer description text for the field
$field->flags int Bitmask of flags used by this field
$field->icon string Icon name used by the field, if applicable
$field->id int Numeric ID of field in the database
$field->label string Text string representing the label of the field
$field->name string Name of field
$field->notes string Additional notes text about the field
$field->prevFieldtype Fieldtype Previous Fieldtype, of type was changed
$field->prevTable string Previously database table (if field was renamed)
$field->required int or bool or null Whether or not this field is required during input
$field->requiredIf string or null A selector-style string that defines the conditions under which input is required
$field->showIf string or null A selector-style string that defines the conditions under which the Inputfield is shown
$field->table string Database table used by the field
$field->type Fieldtype or null Fieldtype module that represents the type of this field

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.60