Template override conditions

This section contains an overview of the override conditions that can be used to override the system templates.

Override example

[magic_pockets]                (1)
Source=node/view/full.tpl      (2)
MatchFile=magic_pocket.tpl     (3)
Subdir=templates               (4)
Match[class_identifier]=pocket (5)
Match[section]=34              (6)
...                            ...

The name of the override.
The template that should be overridden.
The alternate template that should be used.
The location of the override templates.
Match condition #1
Match condition #2

List of possible match conditions:

Condition	Description
class	Matches the ID number of the class.
object	Matches the ID number of class group.
class_identifier	Matches the identifier of the class (for example "folder").
section	Matches the number of the section in which the search was conducted.
section_id	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
view_offset	Matches the offset view parameter.
depth	Matches the depth of the node. The depth of a top level node is 1.
navigation_part_identifier	Matches the identifier of the navigation part.
url_alias	Matches the virtual URL of the node.
attribute_identifier	Matches the identifier of the attribute.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.
remote_id	Matches the remote ID number of the object.
state	Matches the content object state id.
state_identifier	Matches the content object state identifier.
layout	Matches the name of the layout (for example "print", "fullpage", etc.).
viewmode	Matches the name of the view mode (full, line, etc.)
parent_class	Matches the ID number of the parent class.
parent_class_identifier	Matches the identifier of the parent class.
persistent_variable	Matches the value of the persistent variable if the "view" view of the "content" module was executed. (The persistent variable should be set in the "node/view/<view_mode>.tpl" template that was used by this view.)
error_number	Matches kernel errors. Note that some kind of errors, i.e. database errors, may prevent the overriding.
workflow	Matches the ID number of the workflow.
workflowgroup	Matches the ID number of the workflow group.

Please find below a list of examples of match conditions.

class/edit.tpl

Module/view: class / edit

Condition	Description
class	Matches the ID number of the class.

class/groupedit.tpl

Module/view: class / groupedit

Condition	Description
object	Matches the ID number of class group.

class/view.tpl

Module/view: class / view

Condition	Description
class	Matches the ID number of the class.
class_identifier	Matches the identifier of the class (for example "folder").

content/advancedsearch.tpl

Module/view: content / advancedsearch

Condition	Description
section	Matches the number of the section in which the search was conducted.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.

content/browse.tpl

Module/view: content / browse

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
view_offset	Matches the offset view parameter.
depth	Matches the depth of the node. The depth of a top level node is 1.
navigation_part_identifier	Matches the identifier of the navigation part.
url_alias	Matches the virtual URL of the node.

