Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A simple Expression Engine plugin to find places near a known zip code.
PHP
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
nearby
.gitignore
README.md

README.md

Nearby is a simple ExpressionEngine plugin that uses the GeoNames.org API to find places near a known zip code.

Installation

Place the nearby plugin folder in your ExpressionEngine installation's third_party folder (system/expressionengine/third_party by default).

Since Nearby makes user of the GeoNames API, a GeoNames user account will be required to use more than the demo mode provided. You can sign up for one at www.geonames.org/login

Once your account is created and activated, you will need to log in to the GeoNames site, click your username in the top right of the page to bring up the user control panel and then click the "Click here to enable" link under the title "Free Web Services" to enable API usage on your account.

Once your account is fully enabled, you can pass your username to the plugin via the "username" parameter or set your username in your config.php file with the code:

$config['nearby_username'] = "YOUR USERNAME";

Note: The free web services account on GeoNames provides for 2,000 requests per hour and a total of 30,000 requests per day. If more is needed, you can sign up for a commercial account at www.geonames.org/commercial-webservices.html

Usage

{exp:nearby}

Parameters:

  • zip (required) - the zipcode you'd like to search on
  • limit - limit the number of results returned
  • radius - distance in miles to search surrounding the desired zipcode
  • username - your GeoNames username

Single Variables:

  • {zip} - zipcode of result
  • {placename} - plain text descriptor of result
  • {latitude} - latitude of result, in decimal
  • {longitude} - longitude of result, in decimal
  • {distance} - the result's distance from the searched zipcode

{/exp:nearby}

Something went wrong with that request. Please try again.