Creating CMS blocks

Last updated:
Edit on GitHub
You are browsing a previous version of the document. The latest version is 202212.0.

This topic describes how to create a CMS block.

Info

If you want to create a CMS block for email, see Creating an email CMS block.

Prerequisites

To start working with CMS blocks, go to Content > Blocks.

Review the reference information before you start, or look up the necessary information as you go through the process.

Creating a CMS block

To create a CMS block:

  1. On the Overview of CMS Blocks page, click Create block in the top right corner.
  2. On the Create CMS Block page, enter the block details:
  • Store relation
  • Template
  • Name
  • Valid from and Valid to

Store relation, Template, and Name must be filled in. All other fields are optional.

Templates are project-specific and are usually created by a developer and a business person. If you are missing a CMS Block template, contact them and refer to the HowTo - Create CMS block templates.

  1. To save the changes, click Save. This will successfully create a block and take you to the Edit Block Glossary page.

Reference information: Creating a CMS block

The following table describes the attributes on the Overview of CMS Blocks page.

ATTRIBUTE DESCRIPTION: REGULAR CMS BLOCK DESCRIPTION: EMAIL CMS BLOCK
Block Id Sequence number. Sequence number.
Name Name of a CMS block. Name of a CMS block.
This name is used by developers to assign the block to its .twig email template.
Template Defines a placeholder structure of the CMS block. Defines the placeholder structure of the Email CMS block.
Status Block status that can be active (visible on the Storefront) or inactive (invisible on the Storefront). Irrelevant.
Stores Locale(s) for which the block will be visible on the store website. Irrelevant.
Actions Set of actions that can be performed on a CMS block. Set of actions that can be performed on an Email CMS block.

On this page, you can also:

  • Switch to the page where you can create a new CMS block.
  • Sort blocks by Block Id, Name, Template, and Status.
  • Filter content items by Block Id, Name, and Template.

The following table describes the attributes on the Create CMS Block page.

ATTRIBUTE DESCRIPTION: REGULAR CMS BLOCK DESCRIPTION: EMAIL CMS BLOCK
Store relation Store locale for which the block will be available. Irrelevant.
Template Defines the layout of the CMS Block. Defines the layout of the Email CMS Block.
Name Name of the block. Name of the block. Should correspond to the name defined in the email template the block will be assigned to.
Valid from and Valid to Dates that specify how long your active block is visible on the Storefront. Irrelevant.
Categories: top Block or blocks that will be assigned to a category page. The block will be displayed at the top of the page. Irrelevant.
Categories: middle Block or blocks that will be assigned to a category page. The block will be displayed in the middle of the page. Irrelevant.
Categories: bottom Block or blocks that will be assigned to a category page. The block will appear at the bottom of the page. Irrelevant.
Products A block or blocks that will be assigned to a product details page. Irrelevant.

What’s next?
After a new block has been created, you can add the content if needed.

To learn more about editing a CMS block, see the Editing CMS blocks.