Hello Everyone,
In this blog, we will learn about how to Add a WYSIWYG Editor in system.xml in Magento 2.
Meaning of WYSIWYG is “What You See Is What You Get”. Using WYSIWYG editor you no need to HTML tags to design the page.
The editor allows you to add HTML content, font, images etc.
Without wasting your time, let us guide you straight away. Follow the easy step given below to Add WYSIWYG Editor in Configuration file in Magento 2.
STEPS FOR ADD WYSIWYG EDITOR IN MAGENTO 2
Step 1: Create system.xml file
app/code/Vendor/Extension/etc/adminhtml/system.xml
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<tab id="magecurious" class="magecurious" translate="label" sortOrder="10">
<label>Magecurious</label>
</tab>
<section id="extension" translate="label" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
<class>separator-top</class>
<label>Magecurious</label>
<tab>magecurious</tab>
<resource>Vendor_Extension::config_extension</resource>
<group id="general" translate="label" type="text" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
<label>General Configuration</label>
<field id="enable" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Enable Extension</label>
<source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
</field>
<field id="vendor_wysiwyg_editor" translate="label" type="editor" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
<label>WYSIWYG Editor</label>
<frontend_model>Vendor\Extension\Block\Adminhtml\System\Config\Editor</frontend_model>
</field>
</group>
</section>
</system>
</config>
Step 2: Create Editor.php file
app/code/Vendor/Extension/Block/Adminhtml/System/Config/Editor.php
<?php
namespace Vendor\Extension\Block\Adminhtml\System\Config;
use Magento\Backend\Block\Template\Context;
use Magento\Cms\Model\Wysiwyg\Config as WysiwygConfig;
use Magento\Config\Block\System\Config\Form\Field;
class Editor extends Field
{
public function __construct(
Context $context,
WysiwygConfig $wysiwygConfig,
array $data = [])
{
$this->wysiwygConfig = $wysiwygConfig;
parent::__construct($context, $data);
}
protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$element->setWysiwyg(true);
$element->setConfig($this->wysiwygConfig->getConfig($element));
return parent::_getElementHtml($element);
}
}
Step 3: Finally run the below commands
$ php bin/magento cache:clean
$ php bin/magento cache:flush
Step 4: Output:
Final Thoughts:
So this was the easiest way which we have told you in this blog. This is how you can Add WYSIWYG Editor in system.xml configuration file in Magento 2. Hope you liked the blog.
So quickly go to the comment box and tell me how you like this blog?
Stay tuned with us on our site to get new updates of Magento.
Thanks for reading and visiting our site.
