experius / magento2-configscopehints
experius/magento2-configscopehints
Magento 2 store config override hints module
EW_ConfigScopeHints
This module shows information in the Store Configuration backend UI when a config field is overridden at more specific scope(s), along with information about these scope(s).
Installation
This module can be installed manually or by using Composer (recommended).
Composer Installation
Each of these commands should be run from the command line at the Magento 2 root.
# add this repository to your composer.json
$ composer config repositories.magento2-configscopehints git https://github.com/experius/magento2-configscopehints.git
# require module
$ composer require experius/magento2-configscopehints
# enable module
$ php -f bin/magento module:enable EW_ConfigScopeHints
$ php -f bin/magento setup:upgrade
Manual Installation
First, download contents of this repo into app/code/EW/ConfigScopeHints using a command similar to the following in the Magento 2 root.
$ mkdir -p app/code/EW # create vendor directory
$ wget https://github.com/experius/magento2-configscopehints/archive/master.zip # download zip of module contents
$ unzip master.zip -d app/code/EW # unzip module into vendor directory
$ mv app/code/EW/magento2-configscopehints-master app/code/EW/ConfigScopeHints # correct directory name
$ rm master.zip # clean up zip file
Finally, enable module by running the following from the command line at the Magento 2 root.
$ php -f bin/magento module:enable EW_ConfigScopeHints
$ php -f bin/magento setup:upgrade
Sit back and enjoy!
Usage
After installing the module, when viewing a system configuration field, an alert icon and message will be shown below the field value if it has been overridden at a more specific scope.
The icon is only shown when the value is overridden at a more specific scope than the current one – that is, if viewing at the default scope, overrides at the website or store view level are shown, but if viewing at the website level, only overrides below the currently selected website are shown.
Along with the alert message, a detailed list of the exact scope(s) that override the value, with links directly to the store config for the current section at those scopes. Clicking an override hint row arrow will expand the row to also show the field's value at that scope.
Compatibility and Technical Notes
As of version 3.0.0 of this module has been tested against Magento 2.1.x. It's likely compatible with 2.0.x as well, but this is untested.
NOTE: For known compatibility with 2.0.x, check out version 2.1.0 of the module.
Known Issues
MAGETWO-62648
When used on Magento 2.1.3, the module can produce a false positive when viewing a website scope. If a given config value has been overridden at this website scope, any children store views which have "Use Website" set for the value will incorrectly show as being overridden.
This is a known core bug.
Non-standard Fieldset Renderers
Store config groups which use non-standard fieldset renderers are currently ignored. Of the native store config fields, the following exhibit this trait.
- Advanced -> Advanced -> Disable Modules Output
- Sales -> Payment Methods
4.1.9 (2023-11-01)
- [BUGFIX][IN23-255] Silencing errors is discouraged; found: @$optionsByValue[$option... AND display of array value's is broken due to faulty logic for human readable labels. (Boris van Katwijk)
4.1.8 (2021-12-24)
- Add fallback for FieldArray labels (Experius)
4.1.7 (2021-08-03)
- [BUGFIX] Solved issue in combination with Magmodules_Channable (Mr. Lewis)
4.1.6 (2021-01-25)
- fixed error when is empty or no array (mhaagen)
4.1.5 (2020-10-28)
- [FEATURE] Added CopyRight and declare strict (Lewis Voncken)
4.1.4 (2020-10-21)
- [REFACTOR] [BACI-157] Removed setup_version from module.xml (Lewis Voncken)
4.1.3 (2020-10-15)
- [REFACTOR] Removed unused code or added suppression when unused code is allowed and applied phpcs fixes (Lewis Voncken)
4.1.2 (2020-08-14)
- Install from Experius repo (Sipos András)
4.1.1 (2020-07-28)
- [BUGFIX] [MSBS-106] Restructure config option value/label mapping (Matthijs Breed)
- Update Data.php (Matthijs Breed)
- Update CHANGELOG.md (Experius)
4.1.0 (2020-05-27)
- [FEATURE] Show the updated_at timestamp of the configuration value (Lewis Voncken)
4.0.1 (2020-05-27)
- [BUGFIX] Solved Missing Configuration because of Illegal string offset 'value' (Mr. Lewis)
- [REFACTOR] Added if statement instead of error suppression (Lewis Voncken)
- [DOCS] Updated the CHANGELOG.md (Lewis Voncken)
4.0.0 (2020-05-14)
- [REFACTOR] Changed composer name for feature development (Lewis Voncken)
v3.1.1 (2017-01-07)
- Fix #8, undefined index error on pages with non-standard fields renderers (Eric Wiese)
v3.1.0 (2016-12-31)
- POC config override hint value display (Eric Wiese)
- POC config override hint value display (Eric Wiese)
- Remove erroneous null value check cruft from M1 port that causes false negatives (Eric Wiese)
- Remove todo, unused parameter, and add variable type hint (Eric Wiese)
- Improve value hint styling (Eric Wiese)
- Improve touch behavior and fix hint text overlap (Eric Wiese)
- Update README with new 3.1 information (Eric Wiese)
- Fix whitespace of span value hints and bump module version to 3.1.0 (Eric Wiese)
v3.0.0 (2016-12-29)
- Move config scope hint to field hint instead of scope label (Eric Wiese)
- WIP config score hint UI implementation (Eric Wiese)
- String translations and legacy code cleanup (Eric Wiese)
- Move config scope hint to comment area (Eric Wiese)
- Update README (Eric Wiese)
- Bump module version and fix missing parent constructor call (Eric Wiese)
v2.1.1 (2016-12-29)
- Update README to include module version number in composer require and sync module version with tag (Eric Wiese)
v2.1.0 (2015-11-16)
- Update README.md (Eric Wiese)
- Update install instructions (Eric Wiese)
- Update README.md (Eric Wiese)
- Update README.md (Eric Wiese)
- Add support for Magento 2.0.0-RC (Erik Hansen)
- Code cleanup (Erik Hansen)
- Fix generation of urls to switch to specific scopes (Erik Hansen)
2.0.0 (2015-04-19)
- Inital commit of EW/ConfigScopeHints module (Eric Wiese)
- Create README.md (Eric Wiese)
- Add screenshot to README.md (Eric Wiese)
- Create LICENSE (Eric Wiese)
- Add composer.json (Eric Wiese)
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 4.1.10 | stable | Fail | Magento 2.4.7-2.4.9 Details | 2024-07-17 08:26:51 |
| 4.1.9 | stable | Not tested | Not yet tested Details | 2023-11-08 15:28:48 |
| 4.1.8 | stable | Not tested | Not yet tested Details | 2021-12-24 14:08:05 |
| 4.1.7 | stable | Not tested | Not yet tested Details | 2021-08-03 05:19:59 |
| 4.1.6 | stable | Not tested | Not yet tested Details | 2021-01-25 14:19:03 |
| 4.1.5 | stable | Not tested | Not yet tested Details | 2020-10-28 14:55:00 |
| 4.1.4 | stable | Not tested | Not yet tested Details | 2020-10-21 20:21:32 |
| 4.1.3 | stable | Not tested | Not yet tested Details | 2020-10-15 21:33:23 |
| 4.1.2 | stable | Not tested | Not yet tested Details | 2020-08-14 08:22:00 |
| 4.1.1 | stable | Not tested | Not yet tested Details | 2020-07-28 09:59:25 |
| 4.1.0 | stable | Not tested | Not yet tested Details | 2020-06-11 09:21:03 |
| 4.0.1 | stable | Not tested | Not yet tested Details | 2020-05-27 09:00:06 |
| 4.0.0 | stable | Not tested | Not yet tested Details | 2020-05-14 13:37:49 |
| 3.1.1 | stable | Not tested | Not yet tested Details | 2017-01-07 14:48:51 |
| 3.1.0 | stable | Not tested | Not yet tested Details | 2016-12-31 17:16:35 |
| 3.0.0 | stable | Not tested | Not yet tested Details | 2016-12-29 14:58:45 |
| 2.1.1 | stable | Not tested | Not yet tested Details | 2016-12-29 14:39:03 |
| 2.1.0 | stable | Not tested | Not yet tested Details | 2015-11-16 23:06:55 |
| 2.0.0 | stable | Not tested | Not yet tested Details | 2015-04-19 16:53:35 |
Requires 2
| Package | Constraint |
|---|---|
| magento/framework | * |
| magento/module-config | * |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from experius
View vendorCollect missing translations in specified folder or the entire Magento 2 Root. Adds database editing and management of translations.
Provide a basic Content Security Policy Allowed List and report blocked resources.
Add labels to address lines and configuration for each address line.
This module makes it possible to upload different filetypes inside the WYSIWYG-editor (Media Gallery). Extra filetypes are Word (doc, docm, docx, odt), Excel (csv, xml, xls, xlsx, ods), PDF (pdf), Compressed Folder (zip, tar)
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.