Skip to content

Improve admin theme handling #4756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hanmac wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Improve admin theme handling #4756

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d9302bf
Fix #1216 and the fallback theme
Hanmac Apr 17, 2025
f04e4a9
~ copilot hints
Hanmac Jan 19, 2026
d44a098
Clean cache on update
theroch Jan 20, 2026
07676e4
Update app/code/core/Mage/Core/Model/Layout/Update.php
theroch Jan 20, 2026
ab771a2
Update app/code/core/Mage/Core/Model/Design/Fallback.php
theroch Jan 20, 2026
d80e0fd
~ cs-fixer
Hanmac Jan 20, 2026
85a2172
Rector fix - Clean up docblock in addFallbackThemesLayoutUpdates
addison74 Jan 20, 2026
5e483d0
Merge branch 'main' into designLayoutUpdates
addison74 Jan 20, 2026
f76ec86
Apply suggestion from @Copilot
Hanmac Jan 20, 2026
2b20856
~rector
Hanmac Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
54 changes: 27 additions & 27 deletions .phpstan.dist.baseline.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7684,163 +7684,163 @@ parameters:
rawMessage: 'Call to an undefined method Mage_Core_Block_Abstract::_getUsers().'
identifier: method.notFound
count: 1
path: app/design/adminhtml/default/default/template/api/role_users_grid_js.phtml
path: app/design/adminhtml/base/default/template/api/role_users_grid_js.phtml

-
rawMessage: 'Call to an undefined method Mage_Core_Block_Abstract::_getSelectedRoles().'
identifier: method.notFound
count: 1
path: app/design/adminhtml/default/default/template/api/user_roles_grid_js.phtml
path: app/design/adminhtml/base/default/template/api/user_roles_grid_js.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 2
path: app/design/adminhtml/default/default/template/catalog/product/edit/price/group.phtml
path: app/design/adminhtml/base/default/template/catalog/product/edit/price/group.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 2
path: app/design/adminhtml/default/default/template/catalog/product/edit/price/tier.phtml
path: app/design/adminhtml/base/default/template/catalog/product/edit/price/tier.phtml

-
rawMessage: 'Parameter #2 $store of method Mage_Core_Helper_Data::currencyByStore() expects int|Mage_Core_Model_Store|null, true given.'
identifier: argument.type
count: 1
path: app/design/adminhtml/default/default/template/catalog/product/price.phtml
path: app/design/adminhtml/base/default/template/catalog/product/price.phtml

-
rawMessage: 'Call to an undefined method Mage_GiftMessage_Block_Message_Helper::prepareAsIs().'
identifier: method.notFound
count: 2
path: app/design/adminhtml/default/default/template/giftmessage/helper.phtml
path: app/design/adminhtml/base/default/template/giftmessage/helper.phtml

-
rawMessage: 'Parameter #1 $value of method Mage_GiftMessage_Block_Message_Helper::setScriptIncluded() expects string, true given.'
identifier: argument.type
count: 1
path: app/design/adminhtml/default/default/template/giftmessage/helper.phtml
path: app/design/adminhtml/base/default/template/giftmessage/helper.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 2
path: app/design/adminhtml/default/default/template/notification/toolbar.phtml
path: app/design/adminhtml/base/default/template/notification/toolbar.phtml

-
rawMessage: PHPDoc tag @var with type Mage_Core_Block_Template is not subtype of type Mage_Oauth_Block_Authorize.
identifier: varTag.type
count: 1
path: app/design/adminhtml/default/default/template/oauth/authorize/reject.phtml
path: app/design/adminhtml/base/default/template/oauth/authorize/reject.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/page/header.phtml
path: app/design/adminhtml/base/default/template/page/header.phtml

-
rawMessage: 'Call to an undefined method Mage_Core_Block_Abstract::_getUsers().'
identifier: method.notFound
count: 1
path: app/design/adminhtml/default/default/template/permissions/role_users_grid_js.phtml
path: app/design/adminhtml/base/default/template/permissions/role_users_grid_js.phtml

