FieldTypes reference

This page contains FieldTypes reference introduced = with eZ Publish 5.x.
FiledTypes were known as DataTyp= es in eZ Publish 4.x, and are still used in "Dual kernel" eZ Publish= 5.x. If you would like more details please refer to the 4.x DataTypes reference documentation page= .

For the general FieldType documentation see Field Type API and best practices.

If you are looking for the documentation on how to implement a custom Fi= eldType, see eZ P= ublish 5 Field Type Tutorial.

A FieldType is the smallest possible entity of storage. It determi= nes how a specific type of information should be validated, stored, retriev= ed, formatted and so on. eZ Publish comes with a collection of fundamental = datatypes that can be used to build powerful and complex content structures= . In addition, it is possible to extend the system by creating custom Field= Types for special needs. Custom FieldTypes have to be programmed in PH= P. However, the built in FieldTypes are usually sufficient enough for = typical scenarios. The following table gives an overview of the supported F= ieldTypes that come with eZ Publish.

FieldType	Description	Searchable in Legacy Storage engin= e
`Author`	Field type used to store a list of authors, cons= isting of author name, and author email.	No.
`BinaryFile`	Field type used to store a file.	Yes.
`Checkbox`	Field type which stores boolean values.	Yes.
`Country`	This field type stores country names as a string= .	Yes.
`DateAndTime`	Field type used to store a full date including t= ime information.	Yes.
`Date`	Field type used to store a date in= formation.	Yes.
`EmailAddress`	This field type is used to validate and store an= email address.	Yes.
`Float`	Field type used to validate and store a decimal = value.	No.
`Image`	Field type used to validate and store an image.<= /td>	No.
`Integer`	Field type which validates and stores an integer= value.	Yes.
ISBN	Handles International Standard Boo= k Number (ISBN) in 10-digit or 13-digit format.	Yes.
`Keyword`	Field type used to store keywords.	No.
`MapLocation`	Field type used to store map coordinates.	Yes, with MapLocationDistance crit= erion.
Matrix	Available via community Bundle: https://github.com/ezcommunity/EzMatrixField= TypeBundle
`Media`	Validates and stores a media file.	No.
`Null`	This field type is used for fallback for missing= field types and for testing purposes.	No.
`Page`	Field type used to manage display = zones and blocks in a page (formerly known as eZ Flow datatype).	No.
Price	Available via community Bundle: https://github.com/ezcommunity/EzPriceBundle
`Rating`	Field type which stores a rating.	No.
`Relation`	Field type which validates and sto= res a relation to a content item.	Yes, with both Field and FieldRela= tion criterions.
`RelationList`	Field type that validates and stor= es a list of relations to content items.	Yes, with FieldRelation criterion.=
`Selection`	Field type which validates and sto= res a single selection or multiple choices from a list of options.	Yes.
Selection2	Available via community Bund= le: https://github.com/netgen/Netg= enEnhancedSelectionBundle
Tags	Available via community Bund= le: https://github.com/netgen/TagsBundle
`TextBlock`	Validates and stores a larger bloc= k of text.	No.
`TextLine`	This field type validates and stor= es a single line of text.	Yes.
`Time`	Field type used to store a time in= formation.	Yes.
`Url`	Field type used to store an URL / = address.	No.
`User`	Field type that validates and stor= es information about a user.	No.
`XmlText`	Field type that validates and stor= es multiple lines of formatted text..	Yes.

Known missing field t= ypes

The following FieldTypes are configured using Null FieldType to avoid exceptions if they = exists in your database, but their functionality is currently not known to = be implemented out of the box or by the community:

EZP-20112 - Some Shop FieldTypes are not supported by Public API=20 Backlog

EZP-20115 - eZ Identifier FieldType not supported by Public API= =20 Backlog

EZP-20114 = - Deprecated FieldTypes (ezenum, ezinisetting, ezpa= ckage) not supported by Public API=20 Closed

EZP-20116 = - eZ SubtreeSubscription FieldType not supported by= Public API=20 Closed

EZP-20117 = - eZ Survey FieldType not supported by Public API=20 Closed

EZP-20118 - eZ Password Expiry FieldType not supported by Public API=20 Backlog