Customizing the Customer Address Grid in Magento 2

To modify the customer address grid in Magento 2, you can override the grid.phtml template. This allows you to add or update columns in the address list displayed on the Address Book page.

Overriding at the Theme Level

Locate the Template File:

• Navigate to app/design/frontend/{Vendor}/{themename}/Magento_Customer/templates/address/grid.phtml.

Copy the Original Template:

• Copy the original grid.phtml from vendor/magento/module-customer/view/frontend/templates/address/grid.phtml to the path identified above.

Modify the Template:

• Edit the copied grid.phtml to include the desired changes, such as adding new columns.

Overriding at the Module Level

Create a Custom Module:

• Create a module with the following directory structure:

app/code/{Vendor}/{Module}/

├── Block/

│ └── Address/

│ └── Grid.php

├── view/

│ └── frontend/

│ └── templates/

│ └── address/

│ └── grid.phtml

└── etc/

└── frontend/

└── di.xml

To display content when a condition is false:

<!-- ko ifnot: condition -->

<!-- Your content here -->

<!-- /ko -->

Define the Block Class:

In app/code/{Vendor}/{Module}/Block/Address/Grid.php, extend the core block class:

<?php

namespace {Vendor}\{Module}\Block\Address;

use Magento\Customer\Block\Address\Grid as CoreGrid;

class Grid extends CoreGrid

{"

// Customizations go here

}

</div>

Override the Template:

• In app/code/{Vendor}/{Module}/view/frontend/templates/address/grid.phtml, copy and modify the original template as needed.

Configure Dependency Injection:

In app/code/{Vendor}/{Module}/etc/frontend/di.xml, add:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

<type name="Magento\Customer\Block\Address\Grid">

<arguments>

<argument name="template" xsi:type="string">{Vendor}_{Module}::address/grid.phtml</argument>

</arguments>

</type>

</config>

Clear Cache:

• Run php bin/magento cache:flush to apply the changes.

Ensure that your custom module is enabled and properly configured. For more detailed guidance, refer to the official Magento documentation on overriding templates.

    
        
            
                Vendor_Module::address/grid.phtml