Global Configuration

This chapter covers settings that apply to the whole bundle: where template and brick YAML is stored, how templates and bricks are grouped in the Studio interface, and how to hide Headless Documents from a custom view. To define the editables of one template or brick, see Template Configuration and Headless Bricks instead.

Storage Location

By default, headless template and brick configurations are stored as Symfony config YAML files, under var/config/headless_templates and var/config/headless_bricks. Change where they are written with the write_target key, set independently for templates and bricks. The example below keeps the Symfony Config target and points each at a custom directory:

pimcore_headless_documents:
    config_location:
        headless_templates:
            write_target:
                type: 'symfony-config'
                options:
                    directory: '/var/www/html/var/config/headless_templates'
        headless_bricks:
            write_target:
                type: 'symfony-config'
                options:
                    directory: '/var/www/html/var/config/headless_bricks'

Available type options:

• symfony-config: write configs as Symfony Config YAML files.
• settings-store: write configs to the SettingsStore.
• disabled: do not allow editing or writing configs at all.

Configurations are merged from YAML files and the SettingsStore when loading and using headless documents. Switching the write target does not migrate existing configurations; move and clean them up manually.

Grouping

Group templates or bricks in the Studio interface with the group property:

pimcore_headless_documents:
    templates:
        test:
            group: Test
            layout: simple
            # ...

pimcore_headless_documents:
    bricks:
        area1:
            group: Test
            type: brick
            # ...

Custom Views & Perspectives

Hide or show Headless Documents in a custom view's context menu, the same way as any other document type:

pimcore:
    custom_views:
        definitions:
            no_headless_documents:
                name: no_headless_documents
                treetype: document
                position: left
                # ...
                treeContextMenu:
                    document:
                        items:
                            # ...
                            addHeadlessdocument: false # hide "Add Headlessdocument"
                            # ...