Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
   eZ Publish 4.x / legacy

eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Skip to end of metadata
Go to start of metadata

This field type represents one or multiple countries.

NameInternal nameExpected input

Table of contents:


This FieldType makes possible to store and retrieve data representing countries.

Input expectations


Note: When you set a array directly on Content field you don't need to provide all this information, the FieldType will assume it is a hash and in this case it will accept a simplified structure described below in the To / From Hash format.


This FieldType validates if the multiple countries are allowed by the field definition, and if the Alpha2 is valid according to the countries configured in eZ Publish.


The field definition of this FieldType can be configured with one option:

NameTypeDefault valueDescription
isMultiplebooleanfalseThis setting allows (if true) or denies (if false) the selection of multiple countries.
Country FieldType example settings

To / From Hash format

The format used for serialization is simpler then the full format, this is also available when setting value on the content field, by setting the value to a array instead of the Value object. Example of that shown below:

Value object content example

The format used by the toHash method is the Alpha2 value, however the input is cable of accepting either Name, Alpha2 or Alpha3 value as shown below in the Value object section.

Value object


The Value class of this field type contains the following properties:

$countriesarray[]This property will be used for the country selection provided as input, as its attributes.
Value object content example


The Country\Value constructor will initialize a new Value object with the value provided. It expects an array as input.

Constructor example