-
rawMessage: 'Call to an undefined method Mage_Core_Block_Abstract::_getSelectedRoles().'
identifier: method.notFound
count: 1
path: app/design/adminhtml/default/default/template/permissions/user_roles_grid_js.phtml
path: app/design/adminhtml/base/default/template/permissions/user_roles_grid_js.phtml

-
rawMessage: 'Comparison operation ">" between int<1, max> and 0 is always true.'
identifier: greater.alwaysTrue
count: 1
path: app/design/adminhtml/default/default/template/report/grid.phtml
path: app/design/adminhtml/base/default/template/report/grid.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/sales/order/create/items/grid.phtml
path: app/design/adminhtml/base/default/template/sales/order/create/items/grid.phtml

-
rawMessage: 'Method Mage_Adminhtml_Block_Sales_Order_Create_Abstract::formatPrice() invoked with 3 parameters, 1 required.'
identifier: arguments.count
count: 18
path: app/design/adminhtml/default/default/template/sales/order/create/items/grid.phtml
path: app/design/adminhtml/base/default/template/sales/order/create/items/grid.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/sales/order/shipment/packaging/popup.phtml
path: app/design/adminhtml/base/default/template/sales/order/shipment/packaging/popup.phtml

-
rawMessage: Negated boolean expression is always true.
identifier: booleanNot.alwaysTrue
count: 2
path: app/design/adminhtml/default/default/template/system/store/tree.phtml
path: app/design/adminhtml/base/default/template/system/store/tree.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/tax/notifications.phtml
path: app/design/adminhtml/base/default/template/tax/notifications.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/weee/renderer/tax.phtml
path: app/design/adminhtml/base/default/template/weee/renderer/tax.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 2
path: app/design/adminhtml/default/default/template/widget/breadcrumbs.phtml
path: app/design/adminhtml/base/default/template/widget/breadcrumbs.phtml

-
rawMessage: 'Method Mage_Adminhtml_Block_Widget_Grid::getEmptyCellColspan() invoked with 1 parameter, 0 required.'
identifier: arguments.count
count: 1
path: app/design/adminhtml/default/default/template/widget/grid.phtml
path: app/design/adminhtml/base/default/template/widget/grid.phtml

-
rawMessage: 'Method Mage_Adminhtml_Block_Widget_Grid::getMultipleRowColumns() invoked with 1 parameter, 0 required.'
identifier: arguments.count
count: 1
path: app/design/adminhtml/default/default/template/widget/grid.phtml
path: app/design/adminhtml/base/default/template/widget/grid.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/widget/grid/serializer.phtml
path: app/design/adminhtml/base/default/template/widget/grid/serializer.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/widget/tabs.phtml
path: app/design/adminhtml/base/default/template/widget/tabs.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/widget/tabshoriz.phtml
path: app/design/adminhtml/base/default/template/widget/tabshoriz.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/default/template/widget/tabsleft.phtml
path: app/design/adminhtml/base/default/template/widget/tabsleft.phtml

-
rawMessage: 'Construct empty() is not allowed. Use more strict comparison.'
identifier: empty.notAllowed
count: 1
path: app/design/adminhtml/default/openmage/template/page/header.phtml
path: app/design/adminhtml/openmage/default/template/page/header.phtml

