Skip to the content
Documentation

Field Types reference

Written by Ricardo Correia Updated by Dominika Kurek
No ratings yet

This page contains a reference of Field Types used in eZ Platform.
Field Types were known as DataTypes in legacy Exponential. If you would 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.

If you are looking for the documentation on how to implement a custom Field Type, see Field Type Tutorial.

A Field Type 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 Platform comes with a collection of fundamental 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 Types for special needs. Custom Field Types have to be programmed in PHP. 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 engine
Author Stores a list of authors, each consisting of author 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 Book Number (ISBN) in 10-digit or 13-digit format. Yes
Keyword Stores keywords. No
MapLocation Stores map coordinates. Yes, with MapLocationDistance criterion
Matrix Available via community Bundle: https://github.com/ezcommunity/EzMatrixFieldTypeBundle  
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 blocks 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 FieldRelation criterions
RelationList Validates and stores a list of relations to Content items. Yes, with FieldRelation criterion
Selection Validates and stores a single selection or multiple choices from a list of options. 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
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 about a user. No
XmlText Validates and stores multiple lines of formatted text. Yes

 

Known missing Field Types

The following Field Types are configured using Null Field Type 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

 

Related topics:

 

In this section

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.