# experius/magento2-configscopehints

> Magento 2 store config override hints module

`composer require experius/magento2-configscopehints`

Canonical URL: https://packagento.com/experius/magento2-configscopehints

## At a glance

- **Vendor**: experius (https://packagento.com/experius.md)
- **Latest version**: 4.1.10 — released 2024-07-17
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/experius/magento2-configscopehints and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require experius/magento2-configscopehints:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 store config override hints module

## README

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.

```bash
## 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.

```bash
$ 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.

```bash
$ 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.

![Screenshot of system config scope hints module](https://ericisaweso.me/images/magento2-configscopehints-v3.1.png)

### 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][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][MAGETWO-62648].

#### 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


[2.1.0]: https://github.com/ericthehacker/magento2-configscopehints/releases/tag/v2.1.0
[MAGETWO-62648]: https://github.com/magento/magento2/issues/7943

## Changelog

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.9)

*  [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)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.8)

*  Add fallback for FieldArray labels *(Experius)*


### 4.1.7 (2021-08-03)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.7)

*  [BUGFIX] Solved issue in combination with Magmodules_Channable *(Mr. Lewis)*


### 4.1.6 (2021-01-25)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.6)

*  fixed error when is empty or no array *(mhaagen)*


### 4.1.5 (2020-10-28)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.5)

*  [FEATURE] Added CopyRight and declare strict *(Lewis Voncken)*


### 4.1.4 (2020-10-21)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.4)

*  [REFACTOR] [BACI-157] Removed setup_version from module.xml *(Lewis Voncken)*


### 4.1.3 (2020-10-15)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.3)

*  [REFACTOR] Removed unused code or added suppression when unused code is allowed and applied phpcs fixes *(Lewis Voncken)*


### 4.1.2 (2020-08-14)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.2)

*  Install from Experius repo *(Sipos András)*


### 4.1.1 (2020-07-28)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.1)

*  [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)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.1.0)

*  [FEATURE] Show the updated_at timestamp of the configuration value *(Lewis Voncken)*


### 4.0.1 (2020-05-27)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.0.1)

*  [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)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/4.0.0)

*  [REFACTOR] Changed composer name for feature development *(Lewis Voncken)*


### v3.1.1 (2017-01-07)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/v3.1.1)

*  Fix #8, undefined index error on pages with non-standard fields renderers *(Eric Wiese)*


### v3.1.0 (2016-12-31)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/v3.1.0)

*  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)

[View Release](git@github.com:experius/magento2-configscopehints.git/commits/tag/v3.0.0)

*  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)

_(Changelog truncated for .md surface. Full history on https://packagento.com/experius/magento2-configscopehints.)_

## Recent Versions

| Version | Released |
|---|---|
| 4.1.10 | 2024-07-17 |
| 4.1.9 | 2023-11-08 |
| 4.1.8 | 2021-12-24 |
| 4.1.7 | 2021-08-03 |
| 4.1.6 | 2021-01-25 |
| 4.1.5 | 2020-10-28 |
| 4.1.4 | 2020-10-21 |
| 4.1.3 | 2020-10-15 |
| 4.1.2 | 2020-08-14 |
| 4.1.1 | 2020-07-28 |

Showing 10 of 19 versions. Full release history on https://packagento.com/experius/magento2-configscopehints.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | * |
| magento/module-config | * |

## Quality

Latest release (4.1.10) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — 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.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 8 | 8 warnings (ruleset: Magento2) — 1 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 2 | 2 | – | – |
| 2.4.8 | – | 2 | 2 | – |
| 2.4.9 | – | – | 2 | 2 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### 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

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["experius/magento2-configscopehints"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

experius is a Magento 2 vendor on Packagento. See https://packagento.com/experius.md for their full catalogue.