Magento 2 How to get all xml loaded tree

Goal: After reading this tutorial Magento 2 How to get all xml loaded tree , you can output any layout xml file of any page in magento 2.
Sometime you have a desire to print all xml loaded tree to check whether your custom xml handles are loaded or not ?
For this purpose, I have written a simple module to print all xml loaded tree in a xml file, so checking your custom module xml is more easily.

The general ideas of this extension :

• We listen to an event “layout_generate_blocks_after” and get all loaded tree from that point.
• Save all loaded tree to an xml file.

It sounds easily right ? Here is how we create it.

The module we will create like the below image:

1. We create a new directory Thienphucvx/Dev.
2. Create Thienphucvx/Dev/registration.php to declare with Magento 2 about our module directory.
   
   PHP

   <?php \Magento\Framework\Component\ComponentRegistrar::register( \Magento\Framework\Component\ComponentRegistrar::MODULE, 'Thienphucvx_Dev', __DIR__ );

   1 2 3 4 5 6 7

   <?php   \Magento\Framework\Component\ComponentRegistrar::register(     \Magento\Framework\Component\ComponentRegistrar::MODULE,     'Thienphucvx_Dev',     __DIR__ );

3. Create Thienphucvx/Dev/etc/module.xml : To let Magento 2 know about setup version of our module
   
   XHTML

   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="module.xsd"> <module name="Thienphucvx_Dev" setup_version="1.0.0" schema_version="1.0.0" release_version="1.0.1"> </module> </config>

   1 2 3 4 5

   <?xml version="1.0"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="module.xsd">     <module name="Thienphucvx_Dev" setup_version="1.0.0" schema_version="1.0.0" release_version="1.0.1">     </module> </config>

4. Create Thienphucvx/Dev/etc/fronted/event.xml. In this file, we will listen to event “layout_generate_blocks_after”
   
   PHP

   <?xml version="1.0" encoding="UTF-8"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd"> <event name="layout_generate_blocks_after"> <observer name="thienphucvx_layout_generate_blocks_after" instance="Thienphucvx\Dev\Model\Layout" /> </event> </config>

   1 2 3 4 5 6 7 8

   <?xml version="1.0" encoding="UTF-8"?> <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">       <event name="layout_generate_blocks_after">         <observer name="thienphucvx_layout_generate_blocks_after" instance="Thienphucvx\Dev\Model\Layout" />     </event>   </config>

5. Create Thienphucvx/Dev/Model/Layout.php with the content as below
   
   PHP

   <?php /** * Copyright © 2015 Thienphucvx.com. All rights reserved. */ namespace Thienphucvx\Dev\Model; use Magento\Framework\Event\Observer; use Magento\Framework\Event\ObserverInterface; class Layout implements ObserverInterface { protected $_logger; public function __construct ( \Psr\Log\LoggerInterface $logger ) { $this->_logger = $logger; } public function execute(\Magento\Framework\Event\Observer $observer) { $xml = $observer->getEvent()->getLayout()->getXmlString(); /*$this->_logger->debug($xml);*/ $writer = new \Zend\Log\Writer\Stream(BP . '/var/log/layout_block.xml'); $logger = new \Zend\Log\Logger(); $logger->addWriter($writer); $logger->info($xml); return $this; } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

   <?php /** * Copyright © 2015 Thienphucvx.com. All rights reserved. */ namespace Thienphucvx\Dev\Model; use Magento\Framework\Event\Observer; use Magento\Framework\Event\ObserverInterface; class Layout  implements ObserverInterface {     protected $_logger;     public function __construct ( \Psr\Log\LoggerInterface $logger     ) {         $this->_logger = $logger;     }       public function execute(\Magento\Framework\Event\Observer $observer)     {         $xml = $observer->getEvent()->getLayout()->getXmlString();         /*$this->_logger->debug($xml);*/         $writer = new \Zend\Log\Writer\Stream(BP . '/var/log/layout_block.xml');         $logger = new \Zend\Log\Logger();         $logger->addWriter($writer);         $logger->info($xml);         return $this;     } }

6. Set up module
   In your home website directory. enter CMD command line:
   – php bin/magento module:enable Thienphucvx_Dev
   – php bin/magento setup:upgrade
   
7. Refresh the page that you want to see xml file (for example: your home page)  and check your handle xml file  in var/log/layout_block.xml .

Happy coding ! If you have any questions, please let me know.