Fix loading custom page layouts in AJAX calls

Author: jissereitsma

Util/Controller/LayoutLoader.php

@@ -4,8 +4,10 @@
 
 use Loki\Components\Layout\LayoutHandlerComposite;
 use Magento\Framework\View\Layout\BuilderFactory;
+use Magento\Framework\View\Layout\ProcessorInterface;
 use Magento\Framework\View\LayoutFactory;
 use Magento\Framework\View\LayoutInterface;
+use Magento\Framework\View\Model\PageLayout\Config\BuilderInterface as PageLayoutConfigBuilder;
 use Magento\Framework\View\Page\Config as PageConfig;
 use Magento\Framework\View\Page\ConfigFactory as PageConfigFactory;
 use Magento\Framework\View\Page\Layout\Reader as PageLayoutReader;
@@ -20,22 +22,26 @@ public function __construct(
         private readonly PageConfig $pageConfig,
         private readonly PageConfigFactory $pageConfigFactory,
         private readonly PageLayoutReader $pageLayoutReader,
+        private readonly PageLayoutConfigBuilder $pageLayoutConfigBuilder,
     ) {
     }
 
     public function load(array $handles = [], array $pageHandles = [], bool $isolated = false): LayoutInterface
     {
         if ($isolated) {
+            $handles = $this->layoutHandlerComposite->getHandles($handles);
             $layout = $this->layoutFactory->create();
             $update = $layout->getUpdate();
-            $update->addHandle('default');
 
-            $update->addPageHandles($pageHandles);
+            $this->applyPageHandles($update, $pageHandles);
+
+            $update->addHandle('default');
             foreach ($handles as $handle) {
                 $update->addHandle($this->sanitizeHandle($handle));
             }
 
             $pageConfig = $this->pageConfigFactory->create(); // important: fresh instance
+            $this->applyPageLayout($pageConfig, $pageHandles);
 
             $builder = $this->layoutBuilderFactory->create(
                 BuilderFactory::TYPE_PAGE,
@@ -53,12 +59,16 @@ public function load(array $handles = [], array $pageHandles = [], bool $isolate
 
         $handles = $this->layoutHandlerComposite->getHandles($handles);
         $update = $this->layout->getUpdate();
-        $update->addPageHandles($pageHandles);
 
+        $this->applyPageHandles($update, $pageHandles);
+
+        $update->addHandle('default');
         foreach ($handles as $handle) {
             $update->addHandle($this->sanitizeHandle($handle));
         }
 
+        $this->applyPageLayout($this->pageConfig, $pageHandles);
+
         $builder = $this->layoutBuilderFactory->create(
             BuilderFactory::TYPE_PAGE,
             [
@@ -73,6 +83,38 @@ public function load(array $handles = [], array $pageHandles = [], bool $isolate
         return $this->layout;
     }
 
+    private function applyPageHandles(ProcessorInterface $update, array $pageHandles): void
+    {
+        if (empty($pageHandles)) {
+            return;
+        }
+
+        $update->addPageHandles($pageHandles);
+
+        $pageLayoutsConfig = $this->pageLayoutConfigBuilder->getPageLayoutsConfig();
+        foreach ($pageHandles as $pageHandle) {
+            $sanitized = $this->sanitizeHandle($pageHandle);
+            if ($pageLayoutsConfig->hasPageLayout($sanitized)) {
+                $update->addHandle($sanitized);
+            }
+        }
+    }
+
+    private function applyPageLayout(PageConfig $pageConfig, array $pageHandles): void
+    {
+        if (empty($pageHandles)) {
+            return;
+        }
+
+        $pageLayoutsConfig = $this->pageLayoutConfigBuilder->getPageLayoutsConfig();
+        foreach ($pageHandles as $pageHandle) {
+            $sanitized = $this->sanitizeHandle($pageHandle);
+            if ($pageLayoutsConfig->hasPageLayout($sanitized)) {
+                $pageConfig->setPageLayout($sanitized);
+            }
+        }
+    }
+
     private function sanitizeHandle(string $handle): string
     {
         return preg_replace('/([^a-z0-9\-_]+)/', '', $handle);

Util/Controller/TargetRenderer.php

@@ -7,25 +7,56 @@
 use Magento\Framework\Event\Manager as EventManager;
 use Magento\Framework\View\Element\AbstractBlock;
 use Magento\Framework\View\LayoutInterface;
+use Magento\Framework\View\Model\PageLayout\Config\BuilderInterface as PageLayoutConfigBuilder;
 
 class TargetRenderer
 {
     public function __construct(
         private readonly EventManager $eventManager,
         private readonly IdConvertor $idConvertor,
         private readonly LayoutHandlerComposite $layoutHandlerComposite,
-        private readonly LayoutLoader $layoutLoader
+        private readonly LayoutLoader $layoutLoader,
+        private readonly PageLayoutConfigBuilder $pageLayoutConfigBuilder,
     ) {
     }
 
     public function render(LayoutInterface $originalLayout, array $targetNames, bool $isolated = false): array
     {
-        $handles = $this->layoutHandlerComposite->getHandles($originalLayout->getUpdate()->getHandles());
-        $newLayout = $this->layoutLoader->load($handles, [], $isolated);
+        $originalUpdate = $originalLayout->getUpdate();
+        $originalHandles = $originalUpdate->getHandles();
+        $pageHandles = $this->extractPageHandles($originalUpdate, $originalHandles);
+        $handles = $this->layoutHandlerComposite->getHandles(
+            array_values(array_diff($originalHandles, $pageHandles))
+        );
+        $newLayout = $this->layoutLoader->load($handles, $pageHandles, $isolated);
 
         return $this->renderBlocks($newLayout, $this->getTargetBlockNames($newLayout, $targetNames));
     }
 
+    private function extractPageHandles($update, array $originalHandles): array
+    {
+        $pageHandles = [];
+        if (method_exists($update, 'getPageHandles')) {
+            $pageHandles = (array)$update->getPageHandles();
+        }
+        if (method_exists($update, 'getPageLayout')) {
+            $pageLayout = $update->getPageLayout();
+            if ($pageLayout) {
+                $pageHandles[] = $pageLayout;
+            }
+        }
+
+        // Detect page_layout names that were promoted into the handles list by LayoutLoader
+        $pageLayoutsConfig = $this->pageLayoutConfigBuilder->getPageLayoutsConfig();
+        foreach ($originalHandles as $handle) {
+            if ($pageLayoutsConfig->hasPageLayout($handle)) {
+                $pageHandles[] = $handle;
+            }
+        }
+
+        return array_values(array_unique(array_filter($pageHandles)));
+    }
+
     private function renderBlocks(LayoutInterface $layout, array $blockNames): array
     {
         $blocks = [];