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 Field Type, see the Creating a Tweet 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.
Built in Field Types
| FieldType | Description | Searchable in Legacy Storage engine | Searchable with Solr |
|---|---|---|---|
| Author | Stores a list of authors, each consisting of author name and author email. | No | Yes |
| BinaryFile | Stores a file. | Yes | Yes |
| Checkbox | Stores a boolean value. | Yes | Yes |
| Country | Stores country names as a string. | Yes* | Yes |
| DateAndTime | Stores a full date including time information. | Yes | Yes |
| Date | Stores date information. | Yes | Yes |
| EmailAddress | Validates and stores an email address. | Yes | Yes |
| Float | Validates and stores a decimal value. | No | Yes |
| Image | Validates and stores an image. | No | Yes |
| Integer | 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 | Stores keywords. | Yes* >= 1.7.0 | Yes |
| Landing Page | Stores a page with a layout consisting of multiple zones. | N/A | N/A |
| MapLocation | Stores map coordinates. | Yes, with MapLocationDistance criterion | Yes |
| Media | Validates and stores a media file. | No | Yes |
| Null | Used as fallback for missing Field Types and for testing purposes. | N/A | N/A |
| Rating | Stores a rating. | No (will need own Criterion) | No |
| Relation | Validates and stores a relation to a Content item. | Yes, with both Field and FieldRelation criterions | Yes |
| RelationList | Validates and stores a list of relations to Content items. | Yes, with FieldRelation criterion | Yes |
| RichText | Validates and stores structured rich text in docbook xml format, and exposes it in several formats. | Yes* | Yes |
| Selection | Validates and stores a single selection or multiple choices from a list of options. | Yes* | Yes |
| TextBlock | Validates and stores a larger block of text. | Yes* >= 1.7.1 | Yes |
| TextLine | Validates and stores a single line of text. | Yes | Yes |
| Time | Stores time information. | Yes | Yes |
| Url | Stores a URL / address. | No | Yes |
| User | Validates and stores information about a user. | No | No |
*Limited to 255 characters in database design, so formatted or unformatted text blocks will only index first part, and in case of multiple selection field types like keyword, selection and so on only the first choices, and only as a text blob separated by string separator. Proper indexing of these field types are done with Solr Search Bundle.
Field Types provided by Community
| FieldType | Description | Searchable | Editing support in Platform UI | Planned to be incl in the future |
|---|---|---|---|---|
| Tags | Tags field and full fledge taxonomy management | Yes | Yes >= 3.0.0 (BUNDLE VERSION) | Yes >= 1.9.0 (IN STUDIO DEMO INSTALL) |
| Price | Price field for product catalog use | Yes | No | Yes |
| Matrix | Matrix field for matrix data | Yes | No | Yes |
| XmlText | Validates and stores multiple lines of formatted text using xml format. | Yes | Partial (Raw xml editing) | No (has been superseded by RichText) |
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-20118
-
eZ Password Expiry FieldType not supported by Public API
Backlog
Missing something? For field types provided by community, like for instance
ezselection2, unless otherwise mentioned it can be considered 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 Field Type Generator Bundle helping you get started creating skeleton for eZ Platform field type, including templates for editorial interface.