Magento 1.9 – How to Add Custom Field in Review Form

databasemagento-1.9review

I want to add a custom field to the review form in Magento.
I have tried this but the data is not saved, it shows the field.

app\code\core\Mage\Adminhtml\Block\Review\Edit\Form.php

$fieldset->addField('email', 'text', array( // New field 1
'label' => Mage::helper('review')->__('Email'),
'required' => true,
'name' => 'email'
));

After

$fieldset->addField('nickname', 'text', array(
'label' => Mage::helper('review')->__('Nickname'),
'required' => true,
'name' => 'nickname'
));

app\design\frontend\theme\theme\template\review\form.phtml

        <li class="formlistreview">
            <label for="email_field" class="required"><em>*</em><?php echo $this->__('E-mail') ?></label>
            <div class="input-box">
                <input type="text" name="email" id="email_field" class="input-text required-entry" value="<?php echo $this->htmlEscape($data->getEmail()) ?>" />
            </div>
        </li>

app\code\core\Mage\Review\Model\Resource\Review.php

protected function _afterSave(Mage_Core_Model_Abstract $object)
{
$detail = array(
'title' => $object->getTitle(),
'detail' => $object->getDetail(),
'nickname' => $object->getNickname(),
'email' => $object->getEmail(), // New field 1
);

What am I missing?

Best Answer

use $this instead of $object

protected function _afterSave(Mage_Core_Model_Abstract $object)
{
$detail = array(
'title' => $this->getTitle(),
'detail' => $this->getDetail(),
'nickname' => $this->getNickname(),
'email' => $this->getEmail(), // New field 1
);

1. Add one attribute for each input field to the order

To add the order attribute, create a setup script with the following contents, after adding a setup resource and a version number to your module:

/* @var $installer Mage_Sales_Model_Resource_Setup */
$installer = Mage::getResourceModel('sales/setup', 'sales_setup');

$installer->startSetup();

$installer->addAttribute('order', 'my_field', array(
    'label' => 'My Field',
    'type' => 'varchar',
    'input' => 'text',
    'required' => false,
));

$installer->endSetup();

2. Display the input field(s) on the review step

To display the input field in the review step, first add a layout XML file to your module:

<frontend>
    <layout>
        <updates>
            <namespace_reviewfieldield>
                <file>namespace/reviewfield.xml</file>
            </namespace_reviewfieldield>
        </updates>
    </layout>
</frontend>

Then create the layout XML file base/default/layout/namespace/reviewfield.xml with the following contents:

<?xml version="1.0"?>
<layout>
    <checkout_onepage_review>
        <reference name="checkout.onepage.review.info.items.after">
            <block type="core/template" name="namespace.reviewField" template="namespace/reviewfield/form.phtml"/>
        </reference>
    </checkout_onepage_review>
</layout>

Finally you create the template base/default/template/namespace/reviewfield/form.phtml

<div class="checkout-agreements">
    <input type="text" name="namespace_reviewfield" id="namespace_reviewfield"/>
    <label for="namespace_reviewfield">Please specify Foo</label>
</div>

3. Make sure the input fields are submitted when the order is saved

Now the field will be displayed after the totals on the review step. But because the field is not inside of any form, you need to take care it is submitted when the order is saved.
Add the following JavaScript to your form.phtml template.

<script type="text/javascript">
    // Add our field to the data submitted by Review.save()
    Review.prototype.save = Review.prototype.save.wrap(function(orig) {
        var form = this.agreementsForm ? this.agreementsForm : payment.form;
        if (form) {
            var myfield = $('namespace_reviewfield');
            form.insert(myfield);
        }
        orig();
    });
</script>

4. Set the submitted values on the order

Now the field value will be sent to Magento when the order is submitted. Only so far, nothing else happens with it. You have to set the submitted value on the order. A good way to do that is using an event observer for the checkout_type_onepage_save_order event.

<frontend>
    <events>
        <checkout_type_onepage_save_order>
            <observers>
                <namespace_reviewfield>
                    <type>model</type>
                    <class>namespace_reviewfield/observer</class>
                    <method>checkoutTypeOnepageSaveOrder</method>
                </namespace_reviewfield>
            </observers>
        </checkout_type_onepage_save_order>
    </events>
</frontend>

The observer class itself is very simple:

class NameSpace_ReviewField_Model_Observer
{
    public function checkoutTypeOnepageSaveOrder(Varien_Event_Observer $observer)
    {
        /** @var Mage_Sales_Model_Order $order */
        $param = Mage::app()->getRequest()->getParam('namespace_reviewfield', '');
        $observer->getOrder()->setMyField((string) $param);
    }
}

And that takes care of the frontend side of things.

5. Add a new tab to the order info page in the backend

Unfortunately, there is no "nice" way to add content to the general order info page. It's much more compatible to add a new tab with the new content you want to display. To do that, you first need to add an adminhtml layout XML file:

<adminhtml>
    <layout>
        <updates>
            <namespace_reviewfield>
                <file>namespace/reviewfield.xml</file>
            </namespace_reviewfield>
        </updates>
    </layout>
</adminhtml>

The new tab itself is then added in the layout XML declaration. There are several ways this can be done, but I suggest you use the probably most straightforward way by adding the following code to the file adminhtml/default/layout/namespace/reviewfield.xml

<?xml version="1.0"?>
<layout>
    <adminhtml_sales_order_view>
        <reference name="sales_order_tabs">
            <action method="addTab">
                <name>namespace_reviewfield</name>
                <block>namespace_reviewfield/adminhtml_order_tab_reviewfield</block>
            </action>
        </reference>
    </adminhtml_sales_order_view>
</layout>

6. Display the field values

Now you only need to create the block that you specified in the layout XML and a matching template. The block class has to implement Mage_Adminhtml_Block_Widget_Tab_Interface, otherwise a "Wrong Tab Configuration" exception will be thrown.
Here is a simple example:

class NameSpace_ReviewField_Block_Adminhtml_Order_Tab_Reviewfield
    extends Mage_Adminhtml_Block_Widget
    implements Mage_Adminhtml_Block_Widget_Tab_Interface
{
    protected function _prepareLayout()
    {
        $this->setTemplate('namespace/order/tab/reviewfield.phtml');
    }

    public function getOrder()
    {
        return Mage::registry('current_order');
    }

    public function getTabLabel()
    {
        return $this->__('Review Field');
    }

    public function getTabTitle()
    {
        return $this->getTabLabel();
    }

    public function canShowTab()
    {
        return true;
    }

    public function isHidden()
    {
        return false;
    }
}

The final missing thing is the template adminhtml/default/template/namespace/order/tab/reviewfield.phtml. Just make sure you properly escape any user input to avoid XSS holes.

<?php /** @var NameSpace_ReviewField_Block_Adminhtml_Order_Tab_Reviewfield $this */ ?>
<div>
    <?php echo $this->__('The customer entered: %s', $this->escapeHtml($this->getOrder()->getMyField())) ?>
</div>

Hope that helps you along the way to implement the functionality you require.

Magento – Add email field to Review Form – Magento 2

Seeing as how there's no clear answer on this yet, this might help some people. To add an e-mail field (or any other field) to the frontend review form and display it in the admin we have to create a custom module.

With this module we'll:

Create a custom field in the database
Save data
Display in the admin

NOTE: Be sure to replace "Vendor" with your desired vendor name.

app\code\Vendor\ReviewEmail\registration.php

<?php

\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Vendor_ReviewEmail',
    __DIR__
);

app\code\Vendor\ReviewEmail\etc\module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Vendor_ReviewEmail" setup_version="1.0.0">
        <sequence>
            <module name="Magento_Review" />
        </sequence>
    </module>
</config>

app\code\Vendor\ReviewEmail\etc\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\Review\Block\Adminhtml\Edit\Form">
        <plugin name="modify_review_edit_form" type="Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit\Form" />
    </type>    

</config>

app\code\Vendor\ReviewEmail\etc\events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">

    <event name='review_save_after'>
        <observer name='vendor_reviewemail_save_after' instance='Vendor\ReviewEmail\Model\Observer\ReviewSave'/>
    </event>    

</config>

app\code\Vendor\ReviewEmail\Setup\InstallSchema.php

<?php
namespace Vendor\ReviewEmail\Setup;

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

/**
 * @codeCoverageIgnore
 */
class InstallSchema implements InstallSchemaInterface
{
    /**
     * {@inheritdoc}
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        $installer = $setup;

        $installer->startSetup();

        $installer->getConnection()->addColumn(
            $installer->getTable('review_detail'),
            'email',
            [
                'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
                'length' => 255,
                'nullable' => true,
                'comment' => 'Email address'
            ]
        );

        $setup->endSetup();

    }
}

app\code\Vendor\ReviewEmail\Model\Observer\ReviewSave.php

<?php

namespace Vendor\ReviewEmail\Model\Observer;

use Magento\Framework\Event\ObserverInterface;

class ReviewSave implements ObserverInterface
{
    public function __construct(
        \Magento\Framework\App\ResourceConnection $resource
    ) {
        $this->_resource = $resource;
    }

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $review = $observer->getEvent()->getDataObject();
        $connection = $this->_resource;

        $tableName = $connection->getTableName('review_detail');
        $detail = [
            'email' => $review->getEmail(),
        ];

        if (empty($review->getEmail())) return;

        $select = $connection->getConnection()->select()->from($tableName)->where('review_id = :review_id');
        $detailId = $connection->getConnection()->fetchOne($select, [':review_id' => $review->getId()]);

        if ($detailId) {
            $condition = ["detail_id = ?" => $detailId];
            $connection->getConnection()->update($tableName, $detail, $condition);
        } else {
            $detail['store_id'] = $review->getStoreId();
            $detail['customer_id'] = $review->getCustomerId();
            $detail['review_id'] = $review->getId();
            $connection->getConnection()->insert($tableName, $detail);
        }   
    }
}

app\code\Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit\Form.php

<?php

namespace Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit;

class Form extends \Magento\Review\Block\Adminhtml\Edit\Form
{
    public function beforeSetForm(\Magento\Review\Block\Adminhtml\Edit\Form $object, $form) {

        $review = $object->_coreRegistry->registry('review_data');

        $fieldset = $form->addFieldset(
            'review_details_extra',
            ['legend' => __('Review Details Extra Data'), 'class' => 'fieldset-wide']
        );

        $fieldset->addField(
            'email',
            'text',
            ['label' => __('E-mail'), 'required' => false, 'name' => 'email']
        );

        $form->setValues($review->getData());

        return [$form];
    }
}

app\code\Vendor\ReviewEmail\view\adminhtml\ui_component\review_listing.xml (Optional, only if you want to show the field in the admin grid as well)

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="review_columns">
        <column name="email">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="filter" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">E-mail</item>
                    <item name="sortOrder" xsi:type="number">45</item>
                    <item name="truncate" xsi:type="number">50</item>
                    <item name="nl2br" xsi:type="boolean">true</item>
                    <item name="escape" xsi:type="boolean">true</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

After this all we have left to do is add the field to the review form. In app\design\frontend\Vendor\yourtheme\Magento_Review\templates\form.phtml

<input type="text" name="email" id="email_field" class="block mb2 full-width validate-email" data-validate="{required:true}"/>

Make sure to add this between the form tags.

After installing the module and clearing your caches you should now have an e-mail field in your review form. Which should be visible in the admin grid and admin review detail view.