Skip to main content
Keel Docs Showcase

Website pages and preview

What it does

When Keel knows the address of an item's page on the website, the editor shows View on website and the live preview. Keel asks, in this order: your own URL provider services, then the urls option, then the class's Pimcore link generator.

Default

No urls. Classes with a link generator already work.

Options

KeyDefaultWhat it does
urls.<Class>.pathrequiredPath with placeholders: {id}, {key}, {locale}, {scope}, {scope.<name>}, {<field>}
urls.<Class>.sitenone (main site)Pimcore site id, or a placeholder such as {scope.site}. Its main domain makes the public URL.
urls.<Class>.domainnoneA public domain instead of a site, e.g. {scope.domain}
urls.<Class>.published_onlytruePreview only published items (the site serves only those)

A short form is allowed when only the path is needed: Property: '/properties/{slug}'.

Example

yaml
keel:
    urls:
        Property: '/properties/{slug}'
        Tour:
            path: '/{locale}/tours/{slug}'
            site: '{scope.site}'

The placeholders, how they are filled per switcher option and per language, and the ObjectUrlProviderInterface for code are explained in Page URLs & preview.

keel:setup --check warns when a class named under urls does not exist.

What admins change in Customize

Nothing.