devot:eeDevoted to ExpressionEngine

Summary

This add-on provides seven EE tags to retrieve geo location data based upon a website visitor’s IP address.

Bot detection

The add-on will filter bots by default which will stop excessive calls to the Geo Location API. Use the detect_bots=“yes|no” parameter to control this along with bot_action=“silent|error” and bot_error_message=“No Bots allowed” parameters to control bot detection behaviour.

Tags

 
1. Country Code
 
2. Continent Code
 
3. IP Lookup
 
4. Is Allowed?
 
5. Specific geo location data
 
6. All geo location data
 
7. Locations near to user’s IP location
 
8. Locations near to latitude and longitude

Examples

Single Tags

{exp:ip_geolocator:country_code default="GB"}

{exp:ip_geolocator:continent_code default="EU"}

{exp:ip_geolocator:get_variable name="region"}

{if "{exp:ip_geolocator:is_allowed allowed='GB|FR' default=''}"}
       Britain and France are Allowed
{/if}

Tag Pairs

{exp:ip_geolocator:ip_lookup ip="216.58.201.4"}
        IP: {ip}
        City: {city}
        Region: {region}
        Region Code: {region_code}
        Region Name: {region_name}
        DMA Code: {dma_code}
        Country Code: {country_code}
        Country Name: {country_name}
        In EU? {in_eu}
        EU VAT Rate: {eu_vat_rate}%
        Continent Code: {continent_code}
        Continent Name: {continent_name}
        Lat: {latitude}
        Lng: {longitude}
        Location Accuracy Radius: {location_accuracy_radius}
        Time Zone: {timezone}
        Currency Code: {currency_code}
        Currency Symbol: {currency_symbol}
        Currency Converter: {currency_converter}
    {/exp:ip_geolocator:ip_lookup}

{exp:ip_geolocator:geo_data}
        IP: {ip}
        City: {city}
        Region: {region}
        Region Code: {region_code}
        Region Name: {region_name}
        DMA Code: {dma_code}
        Country Code: {country_code}
        Country Name: {country_name}
        In EU? {in_eu}
        EU VAT Rate: {eu_vat_rate}%
        Continent Code: {continent_code}
        Continent Name: {continent_name}
        Lat: {latitude}
        Lng: {longitude}
        Location Accuracy Radius: {location_accuracy_radius}
        Time Zone: {timezone}
        Currency Code: {currency_code}
        Currency Symbol: {currency_symbol}
        Currency Converter: {currency_converter}
{/exp:ip_geolocator:geo_data}


{exp:ip_geolocator:near_to_user  limit="5" radius="20"} 
    Place: {place}
    Country Code: {country_code}
    Region: {region}
    Lat: {latitude}
    Lng: {longitude}
    Distance (m): {distance_miles}
    Distance (km): {distance_kilometers}
{/exp:ip_geolocator:near_to_user}


{exp:ip_geolocator:near_to_lat_lng limit="5" radius="20" lat="51.4802600" lng="-0.1993000" error_action="no_results"}
    Place: {place}
    Country Code: {country_code}
    Region: {region}
    Lat: {latitude}
    Lng: {longitude}
    Distance (m): {distance_miles}
    Distance (km): {distance_kilometers}

    {if no_results}
        Could not find any results
    {/if}
{/exp:ip_geolocator:near_to_lat_lng}

A full description of the tags and their usage is available by installing the add-on and visiting it’s CP.

Unzip the installation and copy the contents of the ip_geolocator folder into your system/user/addons folder. You will also find a test template included in the zip archive.

Please note: this add-on should work with any version of EE after v3 however we have only tested it on v5. Please let us know about any issues.