Magento 2: add new custom field in cms pages

If you need to add custom field in cms pages then follow below steps:

1, You need to create a module for that so create module folders app/code/Magemonkey/CmspageBanner

2, Add registration.php file in your module Magemonkey/CmspageBanner

<?php 
/**
 * @author Magemonkey Team
 * @package Magemonkey_CmspageBanner
 */
\Magento\Framework\Component\ComponentRegistrar::register(
 \Magento\Framework\Component\ComponentRegistrar::MODULE,
 'Magemonkey_CmspageBanner',
 __DIR__
);

<?php

/**

* @author Magemonkey Team

* @package Magemonkey_CmspageBanner

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Magemonkey_CmspageBanner',

__DIR__

);

3, Add module.xml file in your module Magemonkey/CmspageBanner/etc

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
 <module name="Magemonkey_CmspageBanner" setup_version="1.0.1">
 </module>
</config>

<?xml version="1.0"?>

</module>

</config>

4, Then create new schema file InstallSchema.php in Magemonkey/CmspageBanner/setup

<?php
namespace Magemonkey\CmspageBanner\Setup;

use Magento\Framework\Setup\InstallSchemaInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\SchemaSetupInterface;

class InstallSchema implements InstallSchemaInterface
{
 /**
 * Add Secondary Custom Content
 */
 public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)
 {
 $installer = $setup;

 $installer->startSetup();

 $setup->getConnection()->addColumn(
 $setup->getTable('cms_page'),
 'banner_block',
 [
 'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
 'length' => 255,
 'nullable' => true,
 'comment' => 'Banner Block Identifier'
 ]
 );

 $installer->endSetup();
 }
}

<?php

namespace Magemonkey\CmspageBanner\Setup;

use Magento\Framework\Setup\InstallSchemaInterface;

use Magento\Framework\Setup\ModuleContextInterface;

use Magento\Framework\Setup\SchemaSetupInterface;

class InstallSchema implements InstallSchemaInterface

{

/**

* Add Secondary Custom Content

public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)

{

$installer = $setup;

$installer->startSetup();

$setup->getConnection()->addColumn(

$setup->getTable('cms_page'),

'banner_block',

[

'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,

'length' => 255,

'nullable' => true,

'comment' => 'Banner Block Identifier'

]

);

$installer->endSetup();

}

5, Then add your need to add a field in ui_component form file cms_page_form.xml in Magemonkey/CmspageBanner/vew/adminhtml/ui_component

<?xml version="1.0" encoding="UTF-8"?>
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
 <fieldset name="general">
 <field name="banner_block">
 <argument name="data" xsi:type="array">
 <item name="config" xsi:type="array">
 <item name="dataType" xsi:type="string">text</item>
 <item name="label" xsi:type="string" translate="true">Banner Block Identifier</item>
 <item name="formElement" xsi:type="string">input</item>
 <item name="source" xsi:type="string">page</item>
 <item name="dataScope" xsi:type="string">banner_block</item>
 </item>
 </argument>
 </field>
 </fieldset>
</form>

<?xml version="1.0" encoding="UTF-8"?>

<item name="label" xsi:type="string" translate="true">Banner Block Identifier</item>

<item name="formElement" xsi:type="string">input</item>

<item name="dataScope" xsi:type="string">banner_block</item>

</item>

</argument>

</field>

</fieldset>

</form>

6, Then you need to create one block file for the call that field in the frontend, Banner.php in Magemonkey/CmspageBanner/Block

<?php
namespace Magemonkey\CmspageBanner\Block;

use Magento\Store\Model\ScopeInterface;

class Banner extends \Magento\Framework\View\Element\Template
{
 /**
 * @var \Magento\Cms\Model\Template\FilterProvider
 */
 protected $_filterProvider;

 /**
 * @var \Magento\Cms\Model\Page
 */
 protected $_page;

 /**
 * Store manager
 *
 * @var \Magento\Store\Model\StoreManagerInterface
 */
 protected $_storeManager;

 /**
 * Page factory
 *
 * @var \Magento\Cms\Model\PageFactory
 */
 protected $_pageFactory;

 /**
 * @var \Magento\Framework\View\Page\Config
 */
 protected $pageConfig;

