Advanced Configuration – Agile Store Locator WordPress Plugin https://agilestorelocator.com #1 Store Locator WordPress Plugin that finds location using the Google Maps Fri, 05 Dec 2025 09:46:07 +0000 en-US hourly 1 https://wordpress.org/?v=6.9.4 Agile Store Locator – Google Tag Manager Integration Guide https://agilestorelocator.com/wiki/agile-store-locator-google-tag-manager-integration-guide/ https://agilestorelocator.com/wiki/agile-store-locator-google-tag-manager-integration-guide/#respond Fri, 11 Jul 2025 14:29:26 +0000 https://agilestorelocator.com/?post_type=docs&p=4052 Read More ]]> Agile Store Locator (ASL) supports integration with Google Tag Manager (GTM) for advanced event tracking of your store locator interactions.

With GTM, you can send key user interactions from your store locator directly to Google Analytics 4 (GA4) or any other connected service—without modifying your core website code.

What This Integration Does

By following this guide, you’ll track the following events in GTM:

  • Search events
  • Store selection (map/marker clicks)
  • Store selection (sidebar/list clicks)
  • Direction clicks
  • Email link clicks (available since v4.11.19)
  • Phone link clicks (available since v4.11.19)

Each event automatically pushes relevant store details into GTM’s dataLayer, so you can analyze user interactions in Google Analytics.

How It Works

Agile Store Locator exposes a JavaScript event hook called asl_event_hook. You can add this function to your site to automatically push event data to GTM’s dataLayer.

When a visitor performs an action—like searching, selecting a store, or clicking email/phone links—your custom asl_event_hook will send structured data to GTM.

You then configure GTM to trigger Google Analytics events based on these pushes.

Step 1 – Add the Google Tag Manager Snippet

First, ensure the GTM container code is installed on your site. Google Tag Manager provides you with code like:

<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXXXXX');</script>
<!-- End Google Tag Manager -->

<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-XXXXXXX"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->

Replace GTM-XXXXXXX with your container ID.

Add this above the closing </head> tag and immediately after the opening <body> tag of your site.

Step 2 – Add the ASL Event Hook Script

Next, add the following JavaScript to your site. You can place it in your theme’s footer, or enqueue it via your CMS or plugin.

This script listens for ASL events and pushes them to dataLayer for GTM:

<script type="text/javascript">
function asl_event_hook(_event) {
  if (!_event || !_event.type) return;

  // 1- SEARCH EVENT
  if (_event.type === 'search') {
    var active_filters = (asl_view.featureFilter.array_ || []).map(function(cat) {
      return cat.name_;
    }).join(',');

    dataLayer.push({
      'event': 'asl_search_event',
      'search_type': 'Address',
      'search_filters': active_filters,
      'address_searched': _event.data.search_text
    });
  }

  // 2- SELECT EVENT (Store list / marker click)
  else if (_event.type === 'select') {
    var store = _event.data || {};
    var category_names = (store.categories || []).map(function(cat) {
      return cat.name;
    }).join(',');

    dataLayer.push({
      'event': 'asl_store_selected',
      'store_id': store.id,
      'store_title': store.title,
      'store_street': store.street,
      'store_city': store.city,
      'store_state': store.state,
      'store_postal_code': store.postal_code,
      'store_country': store.country,
      'store_lat': store.lat,
      'store_lng': store.lng,
      'store_phone': store.phone,
      'store_email': store.email,
      'store_website': store.website,
      'store_categories': category_names,
      'store_link': store.link
    });
  }

  // 3- LIST CLICK SELECT EVENT
  else if (_event.type === 'asl_store_select_click') {
    var store = _event.data || {};
    var category_names = (store.categories || []).map(function(cat) {
      return cat.name;
    }).join(',');

    dataLayer.push({
      'event': 'asl_store_select_click',
      'store_id': store.id,
      'store_title': store.title,
      'store_city': store.city,
      'store_state': store.state,
      'store_country': store.country,
      'store_phone': store.phone,
      'store_email': store.email,
      'store_categories': category_names
    });
  }

  // 4- EMAIL CLICK EVENT (available since v4.11.19)
  else if (_event.type === 'asl_email_click') {
    var store = _event.data || {};

    dataLayer.push({
      'event': 'asl_email_click',
      'store_id': store.id,
      'store_title': store.title,
      'store_email': store.email
    });
  }

  // 5- PHONE CLICK EVENT (available since v4.11.19)
  else if (_event.type === 'asl_phone_click') {
    var store = _event.data || {};

    dataLayer.push({
      'event': 'asl_phone_click',
      'store_id': store.id,
      'store_title': store.title,
      'store_phone': store.phone
    });
  }

  // 6- DIRECTION CLICK EVENT
  else if (_event.type === 'direction') {
    var store = _event.data || {};

    dataLayer.push({
      'event': 'asl_direction_click',
      'store_id': store.id,
      'store_title': store.title,
      'store_street': store.street,
      'store_city': store.city,
      'store_state': store.state,
      'store_postal_code': store.postal_code,
      'store_country': store.country,
      'store_lat': store.lat,
      'store_lng': store.lng
    });
  }
}
</script>