content/collectedinfo/*.tpl

Module/view: content / collectinformation

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
depth	Matches the depth of the node. The depth of a top level node is 1.
navigation_part_identifier	Matches the identifier of the navigation part.
url_alias	Matches the virtual URL of the node.

content/collectedinfo/*.tpl

Module/view: content / collectedinfo

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
depth	Matches the depth of the node. The depth of a top level node is 1.
navigation_part_identifier	Matches the identifier of the navigation part.
url_alias	Matches the virtual URL of the node.

content/collectedinfomail/*.tpl

Module/view: content / collectinformation

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
depth	Matches the depth of the node. The depth of a top level node is 1.
navigation_part_identifier	Matches the identifier of the navigation part.
url_alias	Matches the virtual URL of the node.

content/datatype/edit/*.tpl

Module/view: none.

Condition	Description
class_identifier	Matches the identifier of the class.
attribute_identifier	Matches the identifier of the attribute.

content/datatype/view/*.tpl

Module/view: none.

Condition	Description
class_identifier	Matches the identifier of the class.
attribute_identifier	Matches the identifier of the attribute.

content/edit.tpl

Module/view: content / edit

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.

content/history.tpl

Module/view: content / history

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.

content/queued.tpl

Module/view: none.

Condition	Description
object	Matches the content ID number of the object.
remote_id	Matches the remote ID number of the object.
class	Matches the ID number of the content class which the object is an instance of.
class_identifier	Matches the identifier of the content class which the object is an instance of.
class_group	Matches the identifier of the class group which the content class is an instance of.
state	Matches the content object state id.
state_identifier	Matches the content object state identifier.
section	Matches the section ID.
section_identifier	Matches the section identifier

content/search.tpl

Module/view: content / search

Condition	Description
section	Matches the number of the section in which the search was conducted.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4

content/tipafriend.tpl

Module/view: content / tipafriend

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
depth	Matches the depth of the node. The depth of a top level node is 1.
url_alias	Matches the virtual URL of the node.

content/tipafriendmail.tpl

Module/view: none.

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
depth	Matches the depth of the node. The depth of a top level node is 1.
url_alias	Matches the virtual URL of the node.

content/versions.tpl

Module/view: content / versions

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
section_id	Matches the number of the section which the object belongs to.

content/versionview.tpl

Module/view: content / versionview

Condition	Description
navigation_part_identifier	Matches the identifier of the navigation part.

content/view/*.tpl

Module/view: content / view

Condition	Description
object	Matches the ID number of the object.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.

layout/set.tpl

Module/view: layout / set

Condition	Description
layout	Matches the name of the layout (for example "print", "fullpage", etc.).

node/view/*.tpl

Module/view: content / view

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
view_offset	Matches the offset view parameter.
depth	Matches the depth of the node. The depth of a top level node is 1.
section	Matches the number of the section which the object belongs to.
section_identifier	Matches the identifier of the section which the object belongs to. Available since eZ Publish 4.4.
navigation_part_identifier	Matches the identifier of the navigation part.
viewmode	Matches the name of the view mode (full, line, etc.)
url_alias	Matches the virtual URL of the node.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.
parent_class	Matches the ID number of the parent class.
parent_class_identifier	Matches the identifier of the parent class.

node/view/pdf.tpl

Module/view: content / pdf

Condition	Description
object	Matches the ID number of the object.
node	Matches the ID number of the node.
parent_node	Matches the ID number of the parent node.
class	Matches the ID number of the class which the object is an instance of.
class_identifier	Matches the identifier of the class which the object is an instance of.
depth	Matches the depth of the node. The depth of a top level node is 1.
url_alias	Matches the virtual URL of the node.
class_group	Matches the ID number of the group that the class which the object is an instance of belongs to.

pagelayout.tpl

Module/view: none.

Condition	Description
persistent_variable	Matches the value of the persistent variable if the "view" view of the "content" module was executed. (The persistent variable should be set in the "node/view/<view_mode>.tpl" template that was used by this view.)
error_number	Matches kernel errors. Note that some kind of errors, i.e. database errors, may prevent the overriding.
[any]	The pagelayout may be overridden using the same keys that are available for the view which was used within the request. For example, if the "view" view of the "content" module was accessed, then the override conditions of that view will be matched. This makes it possible to create a pagelayout override that will be triggered when, for example, nodes referencing objects that belong to a certain section are requested.

workflow/edit.tpl

Module/view: workflow / edit

Condition	Description
workflow	Matches the ID number of the workflow.

workflow/groupedit.tpl

Module/view: workflow / groupedit

Condition	Description
workflowgroup	Matches the ID number of the workflow group.

workflow/view.tpl

Module/view: workflow / view

Condition	Description
workflow	Matches the ID number of the workflow.

Written by:Balazs Halasy (09/03/2005 8:41 am)

Last updated by:Andrea Melo (05/12/2012 4:56 pm)

Maintainers:Balazs Halasy, Andrea Melo

Comments

OR conditions

Thursday 13 October 2005 8:54:10 am

Tristan Rivoallan

Is there a way to specify OR conditions ? ie : node 43 OR node 56 ?
- Re: OR conditions
  
  Thursday 13 October 2005 1:10:30 pm
  
  Jan Kudlicka
  
  No, but you can place 2 groups in override.ini(.append.php) like in the following example:
  
  [magic_pockets_43]
  Source=node/view/full.tpl
  MatchFile=magic_pocket.tpl
  Subdir=templates
  Match[node]=43
  
  [magic_pockets_56]
  Source=node/view/full.tpl
  MatchFile=magic_pocket.tpl
  Subdir=templates
  Match[node]=56
  
  (Note that the group name must be diffent.)
  
  If you have set of many such nodes, you may consider creating a special class for those nodes or place them in special section (do not forget on permission settings in this case).
Override a pagelayout_bodycontent

Tuesday 18 April 2006 2:21:55 pm

Nguyen Tien Hy

Suppose pagelayout.tpl as follows:

"--------
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{$site.http_equiv.Content-language|wash}" lang="{$site.http_equiv.Content-language|wash}">

<head>

{include uri="design:pagelayout_style.tpl"}
{include uri="design:pagelayout_javascript.tpl"}

{literal}

{/literal}

{include uri="design:page_head.tpl"}

</head>
<body>

<div id="allcontent">

<div id="topcontent">
{include uri="design:pagelayout_topcontent.tpl"}
</div>{* id="topcontent" *}

<hr class="hide" />

{include uri="design:pagelayout_topmenu.tpl"}

<hr class="hide" />

{include uri="design:pagelayout_path.tpl"}

{include uri="design:pagelayout_bodycontent.tpl"}

<hr class="hide" />

{include uri="design:pagelayout_toolbarbottom.tpl"}

{include uri="design:pagelayout_footer.tpl"}

<div class="break"></div>
</div>{* id="allcontent" *}



</body>
</html>

-------"

I "override" pagelayout_bodycontent.tpl as follows:

1. Put a new template in "frontpage/pagelayout_bodycontent.tpl".
2. Write into override.ini.append.php
[pagelayout_bodycontent_frontpage]
Source=pagelayout_bodycontent.tpl
MatchFile=frontpage/pagelayout_bodycontent.tpl
Subdir=templates
Match[node]=2

But the result is not OK. The override pagelayout_bodycontent.tpl not run.
- Re: Override a pagelayout_bodycontent
  
  Wednesday 10 October 2007 4:15:27 pm
  
  André R.
  
  try:
  
  [pagelayout_bodycontent_frontpage] Source=pagelayout.tpl MatchFile=frontpage/pagelayout_bodycontent.tpl Subdir=templates Match[node]=2
match condition on url_alias

Monday 12 June 2006 2:43:10 pm

Xavier Gouley (Smile)

Hi,

Just to mention that match on url_alias is recursive.

Match[url_alias]=my_folder
will override not only my_folder content, but also all its children
(tried with pagelayout override).
It's a good idea, to avoid use of section, but it's not really told in the doc.
- Re: match condition on url_alias
  
  Saturday 20 October 2007 3:08:57 pm
  
  André R.
  
  Also note that it is case sensitive, so when you upgrade to 3.10 or 4.0 you need to change all rules that use url_alias if you change url_alias format (it changes to a new format by default).
note on persistent_variable as override

Saturday 20 October 2007 3:06:44 pm

André R.

Note that it dosn't make sense to use persistent_variable as a override for node/view/* templates (since it is generated during the prossing of the node/view/* template), what it is ment for is to be able to override the pagelayout based on the persistent_variable..

Basicly you can have something like this in a node template:

{if $some_value|eq( 'something' )} {set scope=global persistent_variable='caramba'} {/if}

And then have a override rule for your page layout like this:

[test_side_layout] Source=pagelayout.tpl MatchFile=pagelayout_caramba.tpl Subdir=templates Match[persistent_variable]=caramba
the template layout/set.tpl is nowhere to be found

Wednesday 27 February 2008 11:22:30 pm

Gaetano

Despite being mentioned here, it is not part of eZ Publish 4 or 3.9 (it makes sense after all, since you can define layouts to be used in layout.ini)
node_view_gui and parent_class_identifier

Wednesday 09 July 2008 8:36:25 am

Jérôme Cohonner

Note that parent_class_identifier match case is not properly working with node_view_gui.

In fact, the parent_class_identifier used is the parent class of the currently node (in view full) that includes the node_view_gui call.

Fell free to have a look at this issue for more information and for a patch : http://issues.ez.no/IssueView.php?Id=11499&activeItem=1

A similar problems occurs with attribute_view_gui and class_identifier. A patch is included within the issue tracker.

Jérôme Cohonner - Cosmosbay ~ Vectis
- Re: node_view_gui and parent_class_identifier
  
  Wednesday 09 July 2008 10:50:09 am
  
  Kristof Coomans
  
  Hi
  
  The issue with class_identifier override condition for attribute_view_gui template function was already fixed for next subreleases (4.0.1, 3.10.1, 3.9.5), see http://issues.ez.no/11898. We'll try to have a look at the other issue in the near future.
content/browse.tpl

Sunday 06 December 2009 10:11:39 am

Christoph von Siebenthal

Note that for ez 4.2 it is

Match[class_id]=agenda_stage instead of class_identifier

I lost 45 minutes on it!
Override pagelayout.tpl by Subtree

Wednesday 06 January 2010 3:09:58 pm

Mauicio Sánchez

Suppose that you need display a different overall design for a given part of your content tree, there is a way to specify an override for the pagelayout by subtree?

You can achieve such functionality using an override by section or url_alias instead by subtree, but it's kinda clunky approach, because the section adds a lot more functionality for the content that you don't want to deal with, and the url_alias can change with the content edition.
Notice to use Match[class_group] in override.ini

Wednesday 13 January 2010 9:34:51 am

Sébastien Leguevaques

You have to enable override for class_group in content.ini :

[ContentOverrideSettings]
EnableClassGroupOverride=true
pagelayout.tpl [any] override

Wednesday 16 June 2010 3:02:31 pm

Marco Rogers

Can someone provide an example of the [any] override for pagelayouts. I'm not sure I understand the description.
How do you override the pagelayout of /notification/settings?

Friday 02 July 2010 8:23:55 pm

Benxamin

I would like to change the pagelayout of the Notifications settings page.

The template path is
/design/ezwebin/templates/notification/handler/ezsubtree/settings/edit.tpl

What is the override match condition for /notification/settings? They are not content nodes...
Override content/view/embed.tpl by classification

Wednesday 14 July 2010 1:40:56 pm

Sander van den Akker

The documentation page is missing the override condition 'classification', which allows to override content/view/embed.tpl based on the classification of the embedded object.

Classifications can be defined in content.ini and are set in the insert object dialog of the online editor. This allows for example, automatic lists of subitems of an object, highlighted objects etc.

Path

Table of contents

Template override conditions

Override example

class/edit.tpl

class/groupedit.tpl

class/view.tpl

content/advancedsearch.tpl

content/browse.tpl

content/collectedinfo/*.tpl

content/collectedinfo/*.tpl

content/collectedinfomail/*.tpl

content/datatype/edit/*.tpl

content/datatype/view/*.tpl

content/edit.tpl

content/history.tpl

content/queued.tpl

content/search.tpl

content/tipafriend.tpl

content/tipafriendmail.tpl

content/versions.tpl

content/versionview.tpl

content/view/*.tpl

layout/set.tpl

node/view/*.tpl

node/view/pdf.tpl

pagelayout.tpl

workflow/edit.tpl

workflow/groupedit.tpl

workflow/view.tpl

Comments

OR conditions

Re: OR conditions

Override a pagelayout_bodycontent

Re: Override a pagelayout_bodycontent

match condition on url_alias

Re: match condition on url_alias

note on persistent_variable as override

the template layout/set.tpl is nowhere to be found

node_view_gui and parent_class_identifier

Re: node_view_gui and parent_class_identifier

content/browse.tpl

Override pagelayout.tpl by Subtree

Notice to use Match[class_group] in override.ini

pagelayout.tpl [any] override

How do you override the pagelayout of /notification/settings?

Override content/view/embed.tpl by classification