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
Using the Concrete Migration Tool Addon
Apr 27, 2023

How to use the Concrete CMS Migration Tool

How To Add Page Last Updated To Your Concrete CMS Pages
Mar 7, 2023

Concrete CMS has a page attribute you can add to a global area called "Page Date Modified." Here's how to add it

How To Exclude Subpages from Navigation
Dec 24, 2022

How to exclude subpages from navigation - useful for a news or blog link in your main navigation where you don't want all the subpages to appear in a drop down menu.

How Can I Change The Maximum Size Of Uploaded files
Dec 13, 2022

This tutorial explains how to update your php settings.

Updating Concrete Themes from Version 8 to Version 9
Nov 24, 2022

This tutorial covers commonly encountered issues when upgrading a Concrete CMS theme from version 8 to version 9

Transferring ownership of an add-on and a theme
Nov 15, 2022
By katzueno.

If you encounter a Concrete CMS add-on or theme that you love but not being maintained, you may want to ask the author to help or take over the add-on or theme. Here is the quick step-by-step guide of how to transfer the ownership.

Was this information useful?
Thank you for your feedback.