Step 3 – Set Up Google Tag Manager

Once the asl_event_hook is on your site, Google Tag Manager will receive events in its dataLayer.

You can now configure GTM to send these events to Google Analytics 4.

3.1 – Create Data Layer Variables

In GTM:

  1. Go to Variables
  2. Click New > Data Layer Variable
  3. Create variables for:
  • store_id
  • store_title
  • store_street
  • store_city
  • store_state
  • store_postal_code
  • store_country
  • store_lat
  • store_lng
  • store_phone
  • store_email
  • store_website
  • store_categories
  • store_link
  • search_type
  • search_filters
  • address_searched

These variables let GTM pull data from the dataLayer pushes.

3.2 – Create Custom Event Triggers

Next, create a Custom Event Trigger for each ASL event type:

Event Names to use:

  • asl_search_event
  • asl_store_selected
  • asl_store_select_click
  • asl_email_click (available since v4.11.19)
  • asl_phone_click (available since v4.11.19)
  • asl_direction_click
  1. Go to Triggers
  2. Click New > Trigger Type: Custom Event
  3. Enter the Event Name (e.g. asl_search_event)

Repeat for each event.

3.3 – Create GA4 Event Tags

For each trigger:

  1. Go to Tags
  2. Click New > Tag Type: Google Analytics: GA4 Event
  3. Select your GA4 Configuration Tag
  4. Enter an Event Name (e.g. locator_search, store_selected, etc.)
  5. Add Event Parameters from your Data Layer Variables

Example for asl_email_click:

  • Event Name: store_email_click
  • Parameters:
    • store_id
    • store_title
    • store_email

Example for asl_search_event:

  • Event Name: locator_search
  • Parameters:
    • search_type
    • search_filters
    • address_searched

Link the appropriate Custom Event Trigger to each Tag.

3.4 – Publish Your Container

  1. Click Submit in GTM
  2. Add a Version Name (e.g. “ASL Events Integration”)
  3. Click Publish

Your site is now tracking ASL events via GTM!

Important Disclaimer

Agile Store Locator’s Google Tag Manager integration only pushes event data into the website’s dataLayer.

We do not configure, debug, or manage your Google Tag Manager container, triggers, or Google Analytics setup.

If your GTM or Google Analytics environment does not receive or record these events as expected, it is your responsibility to:

  1. Ensure your GTM container is correctly installed on your website
  2. Verify that your triggers, variables, and tags are properly configured
  3. Debug GTM using built-in tools like the Preview mode

Agile Store Locator support does not include customizing or troubleshooting Google Tag Manager or Google Analytics implementations.

Our plugin guarantees only that it will send the event data to the dataLayer in a standard format.

]]> https://agilestorelocator.com/wiki/agile-store-locator-google-tag-manager-integration-guide/feed/ 0 Third-Party SEO Plugin Compatibilities https://agilestorelocator.com/wiki/third-party-seo-plugin-compatibilities/ https://agilestorelocator.com/wiki/third-party-seo-plugin-compatibilities/#respond Fri, 21 Feb 2025 14:50:13 +0000 https://agilestorelocator.com/?post_type=docs&p=3911 Read More ]]> The Agile Store Locator plugin integrates with several popular SEO plugins to ensure compatibility and enhance SEO functionalities. Below is the documentation for the supported SEO plugins and how to disable these compatibilities if needed.

Supported SEO Plugins

  1. Yoast SEO
  2. Rank Math
  3. SEOPress
  4. The SEO Framework

Disabling Compatibilities

If you need to disable the compatibility with any of the supported SEO plugins, you can define specific constants in your wp-config.php file. Here are the constants you can use:

  • Yoast SEO: Define ASL_DISABLE_YOAST to disable compatibility.
  • Rank Math: Define ASL_DISABLE_RANKMATH to disable compatibility.
  • SEOPress: Define ASL_DISABLE_SEOPRESS to disable compatibility.
  • The SEO Framework: Define ASL_DISABLE_SEOFRAMEWORK to disable compatibility.

SEOPress Configuration

For SEOPress compatibility, you need to define ASL_REGISTER_TYPE in your wp-config.php file. This ensures that the custom post type for Agile Store Locator is registered correctly with SEOPress.

