Documentation

The steps to install the Cardinal Store Locator plugin are the same as installing any WordPress plugin with the addition of entering your license key in the plugin settings for it to become functional. Follow the steps below and use the left-hand menu to navigate through the documentation sections.

SFTP or FTP

  1. Download the plugin
  2. Unzip the plugin on your computer
  3. Upload the extracted “cardinal-storelocator” directory to /wp-content/plugins/
  4. Login to your WordPress installation admin and activate the plugin under the “Plugins” menu in the dashboard
  5. Visit the plugin settings page by clicking on the “Settings” link in the plugins list or by clicking Settings > Cardinal Locator in the left column of the WordPress dashboard and enter your license key
  6. Create a new Google Maps API key:
    1. Visit the Google Maps Platform site and click the Get Started Button
    2. In the modal that appears, check all of the items: Maps, Routes, and Places
    3. Set up required billing information. Note that a valid credit card is now required to be on file but Google still offers a $200 free monthly credit tier. See blog post with more information about billing changes.
    4. In the Cardinal Locator settings enter your API key into the Google Maps API key field under Primary Settings and save the settings.
  7. Create a secondary Geocoding API key for back-end requests (if using the default “Register Locations Post Type” or “Other Custom Post Type” for the Data source setting)
    1. Login to the Google Cloud Console if it’s not already open
    2. Select the appropriate project from the drop-down at the top left
    3. Click on APIs & Services in the left column
    4. Click Credentials in the left column
    5. Click Create Credentials > API key > copy the presented key
    6. Make sure the Geocoding API is enabled for the key (should already be enabled with 6th step)
    7. Paste into the new Geocoding API key field under Primary Settings in the plugin settings and save the settings

 

Upload zip file in WordPress dashboard

Alternatively, you can install the plugin by uploading the plugin zip file in the WordPress dashboard by following these steps:

  1. Download the plugin
  2. Login to your WordPress installation admin and navigate to Plugins > Add New > Upload Plugin
  3. Click the browse button to find the zip file on your computer, then click the “Install Now” button
  4. Activate the plugin under the “Plugins” menu in the dashboard
  5. Visit the plugin settings page by clicking on the “Settings” link in the plugins list or by clicking Settings > Cardinal Locator in the left column of the WordPress dashboard and enter your license key
  6. Create a new Google Maps API key:
    1. Visit the Google Maps Platform site and click the Get Started Button
    2. In the modal that appears, check all of the items: Maps, Routes, and Places
    3. Set up required billing information. Note that a valid credit card is now required to be on file but Google still offers a $200 free monthly credit tier. See blog post with more information about billing changes.
    4. In the Cardinal Locator settings enter your API key into the Google Maps API key field under Primary Settings and save the settings.
  7. Create a secondary Geocoding API key for back-end requests (if using the default “Register Locations Post Type” or “Other Custom Post Type” for the Data source setting)
    1. Login to the Google Cloud Console if it’s not already open
    2. Select the appropriate project from the drop-down at the top left
    3. Click on APIs & Services in the left column
    4. Click Credentials in the left column
    5. Click Create Credentials > API key > copy the presented key
    6. Make sure the Geocoding API is enabled for the key (should already be enabled with 6th step)
    7. Paste into the new Geocoding API key field under Primary Settings in the plugin settings and save the settings