Maintain preview URL params

brandonkelly · brandonkelly · commit 72d1d57e69ed · 2024-08-01T16:41:00.000-07:00
Resolves #15447
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -20,6 +20,7 @@
 - `{% cache %}` tags now cache any asset bundles registered within them.
 - Country field values are now set to `CommerceGuys\Addressing\Country\Country` objects. ([#15463](https://github.com/craftcms/cms/pull/15463))
 - Auto-populated section and category group Template settings are now suffixed with `.twig`.
+- `x-craft-preview`/`x-craft-live-preview` URL query string params are now added to generated URLs for Live Preview requests, so `craft\web\Request::getIsPreview()` continues to return `true` on subsequent pages loaded within the iframe. ([#15447](https://github.com/craftcms/cms/discussions/15447)) 
 
 ### Extensibility
 - Added `craft\config\GeneralConfig::addAlias()`. ([#15346](https://github.com/craftcms/cms/pull/15346))
diff --git a/src/helpers/UrlHelper.php b/src/helpers/UrlHelper.php
@@ -629,13 +629,20 @@ private static function _createUrl(
                 $params['site'] = Cp::requestedSite()->handle;
             }
         } else {
-            // token/siteToken params
+            // token/siteToken/preview params
             if ($addToken && !isset($params[$generalConfig->tokenParam]) && ($token = $request->getToken()) !== null) {
                 $params[$generalConfig->tokenParam] = $token;
             }
             if (!isset($params[$generalConfig->siteToken]) && ($siteToken = $request->getSiteToken()) !== null) {
                 $params[$generalConfig->siteToken] = $siteToken;
             }
+            if (!isset($params['x-craft-preview']) && !isset($params['x-craft-live-preview'])) {
+                if (($previewToken = $request->getQueryParam('x-craft-preview')) !== null) {
+                    $params['x-craft-preview'] = $previewToken;
+                } elseif (($previewToken = $request->getQueryParam('x-craft-live-preview')) !== null) {
+                    $params['x-craft-live-preview'] = $previewToken;
+                }
+            }
         }
 
         if ($showScriptName === null) {

Original file line number	Diff line number	Diff line change
`@@ -629,13 +629,20 @@ private static function _createUrl(`
`629`	`629`	`$params['site'] = Cp::requestedSite()->handle;`
`630`	`630`	`}`
`631`	`631`	`} else {`
`632`		`- // token/siteToken params`
	`632`	`+ // token/siteToken/preview params`
`633`	`633`	`if ($addToken && !isset($params[$generalConfig->tokenParam]) && ($token = $request->getToken()) !== null) {`
`634`	`634`	`$params[$generalConfig->tokenParam] = $token;`
`635`	`635`	`}`
`636`	`636`	`if (!isset($params[$generalConfig->siteToken]) && ($siteToken = $request->getSiteToken()) !== null) {`
`637`	`637`	`$params[$generalConfig->siteToken] = $siteToken;`
`638`	`638`	`}`
	`639`	`+ if (!isset($params['x-craft-preview']) && !isset($params['x-craft-live-preview'])) {`
	`640`	`+ if (($previewToken = $request->getQueryParam('x-craft-preview')) !== null) {`
	`641`	`+ $params['x-craft-preview'] = $previewToken;`
	`642`	`+ } elseif (($previewToken = $request->getQueryParam('x-craft-live-preview')) !== null) {`
	`643`	`+ $params['x-craft-live-preview'] = $previewToken;`
	`644`	`+ }`
	`645`	`+ }`
`639`	`646`	`}`
`640`	`647`
`641`	`648`	`if ($showScriptName === null) {`