Remove cache_format from the manager system settings UI - #16994
Open
Ibochkarev wants to merge 1 commit into
Open
Remove cache_format from the manager system settings UI#16994Ibochkarev wants to merge 1 commit into
Ibochkarev wants to merge 1 commit into
Conversation
Ibochkarev
added
bug
3 tasks
Changing it in the manager crashes the site because settings are loaded from cache. Keep overrides via config_options; drop the setting on upgrade for existing installs.
Ibochkarev
force-pushed
the
fix/issue-15105-remove-cache-format-ui
branch
from
August 15, 2026 01:50
39950b4 to
82b0ff8
Compare
Mark-H
approved these changes
Aug 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
Changing
cache_formatin System Settings crashes the manager and the site. Settings are loaded from cache, so a new format cannot read files written in the old one. Maintainers agreed to remove the setting from the manager UI and document overrides via$config_optionsinconfig.inc.phpinstead (#15105).This PR drops
cache_formatfrom the install transport (new sites) and removes the row on upgrade for existing installs, same pattern ascache_disabled(#14022). Runtime support throughxPDO::OPT_CACHE_FORMAT/$config_optionsis unchanged.How to test
cache_format.cache_formatrow is gone fromsystem_settingsand from the manager grid.$config_options['cache_format']incore/config/config.inc.php, clear the cache directory, confirm the site still boots.Gate E:
php -l setup/includes/upgrades/common/3.3.0-remove-cache-format.php— exit 0php -l setup/includes/upgrades/mysql/3.3.0-pl.php— exit 0php -l _build/data/transport.core.system_settings.php— exit 0getOption(OPT_CACHE_FORMAT)still resolvedRelated issue(s)/PR(s)
Resolves #15105
Refs #13832 (removed
cache_system_settingsfrom transport only)Refs #14022 (
cache_disabledtransport + upgrade remove)Compatibility notes
Universal for 3.3.0. Sites that relied on editing
cache_formatin the manager must use$config_options['cache_format']inconfig.inc.phpand clear the cache directory when changing the value.Breaking change assessment
No public method signature change. The setting disappears from the manager UI and from the
system_settingstable after upgrade. Config-file overrides keep working. Safe for 3.3.0; not a silent behavior change for sites that never touched the setting (default stayed 0 / PHP).Test coverage
No PHPUnit added. Setup upgrade scripts in this repo are not covered by the unit suite (same as
2.7-remove-cache-disabled.php). Verification was manual Gate E above.Contributors
@sergant210 reported the crash and proposed removing the setting from the UI.
@opengeek confirmed config_options is the supported override path.
@Mark-H authored the earlier
cache_system_settingsremoval (#13832).AI tool use
Cursor drafted the upgrade scripts and PR text. I ran the Gate E checks above before opening this.