eZ Publish comes with a native controller to display your content, known as the
ViewController. It is called each time you try to reach a content item from its Url Alias (human readable, translatable URI generated for any content based on URL patterns defined per Content Type) and is able to render any content previously edited in the admin interface or via the eZ Publish Public API.
It can also be called directly by its direct URI :
A content item can also have different view types (full page, abstract in a list, block in a landing page...). By default the view type is full (for full page), but it can be anything (line, block...).
Important note regarding visibility
Location visibility flag, which you can change with hide/unhide in admin, is not permission based and thus acts as a simple potential filter. It is not meant to restrict access to content.
If you need to restrict access to a given content, use Sections or Object states, which are permission based.
To display a content item, the ViewController uses a view manager which selects the appropriate template depending on matching rules.
Location view template
A content view template is like any other template, with several specific aspects.
|eZ\Publish\Core\Repository\Values\Content\Location||The location object. Contains meta information on the content (ContentInfo)|
(only when accessing a location)
|eZ\Publish\Core\Repository\Values\Content\Content||The content object, containing all fields and version information (VersionInfo)|
|Boolean||If true, indicates if the content/location is to be displayed without any pagelayout (i.e. AJAX, sub-requests...).|
|String||The base layout template to use when the view is requested to be generated outside of the pagelayout (when |
Like any template, a content view template can use template inheritance. However keep in mind that your content can be also requested via sub-requests (see below how to render embedded content objects). In this case your template should probably not extend your main layout.
In this regard, it is recommended to use inheritance this way:
Rendering content's fields
As stated above, a view template receives the requested Content object, holding all fields.
In order to display the fields' value the way you want, you can either manipulate the Field Value object itself or use a template.
Getting raw Field value
Having access to the Content object in the template, you can use its public methods to access to all the information you need. You can also use ez_field_value helper to get the Field value in the current language if translation is available.
Using the FieldType's template block
All built-in FieldTypes come with a piece of Twig template code you can take advantage of by calling
ez_render_field() reference page for further information.
As this makes use of reusable templates, using
ez_render_field() is the recommended way and is to be considered as a best practice.
Rendering Content name
The name of a content item is its generic "title", generated by the repository considering several rules in the FieldDefinition. It usually consists in the normalized value of the first field.
There are 2 different ways to access to this special property:
- Through the name property of ContentInfo (not translated).
- Through VersionInfo with the TranslationHelper (translated).
Name property in ContentInfo
This property is the actual content name, but in main language only (so it is not translated).
The TranslationHelper service is available as of version 5.2 / 2013.09
The translated name is held in
VersionInfo object, in the names property which consists of hash indexed by locale. You can easily retrieve it in the right language via the
You can refer to ez_content_name() reference page for further information.
The helper will respect the prioritized languages.
If there is no translation for your prioritized languages, the helper will always return the name in the main language.
You can also force a locale in a 2nd argument:
Exposing additional variables
It is possible to expose additional variables in a content view template. See parameters injection in content views or use your own custom controller to render a content item/location.
Making links to other locations
Linking to other locations is fairly easy and is done with native
path() Twig helper (or
url() if you want to generate absolute URLs). You just have to pass it the Location object and
path() will generate the URLAlias for you.
If you don't have the Location object, but only its ID, you can generate the URLAlias the following way:
As of 5.4 / 2014.11, you can also use the Content ID. In that case generated link will point to the content main location.
Under the hood
In the backend,
path() uses the Router to generate links.
This makes also easy to generate links from PHP, via the
See also : Cross SiteAccess links
Render embedded content objects
Rendering an embedded content from a Twig template is pretty straight forward as you just need to do a subrequest with
This controller is exactly the same as the ViewController presented above and has 2 main actions:
viewLocationto render a location (same as when accessing a content item through an URLAlias)
viewContentto render a content item
You can use this controller from templates with the following syntax:
The example above allows you to render a Location which ID is 123, with the view type line.
ez_content controller follow the syntax of controllers as a service, as explained in Symfony documentation.
Usage with drafts
viewLocationwhen handling drafts.
As any controller, you can pass arguments to
ez_content:viewContent to fit your needs.
|Id of the location you want to render.|
Id of the content you want to render.
The view type you want to render your content/location in.
Example: full, line, my_custom_view, ...
Indicates if the sub-view needs to use the main layout (see available variables in a view template)
Hash of variables you want to inject to sub-template, key being the exposed variable name.
Available as of eZ Publish 5.1
>= EZP 5.4 / >= 2014.11
You can specify which controller will be called for a specific block view match, much like defining custom controllers for location view or content view match.
Also, since there are two possible actions with which one can view a block:
ez_page:viewBlockById, it is possible to specify a controller action with a signature matching either one of original actions.
Example of configuration in
Just as for regular Symfony controllers, you can take advantage of ESI and use different cache levels:
Only scalable variables can be sent via render_esi (not object)
Symfony also supports asynchronous content rendering with the help of hinclude.js library.
Only scalable variables can be sent via render_hinclude (not object)
Display a default text
If you want to display a default text while a controller is loaded asynchronously, you have to pass a second parameters to your render_hinclude twig function.