-
rawMessage: 'Method Mage_Catalog_Block_Product_Abstract::getTierPrices() invoked with 2 parameters, 0-1 required.'
Expand Down
54 changes: 27 additions & 27 deletions .phpstan.dist.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,33 +76,33 @@ parameters:
# @todo add classes to widgets
message: '#^Variable \$this might not be defined\.$#'
paths:
- app/design/adminhtml/default/default/template/api/usernroles.phtml
- app/design/adminhtml/default/default/template/dashboard/searches.phtml
- app/design/adminhtml/default/default/template/dashboard/store/switcher.phtml
- app/design/adminhtml/default/default/template/empty.phtml
- app/design/adminhtml/default/default/template/overlay_popup.phtml
- app/design/adminhtml/default/default/template/popup.phtml
- app/design/adminhtml/default/default/template/promo/form.phtml
- app/design/adminhtml/default/default/template/rating/stars/detailed.phtml
- app/design/adminhtml/default/default/template/review/add.phtml
- app/design/adminhtml/default/default/template/sales/billing/agreement/form.phtml
- app/design/adminhtml/default/default/template/sales/items/renderer/default.phtml
- app/design/adminhtml/default/default/template/sales/order/shipment/create/items/renderer/configurable.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/discount.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/due.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/footer.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/grand.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/item.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/main.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/paid.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/refunded.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/shipping.phtml
- app/design/adminhtml/default/default/template/sales/order/totals/subtotal.phtml
- app/design/adminhtml/default/default/template/sales/order/view/tracking.phtml
- app/design/adminhtml/default/default/template/system/info.phtml
- app/design/adminhtml/default/default/template/tax/class/page/edit.phtml
- app/design/adminhtml/default/default/template/tax/toolbar/class/save.phtml
- app/design/adminhtml/default/default/template/tax/toolbar/rule/save.phtml
- app/design/adminhtml/base/default/template/api/usernroles.phtml
- app/design/adminhtml/base/default/template/dashboard/searches.phtml
- app/design/adminhtml/base/default/template/dashboard/store/switcher.phtml
- app/design/adminhtml/base/default/template/empty.phtml
- app/design/adminhtml/base/default/template/overlay_popup.phtml
- app/design/adminhtml/base/default/template/popup.phtml
- app/design/adminhtml/base/default/template/promo/form.phtml
- app/design/adminhtml/base/default/template/rating/stars/detailed.phtml
- app/design/adminhtml/base/default/template/review/add.phtml
- app/design/adminhtml/base/default/template/sales/billing/agreement/form.phtml
- app/design/adminhtml/base/default/template/sales/items/renderer/default.phtml
- app/design/adminhtml/base/default/template/sales/order/shipment/create/items/renderer/configurable.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/discount.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/due.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/footer.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/grand.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/item.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/main.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/paid.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/refunded.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/shipping.phtml
- app/design/adminhtml/base/default/template/sales/order/totals/subtotal.phtml
- app/design/adminhtml/base/default/template/sales/order/view/tracking.phtml
- app/design/adminhtml/base/default/template/system/info.phtml
- app/design/adminhtml/base/default/template/tax/class/page/edit.phtml
- app/design/adminhtml/base/default/template/tax/toolbar/class/save.phtml
- app/design/adminhtml/base/default/template/tax/toolbar/rule/save.phtml
-
# tmp strict rule
identifier: empty.notAllowed
Expand Down
8 changes: 4 additions & 4 deletions app/code/core/Mage/Adminhtml/Controller/Action.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,15 @@ public function preDispatch()
{
// get legacy theme choice form backend config
if (Mage::getStoreConfigFlag('admin/design/use_legacy_theme')) {
$theme = Mage::getConfig()->getNode('stores/admin/design/theme/default');
$package = Mage::getConfig()->getNode('stores/admin/design/package/name');
} else {
$theme = Mage::getConfig()->getNode('stores/admin/design/theme/openmage');
$package = Mage::getConfig()->getNode('stores/admin/design/package/openmage');
}

Mage::getDesign()
->setArea($this->_currentArea)
->setPackageName((string) Mage::getConfig()->getNode('stores/admin/design/package/name'))
->setTheme((string) $theme);
->setPackageName((string) $package)
->setTheme((string) Mage::getConfig()->getNode('stores/admin/design/theme/default'));
foreach (['layout', 'template', 'skin', 'locale'] as $type) {
if ($value = (string) Mage::getConfig()->getNode("stores/admin/design/theme/{$type}")) {
Mage::getDesign()->setTheme($type, $value);
Expand Down
2 changes: 1 addition & 1 deletion app/code/core/Mage/Adminhtml/etc/config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,10 @@
<design>
<package>
<name>default</name>
<openmage>openmage</openmage>
</package>
<theme>
<default>default</default>
<openmage>openmage</openmage>
</theme>
</design>
</admin>
Expand Down
23 changes: 23 additions & 0 deletions app/code/core/Mage/Core/Model/Design/Fallback.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,35 @@ public function getFallbackScheme($area, $package, $theme)
$cacheKey = $area . '/' . $package . '/' . $theme;

if (!isset($this->_cachedSchemes[$cacheKey])) {

// First, we have to check if theme exists
$path = $area . DS . $package . DS . $theme;
$fallback = !is_dir(Mage::getBaseDir('design') . DS . $path);
if ($fallback) {
// Fallback to default theme.
$theme = (string) Mage::getConfig()->getNode('stores/admin/design/theme/default');
}

if ($this->_isInheritanceDefined($area, $package, $theme)) {
$scheme = $this->_getFallbackScheme($area, $package, $theme);
} else {
$scheme = $this->_getLegacyFallbackScheme();
}

if ($fallback) {
/**
* When the originally requested theme does not exist, we build the inheritance
* chain for the configured fallback theme instead. The first element of
* $scheme represents the empty top element.
* We keep that element at the beginning and explicitly insert the effective
* theme as the second element, so that its files are checked immediately
* after the current (parent) but before any further fallbacks. This preserves a
* predictable and explicit order in the fallback chain.
*/
$first = array_shift($scheme);
$scheme = array_merge([$first], [['_package' => $package, '_theme' => $theme]], $scheme);
}

$this->_cachedSchemes[$cacheKey] = $scheme;
}

Expand Down
46 changes: 46 additions & 0 deletions app/code/core/Mage/Core/Model/Layout/Update.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ public function getFileLayoutUpdatesXml($area, $package, $theme, $storeId = null
$layoutXml = null;
$elementClass = $this->getElementClass();
$updatesRoot = Mage::app()->getConfig()->getNode($area . '/layout/updates');
$updatesRoot = $this->addFallbackThemesLayoutUpdates($updatesRoot);
Mage::dispatchEvent('core_layout_update_updates_get_after', ['updates' => $updatesRoot]);
$updates = $updatesRoot->asArray();
$themeUpdates = Mage::getSingleton('core/design_config')->getNode("$area/$package/$theme/layout/updates");
Expand Down Expand Up @@ -483,4 +484,49 @@ public function getFileLayoutUpdatesXml($area, $package, $theme, $storeId = null

return simplexml_load_string('<layouts>' . $layoutStr . '</layouts>', $elementClass);
}

/**
* Add layout files added via theme.xml to layout updates
* for all themes that are parents of this theme.
*
* @param Mage_Core_Model_Config_Element $updates
* @return Mage_Core_Model_Config_Element
*/
public function addFallbackThemesLayoutUpdates(Mage_Core_Model_Config_Element $updates): Mage_Core_Model_Config_Element
{
/* @var Mage_Core_Model_Design_Package $designPackage */
$designPackage = Mage::getSingleton('core/design_package');
/* @var Mage_Core_Model_Design_Fallback $fallbackModel */
$fallbackModel = Mage::getModel('core/design_fallback');

$fallbacks = array_reverse($fallbackModel->getFallbackScheme(
$designPackage->getArea(),
$designPackage->getPackageName(),
$designPackage->getTheme('layout'),
));

foreach ($fallbacks as $fallback) {
if (!isset($fallback['_package'], $fallback['_theme'])) {
continue;
}

$fallbackPackage = $fallback['_package'];
$fallbackTheme = $fallback['_theme'];

$themeUpdateGroups = Mage::getSingleton('core/design_config')->getNode("{$designPackage->getArea()}/$fallbackPackage/$fallbackTheme/layout/updates");

if (!$themeUpdateGroups) {
continue;
}

foreach ($themeUpdateGroups as $themeUpdateGroup) {
foreach ($themeUpdateGroup->asArray() as $key => $themeUpdate) {
$updateNode = $updates->addChild($key);
$updateNode->addChild('file', $themeUpdate['file']);
}
}
}

return $updates;
}
}
16 changes: 16 additions & 0 deletions app/code/core/Mage/Core/data/core_setup/data-upgrade-1.6.0.11-1.6.0.12.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

/**
* @copyright For copyright and license information, read the COPYING.txt file.
* @link /COPYING.txt
* @license Open Software License (OSL 3.0)
* @package Mage_Core
*/

/** @var Mage_Core_Model_Resource_Setup $this */
$installer = $this;
$installer->startSetup();

Mage::app()->getCacheInstance()->flush();

$installer->endSetup();
Loading
Loading