FieldTypes reference

This page contains FieldTypes reference introduced with eZ Publish 5.x.
FiledTypes were known as DataTypes 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 FieldType, see eZ Publish 5 Field Type Tutorial.

A FieldType is the smallest possible entity of storage. It determines how a specific type of information should be validated, stored, retrieved, 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 FieldTypes for special needs. Custom FieldTypes have to be programmed in PHP. However, the built in FieldTypes are usually sufficient enough for typical scenarios. The following table gives an overview of the supported FieldTypes that come with eZ Publish.

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

Known missing field types

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 Backlog

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

EZP-20114 - Deprecated FieldTypes (ezenum, ezinisetting, ezpackage) not supported by Public API Closed

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

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

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

Known missing field types

27 Child Pages

2 Comments

Bertrand Dunogier

Petar Spanja