Extend Magento 2 Onepage Success Block to Display Additional Order Information

magento2

I created a new module to display order total and some other information on Magento 2 success since page OOB success displays order id alone. Steps taken are below.

Created new Block that extends Onepage Success and added new method(s).
Copied OOB Onepage success.phtml to custom module view\frontend\templates\mysuccess.phtml and modified to call new methods from custom Block.

Added di.xml to replace OOB <preference for="Magento\Checkout\Block\Onepage\Success" type="VendorName\Checkout\Block\Onepage\CustomSuccess"/>

Also created view\frontend\layout\checkout_onepage_success.xml with below entry to use new template phtml file.

<referenceBlock name="checkout.success" template="VendorName_Checkout::mysuccess.phtml"/>

Also created module.xml and increased sequence number. Can anyone tell me what else do I need to use the new template and Block since I see blank success page instead of new block methods getting called?

I looked at Call custom phtml on success page without override and made similar changes but still no luck. What am I missing?
It's Magento 2.2.x CE.

Best Answer

You can insert your own custom block by overriding checkout_onepage_success.xml
Try the below steps:

Create your CustomSuccess.php Block file in vendor\module\Block\OnePage

<?php
namespace vendor\module\Block\OnePage;
class CustomSuccess extends \Magento\Framework\View\Element\Template
{
    public function getCustomSuccess()
    {
        return 'Your custom block contents.';
    }
}

Create checkout_onepage_success.xml layout file in vendor\module\view\frontend\layout

<?xml version="1.0"?>
<body>
    <referenceContainer name="order.success.additional.info">
        <block class="vendor\module\Block\OnePage\CustomSuccess"
               name="custom.order.success"
               template="Vendor_Module::order/success.phtml"
               after="-">
        </block>
    </referenceContainer>
</body>

Lastly, create phtml template file in vendor\module\view\frontend\templates\order

<?php /* @var $block \vendor\module\Block\OnePage\CustomSuccess */?>
<?php echo __('This is a custom content.'); ?>
<?php echo $block->getCustomSuccess(); ?>

Don't forget to run the upgrade command and redeploy static view files.

Related Solutions

Magento – Magento 2 create custom block and phtml in Magento_Customer module

Create a Module Namspace/Customer

Create xml view/frontend/layout/customer_account_myinformation.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="2columns-left"  xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <update handle="customer_account"/>
    <body>

        <referenceContainer name="content">
            <block class="NameSpace\Customer\Block\Account\MyInformation" name="myinformation" template="account/myinformation.phtml"></block>
        </referenceContainer>

    </body>
</page>

Create phtml file view/frontend/templates/account/myinformation.phtml

Add Your Code in phtml

Create Controller Controller/Account/MyInformation.php

    <?php

namespace Namespace\Customer\Controller\Account;

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Magento\Framework\Exception\InputException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\View\Result\PageFactory;


/**
 * For MyInformation Controller
 */
class MyInformation extends Action
{

    protected $resultPageFactory;



    protected $coreRegistry;

    /**
     * Index constructor.
     * @param Context $context
     * @param PageFactory $resultPageFactory
     */
    public function __construct(
        Context $context,
        \Magento\Framework\Registry $coreRegistry,
        PageFactory $resultPageFactory,

    ) {
        $this->resultPageFactory = $resultPageFactory;

        parent::__construct($context);
    }

    /**
     * @return \Magento\Framework\App\ResponseInterface|\Magento\Framework\Controller\ResultInterface|\Magento\Framework\View\Result\Page
     */
    public function execute()
    {
        $this->initiateCustomer();
        $resultPage = $this->resultPageFactory->create();
        $resultPage->getConfig()->getTitle()->prepend(__('My Information'));
        return $resultPage;
    }



}// end class

create Block Block\Account\MyInformation.php

<?php

namespace NameSpace\Customer\Block\Account;


use Magento\Framework\View\Element\Template;

use Magento\Customer\Model\Session;


class MyInformation extends Template
{


    /**
     * @var \Magento\Framework\Registry
     */
    protected $registry;



    protected $customerSession;

    protected $url;

    /**
     * Cancel constructor.
     * @param \Magento\Framework\View\Element\Template\Context $context
     * @param array $data
     * @param \Magento\Framework\Registry $registry
     */
    public function __construct(
        Template\Context $context,
        array $data = [],

        Session $customerSession,

    ) {


        $this->customerSession = $customerSession;

        parent::__construct($context, $data);
    }

    /**
     * Retrieve current order model instance
     *
     * @return \Magento\Sales\Model\Order
     */
    public function getCustomer()
    {
        return $this->customerSession->getCustomer();
    }





}//end class

create routes.xml etc/frontend/routes.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="standard">
        <route id="namespace_customer">
            <module name="Namespace_Customer"/>
        </route>
    </router>
</config>

Hope it will help you. Please vote us if you like our answer.

Magento – Display Remove and Edit Item button in Order summary in Onepage Checkout page Magento2

it's deleting the product when checked in the cart. To direct to the checkout page itself, in /magento_demo/vendor/magento/module-checkout/view/frontend/web/js/view/summary/item/details.js,

replace var baseUrl = url.build('checkout/cart/'); with var baseUrl = url.build('checkout/'); .

Check the above. It is working fine for me.

Best Answer

Related Solutions

Magento – Magento 2 create custom block and phtml in Magento_Customer module

Magento – Display Remove and Edit Item button in Order summary in Onepage Checkout page Magento2

Related Topic