This page contains a reference of Field Types used in eZ Platform.
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 Fi= eld Type, see the Creating a Tweet Field Type tutorial.
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.
Built in Field Types=
| 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 |
| <= a href=3D"/display/DEVELOPER/Date+Field+Type">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 |
| <= a href=3D"/display/DEVELOPER/ISBN+Field+Type">ISBN | Handles International Standard Boo= k Number (ISBN) in 10-digit or 13-digit format. | Yes |
| Keyword | Stores keywords. | No |
| Landing Page | Stores a page with a layout consis= ting of multiple zones. | No |
| MapLocation | Stores map coordinates. | Yes, with MapLocationDistance crit= erion |
| Media | Validates and stores a media file. | No |
| Null | Used as fallback for missing Field Types and for= testing purposes. | No |
| Rating | Stores a rating. | No |
| <= a href=3D"/display/DEVELOPER/Relation+Field+Type">Relation | Validates and stores a relation to= a Content item. | Yes, with both Field and FieldRela= tion criterions |
| <= a href=3D"/display/DEVELOPER/RelationList+Field+Type">RelationList | Validates and stores a list of rel= ations to Content items. | Yes, with FieldRelation criterion<= /td> |
| RichText | Validates and stores structured ri= ch text, and exposes it in several formats. | Yes |
| <= a href=3D"/display/DEVELOPER/Selection+Field+Type">Selection | Validates and stores a single sele= ction or multiple choices from a list of options. | Yes |
| <= a href=3D"/display/DEVELOPER/TextBlock+Field+Type">TextBlock | Validates and stores a larger bloc= k of text. | No |
| <= a href=3D"/display/DEVELOPER/TextLine+Field+Type">TextLine | Validates and stores a single line= of text. | Yes |
| <= a href=3D"/display/DEVELOPER/Time+Field+Type">Time | Stores time information. | Yes |
| <= a href=3D"/display/DEVELOPER/Url+Field+Type">Url | Stores a URL / address. | No |
| <= a href=3D"/display/DEVELOPER/User+Field+Type">User | Validates and stores information a= bout a user. | No |
| <= span class=3D"confluence-link"> XmlText | Validates and stores multiple line= s of formatted text. | Yes |
Field Types pr= ovided by Community
| FieldType | Description | Searchable | Editing support in UI | Planned to be incl in the future |
|---|---|---|---|---|
| Tags | Tags field and full fledge taxonomy management | Yes | No (See crowdfunding page) | Yes |
| Price | Price field for product catalog us= e | Yes | No | Yes |
| M= atrix | Matrix field for matrix data | Yes | No | Yes |
Known missing Field T= ypes
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=20
Backlog
EZP-20115 - eZ Identifier FieldType not supported by Public API=
=20
Backlog
EZP-20118 - eZ Password Expiry FieldType not supported by Public API=20
Backlog
Missing something? For field types provided by community, like for i=
nstance ezselection2, unless otherwise mentioned it can be con=
sidered missing for the time being. If something should be listed here, add=
a comment.
Generate new Field Type=
Besides links in the top of this topic in regards to creating own field = type, from partner Smile there is now a Fi= eld Type Generator Bundle helping you get started creating skeleton for= eZ Platform field type, including templates for editorial interface. =