define('ASL_REGISTER_TYPE', true);

Summary

The Agile Store Locator plugin ensures compatibility with popular SEO plugins by adding custom hooks and filters. If you need to disable these compatibilities, you can do so by defining the appropriate constants in your wp-config.php file.

]]> https://agilestorelocator.com/wiki/third-party-seo-plugin-compatibilities/feed/ 0 Data WPML https://agilestorelocator.com/wiki/data-wpml/ Thu, 25 Aug 2022 12:02:38 +0000 https://agilestorelocator.com/?p=2740 Read More ]]> Store Locator for WordPress is a fully translatable plugin for either the static content of the locator UI or the data itself that includes your stores, categories and other content such as specialties and brands, the static content such as header title can easily be translated by any WordPress translation plugin like WPML or Loco Translate, as described in this translation guide.

static content locator ui
Static content in red, stores data in green

How to translate static content via the WPML plugin?

All the static keywords can be translated via WPML plugin just like any other text that is done via WPML, please visit the plugins section of that plugin to see the Agile Store Locator in the list.

wpml 1
WPML Plugin List
wpml 2
Translate Static Content via WPML Plugin

How to translate the Stores data?

Store locator stores data is maintained in its own store’s database table, so in order to translate it we have provided a control named Data WPML, that can be enabled through the ASL Settings > General tab.

data wpml
Data WPML Feature

After enabling it, you will be able to feed the store data into multiple languages that are enabled on the site, for detail please read the section “How to Display the Store Data in Multiple Languages“.

The dropdown language selector is just showing one language

In case your language dropdown in the manage stores is showing up only one language and you need to add more of it, please go to your WordPress admin panel, select “Settings”, then “General”, and check your “Site Language”, and add the new language, once the setting is saved, the new language will appear on the dropdown.

Data Translation
]]> JSON Cache https://agilestorelocator.com/wiki/json-cache/ Wed, 24 May 2023 13:49:47 +0000 https://agilestorelocator.com/?p=3030 The JSON Cache feature in the store locator plugin offers improved performance by preserving JSON data and serving them instead of making repeated server requests.

json cache feature

Key Points:

  • Preserves JSON data in advance, eliminating the need for frequent requests to admin-ajax.php and database queries.
  • Supports serving JSON files for each active language, ensuring accurate and localized results on multilingual websites.
  • Enhances loading speed by retrieving data from pre-saved JSON files, resulting in a faster and more responsive store locator experience.
  • Reduces server load for high-traffic sites by avoiding repeated server calls and database hits.
  • Provides the ability to restrict access to the wp-admin.php section, as the JSON files are saved in the wp-uploads directory.

When JSON cache is disabled, please refer to the guide article if your stores are still not visible, in order to resolve the issue.

]]> Configuring the WordPress Schedule for Automatic Stores CSV Import https://agilestorelocator.com/wiki/how-to-configure-the-cronjob/ Tue, 13 Jul 2021 11:38:20 +0000 https://agilestorelocator.com/?p=1813 Our plugin offers a scheduling feature that allows you to automatically import store locations from CSV files. To utilize this feature, you simply need to place your CSV files in the designated directory. The plugin will then process the files based on their timestamps, importing any files that are newer than the previously imported ones.

The directory where you should place your CSV files for automatic import is:

/wp-content/uploads/agile-store-locator/cron

By leveraging this functionality, you can easily keep your store locator updated with the latest store location data without manual intervention. Simply upload your CSV files to the specified directory, and the plugin will take care of the rest, ensuring that your store locations are regularly synchronized with the provided CSV files.

Notifications

Once this step is completed, your cron job setup is complete. Furthermore, whenever a CSV is processed it will send you an email for the import rows and the file count, for this reason, please make sure to add an email address in the admin “Notification” field and enable the checkbox “Notification” in the ASL Settings.

Troubleshooting Guide for WP Scheduling and CSV Import

To troubleshoot issues related to CSV file imports using WordPress scheduling in the Agile Store Locator plugin. Below are common scenarios and steps to address them.

1. Outdated File Uploaded:

  • Issue: The CSV file may not be imported if it’s outdated, as the cron job processes only newly uploaded files.
  • Resolution Steps:
    • Ensure that you are uploading a recently updated CSV file to the designated directory.
    • Check the modification date of the CSV file to confirm if it meets the criteria for processing by the cron job.

2. Incorrect CSV Format:

  • Issue: CSV files with incorrect formats may not be imported successfully.
  • Resolution Steps:
    • Verify that the CSV file format matches the demo file provided within the plugin.
    • Check for any discrepancies in column headers, data types, or delimiters that might cause import failures.
    • Validate the CSV file using a spreadsheet application or a CSV validation tool to ensure it meets the required format.

