Understanding Magento 2 Layout and Blocks

Oct 13, 2025 by magicalceylontours.com 23 views

Introduction

Magento 2 provides a robust and flexible platform for managing sales orders. However, by default, the order view page includes several tabs that may not be necessary for all users. In this article, we will explore how to remove these tabs in the order view page using Magento 2's layout and block management system.

Understanding Magento 2 Layout and Blocks

Magento 2 uses a layout system to manage the structure and content of pages. The layout is composed of blocks, which are reusable pieces of content that can be combined to form a page. Each block has a unique name and can be referenced in the layout XML files.

Removing a Block using ReferenceBlock

You are already familiar with removing a block using the referenceBlock tag with the remove attribute set to true. This is a common technique used to remove a block from the layout. However, when a block is added using an argument, the referenceBlock tag alone may not be enough to remove it.

Removing a Tab added using an Argument

When a block is added using an argument, it is not possible to remove it using the referenceBlock tag alone. In this case, you need to use the referenceContainer tag to remove the block.

Using referenceContainer to Remove a Block

To remove a block added using an argument, you need to use the referenceContainer tag to reference the container where the block is added. Here is an example:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\Info" name="sales_order_tabs_info" remove="true"/>
</referenceContainer>

In this example, we are referencing the sales_order_tabs container and removing the sales_order_tabs_info block.

Using referenceContainer with a Block Name

When a block is added using an argument, it may not have a unique name. In this case, you can use the referenceContainer tag with the block tag to remove the block. Here is an example:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\Info" name="sales_order_tabs_info" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\Info" name="sales_order_tabs_info" remove="true"/>
</referenceContainer>

In this example, we are referencing the sales_order_tabs container and removing two blocks with the same class and name.

Using referenceContainer with a Block Class

When a block is added using an argument, it may not have a unique name or class. In this case, you can use the referenceContainer tag with the block tag and the class attribute to remove the block. Here is an example:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\Info" remove="true"/>
</referenceContainer>

In this example, we are referencing the sales_order_tabs container and removing the block with the class Magento\Sales\Block\Order\Tabs\Info.

Conclusion

Removing tabs in the order view page in Magento 2 can be a complex task, especially when blocks are added using arguments. However, by using the referenceContainer tag and the block tag, you can remove blocks with unique names, classes, or both. Remember to always reference the correct container and block to avoid removing unintended blocks.

Example Use Cases

Removing the "Info" tab from the order view page:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\Info" name="sales_order_tabs_info" remove="true"/>
</referenceContainer>

Removing the "History" tab from the order view page:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\History" name="sales_order_tabs_history" remove="true"/>
</referenceContainer>

Removing all tabs from the order view page:

<referenceContainer name="sales_order_tabs">
    <block class="Magento\Sales\Block\Order\Tabs\Info" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\History" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\Shipping" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\Invoice" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\Creditmemo" remove="true"/>
    <block class="Magento\Sales\Block\Order\Tabs\Shipment" remove="true"/>
</referenceContainer>

Q: How do I remove a tab from the order view page in Magento 2?

A: To remove a tab from the order view page in Magento 2, you need to use the referenceContainer tag to reference the container where the tab is added, and then use the block tag to remove the tab.

Q: What is the difference between `referenceBlock` and `referenceContainer`?

A: referenceBlock is used to reference a specific block in the layout, while referenceContainer is used to reference a container where multiple blocks are added.

Q: How do I remove a block added using an argument?

A: To remove a block added using an argument, you need to use the referenceContainer tag to reference the container where the block is added, and then use the block tag to remove the block.

Q: Can I remove multiple blocks at once?

A: Yes, you can remove multiple blocks at once by using the referenceContainer tag to reference the container where the blocks are added, and then using the block tag to remove each block.

Q: How do I remove all tabs from the order view page?

A: To remove all tabs from the order view page, you need to use the referenceContainer tag to reference the container where the tabs are added, and then use the block tag to remove each tab.

Q: What if I don't know the name or class of the block I want to remove?

A: If you don't know the name or class of the block you want to remove, you can use the referenceContainer tag to reference the container where the block is added, and then use the block tag with the class attribute to remove the block.

Q: Can I remove a block that is added using a layout update?

A: Yes, you can remove a block that is added using a layout update by using the referenceContainer tag to reference the container where the block is added, and then using the block tag to remove the block.

Q: How do I know which container to reference?

A: To know which container to reference, you need to check the layout XML files to see which container is used to add the block you want to remove.

Q: Can I remove a block that is added using a module's layout update?

A: Yes, you can remove a block that is added using a module's layout update by using the referenceContainer tag to reference the container where the block is added, and then using the block tag to remove the block.

Q: How do I know which block to remove?

A: To know which block to remove, you need to check the layout XML files to see which block is added to the container you are referencing.

Q: Can I remove a block that is added using a layout update from a third-party module?

A: Yes, you can remove a block that is added using a layout update from a third-party module by using the referenceContainer tag to reference the container where the block is added, and then using the block tag to remove the block.

Q: How do I know which container to reference when removing a block from a third-party module?

A: To know which container to reference when removing a block from a third-party module, you need to check the layout XML files of the third-party module to see which container is used to add the block you want to remove.

Q: Can I remove a block that is added using a layout update from a custom module?

A: Yes, you can remove a block that is added using a layout update from a custom module by using the referenceContainer tag to reference the container where the block is added, and then using the block tag to remove the block.

Q: How do I know which container to reference when removing a block from a custom module?

A: To know which container to reference when removing a block from a custom module, you need to check the layout XML files of the custom module to see which container is used to add the block you want to remove.

Q: Can I remove a block that is added using a layout update from a Magento 2 core module?

A: Yes, you can remove a block that is added using a layout update from a Magento 2 core module by using the referenceContainer tag to reference the container where the block is added, and then using the block tag to remove the block.

Q: How do I know which container to reference when removing a block from a Magento 2 core module?

A: To know which container to reference when removing a block from a Magento 2 core module, you need to check the layout XML files of the Magento 2 core module to see which container is used to add the block you want to remove.