Warning: You are browsing the documentation from version 4 to 10 of Pimcore. Please visit https://pimcore.com/docs/platform/ for the latest versions of Pimcore.
Version: Edit on GitHub



Every element can have custom properties. You can find these in the Properties tab for each type of elements (documents, assets, objects).

Properties in the document

The properties could be used to specify some special behavior when the document is rendered.

Have a look at a few cases below:

  • Hide the main navigation
  • Show the sidebar
  • Use an additional stylesheet

Get property in the template

The following example shows how you can get a property value in the template:

{# retrieve the value of a property named "hideNavigation" #}
{% set hideNavigation = document.getProperty('hideNavigation') %}

Predefined properties

With predefined properties you can help/show the editors working within your Pimcore installation which properties are available for their use. You can also define default values for each defined property to improve the productivity of your editors.

Predefined does not mean that the value of the predefined property is available for every document. To add global properties which are available everywhere use Website Settings instead.

Predefined properties - selectbox

Configuration example

You can find the Predefined properties configuration in the Settings Settings -> Predefined properties menu.

Predefined properties configuration

The following fields are available in the properties configuration.

Name Is required? Description
Name Y The friendly name shown in the selection.
Description N The description would help understand a specific property meaning.
Key Y This field is the key which you use in your code to retrieve the contents of the property. For example: $document->getProperty("key");
Type Y Specifies the type of the content which is allowed in the property.
Available types are: text, document, asset, object, bool (checkbox), select.
Value N Here you can define a default value for this property which I added automatically to the property when it is added to a element. This field is optional.
See the example configuration above for details.
Configuration N This field is used to configure a property. At the moment, this is used only by the property-type select. Separate options with a comma.
Content-Type Y Defines for which element-type (document, asset or object) the property should be available.

Each defined field can be overwritten in the element after it was added.