Download the PHP package opengento/module-country-store-redirect without Composer
On this page you can find all versions of the php package opengento/module-country-store-redirect. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download opengento/module-country-store-redirect
More information about opengento/module-country-store-redirect
Files in opengento/module-country-store-redirect
Package module-country-store-redirect
Short Description This module will redirect the customers regarding their country of origin, on their first visit session.
License MIT
Homepage https://github.com/opengento/magento2-country-store-redirect
Informations about the package module-country-store-redirect
Country Store Redirect Module for Magento 2
This module will redirect the customers regarding their country of origin, on their first visit session.
- Setup
- Composer installation
- Setup the module
- Features
- Settings
- Documentation
- Support
- Authors
- License
Setup
Magento 2 Open Source or Commerce edition is required.
Composer installation
Run the following composer command:
Setup the module
Run the following magento command:
If you are in production mode, do not forget to recompile and redeploy the static resources.
Varnish Usage
Update the varnish vcl with the following instruction:
Features
First Session Redirect
Redirect the visitor on its first session visit, depending on its country. This feature can be disabled by store view scope, so the first redirect is only enabled on your main domain for example.
This feature can have non desirable behavior, for example for robots crawling your website. That's why you can set a list of user agents to ignore and to not process the redirection in this case. Moreover, a list of controller actions to ignore is also configurable.
Now you can select which visitor's country resolver to use, the available resolvers are:
- Default Session Country (the country already set in session, or the default for the current store view).
- CloudFare GEO-IP Country (use visitor'scountry available in the HTTP header value). CloudFare Country GEO-IP must be enabled, see more.
Any third party developers can add its own country resolver. Please read the developer section for further details.
Country to store mapping
Define the country to store relation. This configuration will allows Magento to redirect the visitor to the correct store view depending of the visitor's country. Multiple countries can be assigned to a single store view.
Settings
The configuration for this module is available in Stores > Configuration > General > Country Redirect
.
Documentation
How to add a country resolver
Create a new final class and implement the following interface: Opengento\CountryStoreRedirect\Model\Country\ResolverInterface
.
The method public function getCountryCode(): string
should returns the visitor's country code of origin. The country
should be compliant to ISO 3166-1 alpha-2 format.
Register the new country resolver in the method factory, Vendor/Module/etc/di.xml
:
If you want the resolver ba available in settings, register it in the resolver list Vendor/Module/etc/di.xml
:
The country resolver is ready to use.
SEO and Performance
We strongly discourage you to use the first visit redirect as it is considered harmful and bad practice. Instead show a
dialog to allow the visitor to select the country of its preference.
This feature is available in our module Opengento_CountryStoreSwitcher opengento/module-country-store-switcher
.
Support
Raise a new request to the issue tracker.
Authors
License
This project is licensed under the MIT License - see the LICENSE details.
That's all folks!
All versions of module-country-store-redirect with dependencies
psr/log Version *
magento/framework Version *
magento/module-config Version *
magento/module-store Version *
opengento/module-country-store Version ^1.0.0