Skip to main content
Version: 2023.1

Area Editable

General

The area editable is similar to the areablock editable, the only difference is that the area bricks are not wrapped into a block element, and the editor cannot choose which area is used, this has to be done in the editable configuration in the template.

Configuration

NameTypeDescription
typestringID of the brick which should be used in this area
paramsarrayOptional Parameter see areablock for details
classstringA CSS class that is added to the surrounding container of this element in editmode

Methods

NameReturnDescription
getElement($name)Document\EditableRetrieves an editable from within the actual area

Example

<div>
{{ pimcore_area('myArea', { 'type' : 'gallery-single-images' }) }}
</div>

Example with Parameters

<div>
{{ pimcore_area('myArea', {
type: 'gallery-single-images',
params: {
'gallery-single-images': {
'param1': 123,
}
}
}) }}
</div>

Get the params in your brick:

<div>
{{ param1 }}
</div>

Accessing Data Within an Area Element

Assuming your area uses a brick gallery-single-images which contains a gallery block (see CMS demo):

<?php
// load document
$document = \Pimcore\Model\Document\Page::getByPath('/en/basic-examples/galleries');

/** @var \Pimcore\Model\Document\Editable\Area $area */
$area = $document->getEditable('myArea');

/** @var \Pimcore\Model\Document\Editable\Block $block */
$block = $area->getElement('gallery');
?>

See Block for an example how to get elements from a block editable.