Country Redirect

Installation #

To install Country Redirect, follow these steps:

1. Download & unzip the file and place the countryredirect directory into your craft/plugins directory
2. Install plugin in the Craft Control Panel under Settings > Plugins
3. The plugin folder should be named countryredirect for Craft to see it.

Country Redirect works on Craft 2.4.x and higher, and requires PHP 7 or higher

Using the plugin #

Before you start using the plugin, you have to do 3 things:

1. Download a updated country database database from MaxMind through the plugin settings
2. Copy the configuration file countryredirect.php into the Craft config directory, usually craft/config
3. Modify the configuration file to match preferences, and make sure you setup the countryMap setting to match your locales.

Configuration #

<?php
return [
    '*' => [
        /*
         * Enable for all users
         */
        //'enabled'             => true,
        /*
         * Or specifically logged in/anon users
         */
        'enabled'             => [
            'loggedIn'  => true,
            'anonymous' => true,
        ],

        /*
         * Don't redirect bots/crawlers like GoogleBot, Bing etc.
         */
        'ignoreBots'          => true,

        /*
         * Add any special URL segments you want to ignore
         * Eg. 'ignoreSegments' => [
         *     'this/page/only/exists/in/one/locale',
         *     'global-page'
         * ],
         */
        'ignoreSegments'      => [ ],

        /*
         * Cookie name
         */
        'cookieName'          => 'countryRedirect',

        /*
         * The URL parameter that let a user manually select which locale they want to see
         */
        'overrideLocaleParam' => 'selected-locale',

        /*
         * The URL parameter that indicates that a user was redirect
         */
        'redirectedParam' => 'redirected',

        /*
         * Map a countrys two-letter ISO code to a Craft locale, and/or define a catch-all with a * asterix
         * Here is a list of ISO country codes: http://www.nationsonline.org/oneworld/country_code_list.htm
         * Example:
         * 'countryMap'       => [
         *   'FR' => 'fr',
         *   'DK' => 'da',
         *   // You can also send visitors to an arbitrary URL
         *   'DE' => 'http://google.de',
         *   '*' => 'en_us',
         * ]
         *
         * If you within a country have different regional languages, you can map the different languages to locales.
         * Take Switzerland, with German, French, Italian and Romansh, as an example:
         *
         * 'countryMap'       => [
         *   'CH' => [
         *     'fr' => 'fr',
         *     'de' => 'de',
         *   ],
         *   '*' => 'en_us',
         * ]
         *
         * This works by checking the Accept-Language header of the browser.
         *
         */
        'countryMap'          => [ ],

        /*
         * If you want to show a banner that prompts visitors to their matching locale instead of redirecting them,
         * you can define these here.
         *
         * The key here is the Craft locale id, not the country code. The variables {countryName} and {url} will
         * be replaced.
         *
         * 'banners' => [
         *   'en_us' => 'It looks like your visiting from {countryName}. Do you <a href="{url}">want to visited the international site?</a>'
         * ],
         */
        'banners'             => [ ],
    ],
];

For a list of the ISO country codes, check out this overview

Navigation #

<h1>Select country</h1>

{% set titles = {
    'en_us': 'Go to our US site',
    'fr': 'Go to our French site',
    'da': 'Go to our Danish site',
} %}
<nav class="nav">
    {% for locale in craft.countryRedirect.getLinks() %}
        {{locale.getLink({ title: titles[locale.getId()] })}}
    {% endfor %}
</nav>

Visitor information #

Country Redirect has a few helper methods to access visitor information.

To access information:

{% set info = craft.countryRedirect.info() %}
{% if info %}
    <p>Your located in {{ info.name }} ( {{ info.isoCode }})</p>
{% endif %}

To check if a user was redirected:

{% if craft.countryRedirect.redirected() %}
    <p>You were redirected because of your location, which is {{ info ? info.isoCode }} ({{ info ? info.name }})</p>
{% endif %}

To display a message when a visitor overrides their locale:

{% if craft.countryRedirect.overridden() %}
    <p>You have overridden your locale, which is now {{ craft.locale }}</p>
{% endif %}

Banner prompts #

If you want to show a banner that prompts visitors to their matching locale instead of redirecting them, you can define the text for each locale with the banners setting.

You can then access the text like this:

{% set banner = craft.countryRedirect.getBanner() %}
{% if banner %}
    <div class="banner">
        <p>{{ banner.getText() }}</p>
    </div>
{% endif %}

Testing #

You can test it by using a free VPN account from TunnelBear

Database #

Geolocation data is provided by MaxMind. According to them, their databases is 99.8% accurate on a country level.

Accuracy #

Roadmap #

• Make it easier to map locales with a larger amount of country codes
• Port to Craft 3
• Make it possible to test locally
• Add environment checks

Reviews

Frequently asked questions

Releases