Magento 2 Custom Module – Add Enable/Disable Field

extensionsmagento-2.1magento2modulePHP

I want to add some fields in the Magento 2 Admin Panel for my custom module and then I want to check in the phtml file if this field is have value or not.

I need to add this fields:

- enable / disable (yes/no field type) ;
- Add text {input text field type};
- upload image;

the upload image field must have the option to delete the image too.

For enable / disable I add this in the system.xml:

  <section id="mymodule" translate="label" sortOrder="130" showInDefault="1" showInWebsite="1" showInStore="1">
        <class>separator-top</class>
        <label>Module</label>
        <tab>mymodule</tab>
        <resource>Module_First::mymodule_configuration</resource>
        <group id="general" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0">
            <label>General Configuration</label>
            <field id="enable" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="0" showInStore="0">
                <label>Enable</label>
                <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
            </field>
        </group>
    </section>

I want to know what is the format for adminhtml/system.xml and how I can check this fields value in the phtml file (or what is the best way to check the value for this fields).

Thank you

Best Answer

Add below code into each of your controller at first line of execute method:

if (!$this->moduleEnabled()) {
    return $this->_forwardNoroute();
}

moduleEnabled():

/**
 * Retrieve true if extension is enabled.
 *
 * @return bool
 */
protected function moduleEnabled()
{
    return (bool) $this->getConfigValue(
        self::XML_PATH_EXTENSION_ENABLED,
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE
    );
}

XML_PATH_EXTENSION_ENABLED contains path of system.xml to enabled/disabled module

/**
 * Extension enabled config path
 */
const XML_PATH_EXTENSION_ENABLED = '<Secton_Name>/general/enabled';

Related Solutions

Magento 1.7 – Show Images in Custom Admin Module

You have to add the fields in _prepareForm() in \NameSpace\ModuleName\Block\Adminhtml\ModuleName\Edit\Tab\Form.php add the below code.

$fieldset->addField('<Data base Field name>', 'image', array(
        'label' => Mage::helper('<Module Name>')->__('Logo'),
        'name' => '<your Data base Field name>',
        'note' => '(*.jpg, *.png, *.gif)'
 ));

Magento 2 – Add New Field to Magento_User Admin Form

For adding image field, you can try using plugin and always try to avoid overwrite whole class.

Vendor/Module/etc/adminhtml/di.xml


<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Magento\User\Block\User\Edit\Tab\Main">
        <plugin name="sr_stackexchange_user_form" type="Vendor\Module\Plugin\Block\Adminhtml\User\Edit\Tab\Main" sortOrder="1"/>
    </type>
</config>

Vendor/Module/Plugin/Block/Adminhtml/User/Edit/Tab/Main.php


namespace Vendor\Module\Plugin\Block\Adminhtml\User\Edit\Tab;

class Main
{
    /**
     * Get form HTML
     *
     * @return string
     */
    public function aroundGetFormHtml(
        \Magento\User\Block\User\Edit\Tab\Main $subject,
        \Closure $proceed
    )
    {
        $form = $subject->getForm();
        if (is_object($form)) {
            $fieldset = $form->addFieldset('admin_user_image', ['legend' => __('User Image')]);
            $fieldset->addField(
                'user_image',
                'image',
                [
                    'name' => 'user_image',
                    'label' => __('Image'),
                    'id' => 'user_image',
                    'title' => __('Image'),
                    'required' => false,
                    'note' => 'Allow image type: jpg, jpeg, png'
                ]
            );

            $subject->setForm($form);
        }

        return $proceed();
    }
}

Clear cache.

Related Topic