Skip to content
EE Forge eeforge logo

Geolocation Documentation


Drop the geolocation folder into your /system/user/addons/ folder (or wherever you have your add-ons installed).

Navigate to your Extensions in the Control Panel and install it like any other add-on.


You'll need a Mapbox account with access to the Permanent Geocoding API (available by reaching out to Mapbox support).

Mapbox API Key

Enter your Mapbox account API key.

Country Restrictions

Setting a country restrictions will limit geocoding results to those countries selected.  It is recommended to set this to limit results to those that are relevant.


Setting the types returned will determine the level of "specificity" returned in geocoded results.

Enter map center

Set the center of your starting map in the control panel.  By default this is set to the center of the US but you could/should update this to a realistic center point for your usage.  Doing so will decrease the mapping API calls and data usage in the control panel.

Fieldtype Usage

From the control panel Publish tab use the map search and begin typing the address.  Select the correct result from the live drop-down and the components will populate on the side.  The components can be manually edited if you desire.

Template Tags

Template tags can be either tag pairs or single tags. The field name is always used as a prefix to avoid naming collisions.


Any template variable can also be used as a single tag.  If only the field name is used (with no suffix) then the formatted address will be displayed.


Template Variables

The following variables are available for the fieldtype.



Displays the latitude coordinate component.



Displays the longitude coordinate component.



Outputs the fully formatted address component.



Displays the address component.



Displays the place/city component.



Displays the district/county component.



Displays the region/state/province component.



This is the same as region but implemented for ease.



This is the same as region but implemented for ease.



Displays the postal code component.



Displays the country component.