https://github.com/opengento/magento2-store-path-url
This module allows to override the store code in url with an other path value.
https://github.com/opengento/magento2-store-path-url
adobe-commerce adobe-commerce-extension adobecommerce baseurl baseurl-domain magento magento-2 magento-extension magento-module magento2 magento2-extension magento2-extension-free magento2-module storefront url
Last synced: 12 days ago
JSON representation
This module allows to override the store code in url with an other path value.
- Host: GitHub
- URL: https://github.com/opengento/magento2-store-path-url
- Owner: opengento
- License: mit
- Created: 2024-03-14T21:18:42.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-11T20:37:28.000Z (24 days ago)
- Last Synced: 2025-04-23T21:03:57.005Z (12 days ago)
- Topics: adobe-commerce, adobe-commerce-extension, adobecommerce, baseurl, baseurl-domain, magento, magento-2, magento-extension, magento-module, magento2, magento2-extension, magento2-extension-free, magento2-module, storefront, url
- Language: PHP
- Homepage:
- Size: 73.2 KB
- Stars: 8
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Store Path Url Module for Magento 2
[](https://packagist.org/packages/opengento/module-store-path-url)
[](./LICENSE)
[](https://packagist.org/packages/opengento/module-store-path-url/stats)
[](https://packagist.org/packages/opengento/module-store-path-url/stats)
This module allows to override the store code in url with another path value.
- [Setup](#setup)
- [Composer installation](#composer-installation)
- [Setup the module](#setup-the-module)
- [Features](#features)
- [Settings](#settings)
- [Documentation](#documentation)
- [Support](#support)
- [Authors](#authors)
- [License](#license)
## Setup
Magento 2 Open Source or Commerce edition is required.
### Composer installation
Run the following composer command:
```
composer require opengento/module-store-path-url
```
### Setup the module
Run the following magento command:
```
bin/magento setup:upgrade
```
**If you are in production mode, do not forget to recompile and redeploy the static resources.**
## Features
The module allows to replace the store code in url with the following options:
- Country Code, e.g: be
- Language Code, e.g: fr
- Locale Code (separated with a hyphen), e.g: fr-be
- Locale Code (separated with an underscore), e.g: fr_be
- Custom (you can setup the path of your choice), e.g: emea
This module also allows you to remove the store path in the url for websites with a single store view. This may be useful for stores with dedicated domains. This setting is automatically enabled if you choose to use the custom mapper. However, if a single store exists for a website, and a path is setup within the mapper, the path is not unset, meaning that the path configured in the mapper is used.
Besides that, this module makes the usage of the MAGE_RUN_TYPE and MAGE_RUN_CODE variables optionals. Magento is going to be able to resolve the correct store based on its base web URL. This setting can be disabled, see "Use Base Url Resolver".
## Settings
The configuration for this module is available in `Stores > Configuration > Web > Url`.
## Documentation
In order to use this module, you must enable the following setting: "Add Store Code to Urls" (`web/url/use_store`).
A new field is added in the configuration: "Store Path Url" and "Custom Path Mapper" if the "custom" value is selected.
The store path config are:
- `web/url/store_path_url`
- `web/url/custom_path_mapper`
- `unset_single_store_path`
- `base_url_resolver`
## Support
Raise a new [request](https://github.com/opengento/magento2-store-path-url/issues) to the issue tracker.
## Authors
- **Opengento Community** - *Lead* - [](https://twitter.com/opengento)
- **Thomas Klein** - *Maintainer* - [](https://github.com/thomas-kl1)
- **Contributors** - *Contributor* - [](https://github.com/opengento/magento2-store-path-url/graphs/contributors)
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details.
***That's all folks!***