3. Cron Job Verification:

  • Issue: The cron job may not be executing as expected.
  • Resolution Steps:
    • Install a Cron Manager plugin to inspect the list of scheduled cron jobs.
    • Check if the ‘asl_import_cron’ job is listed and active.
import cron
  • Verify the scheduling frequency and parameters associated with the cron job to ensure it’s configured correctly.

4. Manual Execution Test:

  • Issue: Uncertainty about whether the import process is functioning properly.
  • Resolution Steps:
    • Add a new CSV file to the designated directory: /wp-content/uploads/agile-store-locator/cron.
    • Use the Cron manager plugin to manually execute the ‘asl_import_cron’ job.
    • Monitor the import process closely to determine if the new file is imported successfully.
    • Analyze any error messages or notifications generated during the manual execution for insights into potential issues.
execute import cron

API Based Solution

Agile Store Locator has a separate addon that can keep your store’s data synchronized with any kind of REST API, for more details on it visit the page about Agile Sync Data Addon.

]]> Permissions https://agilestorelocator.com/wiki/permissions/ Sun, 16 May 2021 10:12:54 +0000 https://agilestorelocator.com/?p=1804 The Store Locator permissions work based on the permission levels of WordPress. Furthermore, This can be found on the WordPress permission page.

Please add the following line in the wp-config.php page to change the permission of the Store Locator plugin:

 define('ASL_PERMISSION', 'edit_pages');

The list of possible permission values can be found at the following link.

Please make sure to add the line before the last line, so it will be like this.

edit store locator permission
]]> Notifications https://agilestorelocator.com/wiki/notifications/ Tue, 20 Sep 2022 11:20:48 +0000 https://agilestorelocator.com/?p=2767 Read More ]]> Store Locator for WordPress sends notifications via email on multiple occasions to users and the provided admin email in the Register & Leads tab, first of all, to enable any kind of notification, add your email and turn on the notification switch.

notification
Enable the notification ASL Settings

the list of events, that generates the email is as follows:

  • When a store is registered, an email is sent to the admin email that is provided under the notification email.
  • An email is sent to the user when his pending registered store is approved by the administrator.
  • Multi-Store Addons for WooCommerce events for the nearly out of stock and other events
]]> Store Schedule https://agilestorelocator.com/wiki/store-schedule/ Wed, 21 Jun 2023 12:26:11 +0000 https://agilestorelocator.com/?p=3111 Read More ]]> The Store Locator plugin offers a powerful scheduling feature that allows you to set opening dates and times for your stores. This documentation will guide you through the process of enabling the Store Schedule option in the plugin’s settings.

Step 1: Enabling Store Schedule

  1. In the ASL Settings, go to the “General” tab.
  2. Scroll down to find the “Store Schedule” option.
  3. Toggle the switch to enable the Store Schedule feature.
store schedule

Step 2: Managing Store Schedules

  1. Go to the “Manage Stores” page in the Store Locator plugin.
  2. In the store listing, you will see a schedule icon for each store.
  3. Click on the schedule icon of a store you want to schedule.
  4. A popup will appear where you can enter the start and end dates for the store’s schedule.
  5. Optionally, you can filter the store listing based on the schedule status:
    • All: Shows all stores, regardless of their schedule status.
    • Scheduled: Shows stores with a defined schedule.
    • Running: Shows stores that are currently within their scheduled dates.
    • Expired: Shows stores whose schedule has already ended.
schedule popup
scheduled store

Thank you for using our Store Locator plugin and enabling the Store Schedule feature. If you have any further questions or need assistance, please don’t hesitate to contact our support team.

]]> Store Page Slug with Pretty URL https://agilestorelocator.com/wiki/slug-with-pretty-url/ Wed, 14 Jul 2021 13:25:15 +0000 https://agilestorelocator.com/?p=1821 Since version 4.9+, Agile Store Locator supports field parameters that can be used to create the store detail slug, and that not only support the default field of the store locator but also the custom fields that you create through the custom field manager, to change these parameters, follow the instructions below.

slug fields
ASL Settings > Store Page tab
  • Go to the ASL Settings > Detail Page tab
  • Set the fields in the Store Slug Fields dropdown that you want to use for the store detail slug.
  • Click on the Save Settings.

So, once you have done those steps above, your newly created store will have the slug based on those fields, please note that those stores that are created before you have changed these settings the slug will not apply to them, but you have the option to reimport your existing data by following this guide tutorial that wouldn’t take more than a couple of minutes to import it.

]]>