Field Types reference

This page contains a reference of Field Types used in eZ Platfor= m.
Field Types were known as DataTypes in legacy eZ Publish. If you woul= d like more details about them, please refer to the 4.x DataTypes reference documentation page.

For the general Field Type documentation see Field Type API and best practices.<= /p>

If you are looking for the documentation on how to implement a custom Fi= eld Type, see Field Type T= utorial.

A Field Type is the smallest possible entity of storage. It determ= ines how a specific type of information should be validated, stored, retrie= ved, formatted and so on. eZ Platform comes with a collection of fundamenta= l types that can be used to build powerful and complex content structures. = In addition, it is possible to extend the system by creating custom Field T= ypes for special needs. Custom Field Types have to be programmed in PH= P. However, the built-in Field Types are usually sufficient enough for= typical scenarios. The following table gives an overview of the supported = Field Types that come with eZ Platform.

FieldType	Description	Searchable in Legacy Storage engin= e
`Author`	Stores a list of authors, each consisting of aut= hor name and author email.	No
`BinaryFile`	Stores a file.	Yes
`Checkbox`	Stores a boolean value.	Yes
`Country`	Stores country names as a string.	Yes
`DateAndTime`	Stores a full date including time information.	Yes
`Date`	Stores date information.	Yes
`EmailAddress`	Validates and stores an email address.	Yes
`Float`	Validates and stores a decimal value.	No
`Image`	Validates and stores an image.	No
`Integer`	Validates and stores an integer value.	Yes
ISBN	Handles International Standard Boo= k Number (ISBN) in 10-digit or 13-digit format.	Yes
`Keyword`	Stores keywords.	No
`MapLocation`	Stores 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`	Used as fallback for missing Field Types and for= testing purposes.	No
`Page`	Used to manage display zones and b= locks in a page (formerly known as eZ Flow datatype).	No
Price	Available via community Bundle: https://github.com/ezcommunity/EzPriceBundle
`Rating`	Stores a rating.	No
`Relation`	Validates and stores a relation to= a Content item.	Yes, with both Field and FieldRela= tion criterions
`RelationList`	Validates and stores a list of rel= ations to Content items.	Yes, with FieldRelation criterion<= /td>
`Selection`	Validates and stores a single sele= ction 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`	Validates and stores a single line= of text.	Yes
`Time`	Stores time information.	Yes
`Url`	Stores a URL / address.	No
`User`	Validates and stores information a= bout a user.	No
`XmlText<= /code>`	Validates and stores multiple line= s of formatted text.	Yes

Known missing Field T= ypes

The following Field Types are configured using Null Field Type to avoid exceptions i= f they exists in your database, but their functionality is currently not kn= own 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

Field Types reference

Known missing Field T= ypes

Related topics: