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)
...                            ...
  1.  The name of the override.
  2.  The template that should be overridden.
  3.  The alternate template that should be used.
  4.  The location of the override templates.
  5.  Match condition #1
  6.  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.

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2013 eZ Systems AS (except where otherwise noted). All rights reserved.