Add custom layout presets to your theme

This is a community-contributed tutorial. This tutorial is over a year old and may not apply to your version of Concrete CMS.
Mar 24, 2016

Add Area Layout Presets

In order to add and enable custom theme area layout presets to your theme you need to use the getThemeAreaLayoutPresets() function in your page_theme.php file.

Like most functions in page_theme.php these are essentially array maps to provide configuration to your theme.

Define Layouts

The preset layouts essentially generate container markup and column markup. So in order to define what these are, you need to create an array per preset and return it in the getThemeAreaLayoutPresets() method.

/**
 * Add Layout Presets to an Area
 *
 * @return array | array map of areas and a layout structure
 */
public function getThemeAreaLayoutPresets()
{
    return array(
        array(
            'handle' => 'my_custom_layout',
            'name' => 'My Custom Layout',
            'container' => '<div class="container-class eg-row"></div>',
            'columns' => array(
                '<div class="column-class eg-span-8"></div>',
                '<div class="column-class eg-span-4"></div>'
            ),
        ),
    );

}

The number of columns is entirely up to you and this method does not require you to have specified a grid framework either.

Enable getThemeAreaLayoutPresets() in page_theme.php

The key to your theme recognising and implementing this method requires you to apply the use and implement statements to page_theme.php

namespace Application\Theme\Yourtheme;
use Concrete\Core\Area\Layout\Preset\Provider\ThemeProviderInterface;
class PageTheme extends \Concrete\Core\Page\Theme\Theme implements ThemeProviderInterface
{
...
}

You now should be able to add these custom layouts to areas in your theme.

For a fully annotated page_theme.php you can check out this gist.

Recent Tutorials
Customize locale icons
Oct 29, 2024
By myq.

How to customize locale (language region) flags

Concrete CMS Caching Guide
Oct 16, 2024

An overview of types of caching in Concrete and considerations when using them.

Redirect all requests to HTTPS
Oct 9, 2024
By myq.

How to follow best practices for a secure web

Upgrade Concrete versions 9.3.1 and 9.3.2
Sep 10, 2024
By myq.

How to get past a bug in versions 9.3.1 and 9.3.2 that prevents upgrading the Concrete core through the Dashboard

How to use Composer with Marketplace extensions
Aug 22, 2024

Composer can be used to manage third-party extensions from the marketplace

Controlling Google Tag Manager Tags Based on Concrete CMS Edit Toolbar Visibility
Aug 13, 2024

This document provides a step-by-step guide on how to control the firing of Google Tag Manager (GTM) tags based on the visibility of the Concrete CMS edit toolbar. It explains how to create a custom JavaScript variable in GTM to detect whether the edit toolbar is present on a page and how to set up a trigger that ensures GTM tags only fire when the toolbar is not visible. This setup is particularly useful for developers and marketers who want to ensure that tracking and analytics tags are not activated during content editing sessions, thereby preserving the accuracy of data collected.

Improvements?

Let us know by posting here.