# customgento/module-default-store-code-remover-m2

> Default Store Code Remover for Magento 2 hides the store code in the default store from the URL.

`composer require customgento/module-default-store-code-remover-m2`

Canonical URL: https://packagento.com/customgento/module-default-store-code-remover-m2

## At a glance

- **Vendor**: CustomGento (https://packagento.com/customgento.md)
- **Latest version**: 3.1.0 — released 2026-05-06
- **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/customgento/module-default-store-code-remover-m2 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 customgento/module-default-store-code-remover-m2:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Default Store Code Remover for Magento 2 hides the store code in the default store from the URL.

## README

Default Store Code Remover for Magento 2 hides the store code in the default store from the URL. The module is in effect only when <code>web/url/use_store</code> is enabled and is meant to be used for multistore setups, where the default shop should not contain any store code, whereas all other stores should.

The module also provides an optional, extended configuration to control store code removal **per store view**:

- Configuration path: **Store > Configuration > Genral > Web**
- Setting: **Configure Store Code Removal Per Store** (Yes/No)
    - Default value: **No** (backwards compatible)
        - Uses the original behavior: the store code is removed from the **default store view** URL, while all other store views keep their store code in the URL.
    - If set to **Yes**
        - An additional setting becomes available with a list of **store views**.
        - Only the **selected store views** will have the store code removed from the URL.
        - All **non-selected store views** will keep the store code in the URL.

### Installation

* <code>composer require customgento/module-default-store-code-remover-m2</code>
* <code>bin/magento module:enable CustomGento_DefaultStoreCodeRemover</code>
* <code>bin/magento setup:upgrade</code>
* <code>bin/magento cache:flush</code>
* <code>bin/magento setup:di:compile</code>

### Example
When the store codes in the url are disabled, the URL of the stores looks like this: `https://website.com/`.

When the store codes in the url are enabled, the URL of the stores looks like this: `https://website.com/store_code/`.

When this extension is installed and enabled, and the store codes are enabled to be shown in the url under
Store > Configuration > General > Web >Add Store Code, the module will not show the store code for the default store
but will show it for any other store.

So, for the default store the url will be `https://website.com/` while for all other store, the URL will be : `https://website.com/store_code`

### License
[OSL - Open Software Licence 3.0](https://opensource.org/licenses/osl--3.0.php)

### Copyright
&copy; 2021 - present CustomGento GmbH

## Recent Versions

| Version | Released |
|---|---|
| 3.1.0 | 2026-05-06 |
| 3.0.0 | 2026-04-24 |
| 2.0.0 | 2025-09-09 |
| 1.0.6 | 2025-05-27 |
| 1.0.5 | 2024-06-03 |
| 1.0.4 | 2024-05-26 |
| 1.0.3 | 2024-01-26 |
| 1.0.2 | 2023-06-19 |
| 1.0.1 | 2022-05-04 |
| 1.0.0 | 2020-09-28 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-store | ~101.0 |
| php | ~8.1.0\|\|~8.2.0\|\|~8.3.0\|\|~8.4.0\|\|~8.5.0 |

### Suggest

| Package | Constraint |
|---|---|
| customgento/module-default-store-code-remover-m2-mageworx-compatibility | This module ensures compatibility with MageWorx extensions. |

## Quality

Latest release (3.1.0) 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 | 1 | 1 warning (ruleset: Magento2) — 1 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### 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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | 1 | not tested |


### 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=["customgento/module-default-store-code-remover-m2"],
  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

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