 /**
 * Construct
 *
 * @param \Magento\Framework\View\Element\Template $context
 * @param \Magento\Cms\Model\Page $page
 * @param \Magento\Cms\Model\Template\FilterProvider $filterProvider
 * @param \Magento\Store\Model\StoreManagerInterface $storeManager
 * @param \Magento\Cms\Model\PageFactory $pageFactory
 * @param \Magento\Framework\View\Page\Config $pageConfig
 * @param array $data
 */
 public function __construct(
 \Magento\Framework\View\Element\Template\Context $context,
 \Magento\Cms\Model\Page $page,
 \Magento\Cms\Model\Template\FilterProvider $filterProvider,
 \Magento\Store\Model\StoreManagerInterface $storeManager,
 \Magento\Cms\Model\PageFactory $pageFactory,
 \Magento\Framework\View\Page\Config $pageConfig,
 array $data = []
 ) {
 // used singleton (instead factory) because there exist dependencies on \Magento\Cms\Helper\Page
 $this->_page = $page;
 $this->_filterProvider = $filterProvider;
 $this->_storeManager = $storeManager;
 $this->_pageFactory = $pageFactory;
 $this->pageConfig = $pageConfig;
 parent::__construct($context);
 }

 /**
 * Retrieve Page instance
 *
 * @return \Magento\Cms\Model\Page
 */
 public function getPageData()
 {
 if (!$this->hasData('page')) {
 if ($this->getPageId()) {
 /** @var \Magento\Cms\Model\Page $page */
 $page = $this->_pageFactory->create();
 $page->setStoreId($this->_storeManager->getStore()->getId())->load($this->getPageId(), 'identifier');
 } else {
 $page = $this->_page;
 }
 $this->setData('page', $page);
 }
 return $this->getData('page');
 }
}

<?php

namespace Magemonkey\CmspageBanner\Block;

use Magento\Store\Model\ScopeInterface;

class Banner extends \Magento\Framework\View\Element\Template

{

/**

* @var \Magento\Cms\Model\Template\FilterProvider

protected $_filterProvider;

/**

* @var \Magento\Cms\Model\Page

protected $_page;

/**

* Store manager

* @var \Magento\Store\Model\StoreManagerInterface

protected $_storeManager;

/**

* Page factory

* @var \Magento\Cms\Model\PageFactory

protected $_pageFactory;

/**

* @var \Magento\Framework\View\Page\Config

protected $pageConfig;

/**

* Construct

* @param \Magento\Framework\View\Element\Template $context

* @param \Magento\Cms\Model\Page $page

* @param \Magento\Cms\Model\Template\FilterProvider $filterProvider

* @param \Magento\Store\Model\StoreManagerInterface $storeManager

* @param \Magento\Cms\Model\PageFactory $pageFactory

* @param \Magento\Framework\View\Page\Config $pageConfig

* @param array $data

public function __construct(

\Magento\Framework\View\Element\Template\Context $context,

\Magento\Cms\Model\Page $page,

\Magento\Cms\Model\Template\FilterProvider $filterProvider,

\Magento\Store\Model\StoreManagerInterface $storeManager,

\Magento\Cms\Model\PageFactory $pageFactory,

\Magento\Framework\View\Page\Config $pageConfig,

array $data = []

) {

// used singleton (instead factory) because there exist dependencies on \Magento\Cms\Helper\Page

$this->_page = $page;

$this->_filterProvider = $filterProvider;

$this->_storeManager = $storeManager;

$this->_pageFactory = $pageFactory;

$this->pageConfig = $pageConfig;

parent::__construct($context);

}

/**

* Retrieve Page instance

* @return \Magento\Cms\Model\Page

public function getPageData()

{

if (!$this->hasData('page')) {

if ($this->getPageId()) {

/** @var \Magento\Cms\Model\Page $page */

$page = $this->_pageFactory->create();

$page->setStoreId($this->_storeManager->getStore()->getId())->load($this->getPageId(), 'identifier');

} else {

$page = $this->_page;

}

$this->setData('page', $page);

}

return $this->getData('page');

}

After that you need to run setup:upgrade command

Then after you can call that block in your cms page Like:

<block class="Magemonkey\CmspageBanner\Block\Banner" name="page.banner" template="Magemonkey_CmspageBanner::html/banner.phtml" after="-" />

1	<block class="Magemonkey\CmspageBanner\Block\Banner" name="page.banner" template="Magemonkey_CmspageBanner::html/banner.phtml" after="-" />

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-63d98383d1522792915895/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento Developer

Hire T. Baldha

Let’s have a call

Fill the form & Get Installation Support