Add custom layout presets to your theme

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
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.

How to update Add-Ons if not on the Update Add-Ons Menu item
Jul 4, 2022

How to manually download an add-on and update it when your site's core versions isn't considered compatible with the add-on version.

Generate a report with author information and form summaries in Concrete CMS.
May 9, 2022

In Concrete CMS, you can use a form to initiate contact between logged-in users and then create helpful reports. After form submissions are collected, they can be searched, sorted, and exported as a spreadsheet. This tutorial will detail how to add author information to a report using the advanced search.

How to clone and customize Atomik theme
Feb 14, 2022
By linuxoid.

How to clone and customize Atomik theme

Update jQuery to 3.5 on Concrete CMS version 8.5.x
Dec 1, 2021
By hissy.

If you have to take some time to fix your site to work with version 9 and want to update jQuery immediately, you can override it.

Was this information useful?
Thank you for your feedback.