Table of Contents
The Store Locator has a lot of features that can be invoked through the shortcode attribute. Furthermore, the attributes can be used individually or by space separation. For example, to use two shortcodes, we will write as given below.
[ASL_STORELOCATOR gesture_handling="cooperative" zoomcontrol="false" zoom="4"]List of the Attributes for the Filters #
| Attribute | Description | Example |
|---|---|---|
| ddl_search | Add a search field within the filter dropdown such as categories dropdown | [ASL_STORELOCATOR ddl_search="1"] |
| image_filter | Show category icons in the categories dropdown | [ASL_STORELOCATOR image_filter="1"] |
| default-addr | This will load the store locator by performing a search via query parameter. | [ASL_STORELOCATOR default-addr="New York"] |
| search_name_limit | To change the number of items to appear in the database search | [ASL_STORELOCATOR search_name_limit="5"] |
| search_2 | Enables a secondary search on custom fields in addition to the main search. | [ASL_STORELOCATOR search_2="title"] or [ASL_STORELOCATOR search_2="city,state"] |
| search_2_contain | Enables partial matching (contain logic) in the secondary search fields. | [ASL_STORELOCATOR search_2_contain="1"] |
| search_title | Add the titles in the database address search | [ASL_STORELOCATOR search_title="1"] |
| db_search_exclude_cities | Excludes cities from database address search. | [ASL_STORELOCATOR db_search_exclude_cities="1"] |
| db_search_exclude_states | Excludes states from database address search. | [ASL_STORELOCATOR db_search_exclude_states="1"] |
| db_search_exclude_postal | Excludes postal codes from database address search. | [ASL_STORELOCATOR db_search_exclude_postal="1"] |
| additional_search | Associate more than one postal code to the store with database search | [ASL_STORELOCATOR additional_search="1"] |
| distance_slider | Enable or disable the distance control in the store locator | [ASL_STORELOCATOR distance_slider="1"] |
| show_categories | Shows or hides the categories dropdown filter. | [ASL_STORELOCATOR show_categories="0"] |
| time_switch | Enables a control to filter stores based on open hours (time filter). | [ASL_STORELOCATOR time_switch="1"] |
| advance_filter | Enables or disables advanced filtering options for the store locator. | [ASL_STORELOCATOR advance_filter="1"] |
| user_center | Apply search based on the default coordinates | [ASL_STORELOCATOR user_center="1"] |
| filter_address | Enable text-matching on the Google Place API search result | [ASL_STORELOCATOR filter_address="1"] |
| and_filter | Applies AND logic when filtering data instead of OR logic. | [ASL_STORELOCATOR and_filter="1"] |
| filter_ddl | Adds extra dropdown filters (e.g., brand, special categories). | [ASL_STORELOCATOR filter_ddl="brand,special"] |
| store_radius | Uses a custom field to assign different search radius values per store. | [ASL_STORELOCATOR store_radius="1"] |
| address_ddl | Adds dropdown filters for addresses like countries, states, and cities. | [ASL_STORELOCATOR address_ddl="1"] |
| stores_limit | Limits the number of stores displayed on the map/list. | [ASL_STORELOCATOR stores_limit="25"] |
| single_cat_select | Forces category selection to allow only a single category instead of multiple selections. | [ASL_STORELOCATOR single_cat_select="1"] |
| country_restrict | Restricts address search to a specific country using a 2-letter country code (ISO Alpha-2). | [ASL_STORELOCATOR country_restrict="us"] (ISO Alpha-2 code) |
| search_type | Sets the type of search used: 0 = Google address search (default), 1 = search by store names, 2 = database address search. | [ASL_STORELOCATOR search_type="2"] (0 = Google, 1 = store name, 2 = DB address) |
| category | Restricts the store locator to display stores from one or more specific categories by ID. Use comma to separate multiple categories. | [ASL_STORELOCATOR category="2,5,8"] (comma-separated category IDs) |
| fixed_radius | Sets a fixed search radius (in miles or kilometers). Only stores within this radius will appear on the map and list. | [ASL_STORELOCATOR fixed_radius="25"] (distance in km or miles) |
| select_category | Pre-selects a default category by its ID when the store locator loads. Accepts a single category ID. | [ASL_STORELOCATOR select_category="3"] |
| select_brand | Pre-selects a default brand or product by its ID, applying the respective filter when the store locator loads. | [ASL_STORELOCATOR select_brand="4"] |
| select_special | Filters stores to show only those marked with a specific special attribute by its ID. | [ASL_STORELOCATOR select_special="1"] |
| stores | Displays only specific stores by their IDs. Provide a comma-separated list of store IDs to limit results. | [ASL_STORELOCATOR stores="12,15,19"] (comma-separated store IDs) |
| state_restrict | Restricts the search to only states where stores exist, so if a city name appears in multiple states, only those states with stores will show results. | [ASL_STORELOCATOR state_restrict="1"] |
| state | Filters stores by state using the state’s code or exact name | [ASL_STORELOCATOR state="NY"] |
| city | Filters stores by city name | [ASL_STORELOCATOR city="Denver"] |
| postal_code | Filters stores by postal (ZIP) code | [ASL_STORELOCATOR postal_code="80204"] |
| country | Filters stores by country name (e.g., “Australia”) | [ASL_STORELOCATOR country="Australia"] |
| title | Filters stores by their title (exact match) – available since v4.8.31 | [ASL_STORELOCATOR title="My Store Title"] |
List of the Attributes for the Maps #
| Attributes | Description | Examples |
|---|---|---|
| advanced_marker | Enables Google’s advanced marker features on the map. | [ASL_STORELOCATOR advanced_marker="1"] |
| scroll_wheel | Enables or disables zooming with the mouse scroll wheel on the Google Map. | [ASL_STORELOCATOR scroll_wheel="default"] possible options (default, 0 , 1) |
| category_marker | Uses category-specific icons as map markers instead of default pins. | [ASL_STORELOCATOR category_marker="1"] |
| radius_circle | Enables or disables drawing a radius circle on the map. | [ASL_STORELOCATOR radius_circle="0"] |
| marker_height | Adds vertical offset/extra space above the info box marker. | [ASL_STORELOCATOR marker_height="40"] |
| category_bound | Adjusts map bounds dynamically when a category is selected. | [ASL_STORELOCATOR category_bound="1"] |
| marker_title | It can be used to remove the marker label that appears on hover | [ASL_STORELOCATOR marker_title="0"] |
| cluster | Enables or disables marker clustering on the map to group nearby markers. | [ASL_STORELOCATOR cluster="1"] |
| cluster_max_zoom | To limit the cluster appearance by the zoom level, the value must be within (5 to 22) | [ASL_STORELOCATOR cluster_max_zoom="9"] (integer between 5 and 22) |
| cluster_grid_size | The size of the grid for the cluster, number can be reduced. | [ASL_STORELOCATOR cluster_grid_size="90"] (positive integer; lower value = tighter clustering) |
| search_zoom | Sets the zoom level for map when displaying search results (integer between 9 and 21) | [ASL_STORELOCATOR search_zoom="14"] (possible values: 9 to 21) |
| mobile_zoom | Sets the default zoom level on mobile devices (integer between 9 and 21). | [ASL_STORELOCATOR mobile_zoom="12"] (possible values: 9 to 21) |
| mobile_search_zoom | Sets the zoom level for search results on mobile devices (integer between 9 and 21). | [ASL_STORELOCATOR mobile_search_zoom="13"] (possible values: 9 to 21) |
| mobile_click_zoom | Sets the zoom level when a store is clicked on mobile devices (integer between 9 and 21). | [ASL_STORELOCATOR mobile_click_zoom="15"] (possible values: 9 to 21) |
| do_bounce | Enables or disables bounce animation for markers on interaction. | [ASL_STORELOCATOR do_bounce="1"] |
| hover_center | Centers the map on the marker when the mouse hovers over it. | [ASL_STORELOCATOR hover_center="1"] |
| zoom_li | Sets the zoom level when clicking a list item (integer between 9 and 21). | [ASL_STORELOCATOR zoom_li="15"] (integer between 1 and 21) |
| direction_redirect | Redirects direction links to Google Maps directions page instead of internal routing. | [ASL_STORELOCATOR direction_redirect="1"] |
| coords_direction | Uses latitude/longitude coordinates for directions instead of address strings. | [ASL_STORELOCATOR coords_direction="1"] |
| title_only | Display only the store name or include the category name on marker hover. | [ASL_STORELOCATOR title_only="1"] |
| mobile_load_bound | Loads stores only within the current visible map area on mobile devices. | [ASL_STORELOCATOR mobile_load_bound="1"] |
| mobile_stores_limit | Maximum number of stores to show on mobile for performance. | [ASL_STORELOCATOR mobile_stores_limit="20"] |
| map_type | Defines the map view type. Options: roadmap, satellite, hybrid, terrain. | [ASL_STORELOCATOR map_type="roadmap"] (options: roadmap, satellite, hybrid, terrain) |
| zoomcontrol | Enables or disables zoom control on the map. | [ASL_STORELOCATOR zoomcontrol="true"] (values: “true” or “false”) |
| maptypecontrol | Toggles the visibility of map type selection buttons. | [ASL_STORELOCATOR maptypecontrol="false"] (values: “true” or “false”) |
| scalecontrol | Displays a scale bar on the map. | [ASL_STORELOCATOR scalecontrol="false"] (values: “true” or “false”) |
| rotatecontrol | Enables rotation gestures on the map (e.g., compass). | [ASL_STORELOCATOR rotatecontrol="false"] (values: “true” or “false”) |
| fullscreencontrol | Enables fullscreen toggle button. | [ASL_STORELOCATOR fullscreencontrol="true"] (values: “true” or “false”) |
| streetviewcontrol | Toggles access to Google Street View. | [ASL_STORELOCATOR streetviewcontrol="false"] (values: “true” or “false”) |
| position_maptype | Sets the position of map type controls. Positions: TOP_LEFT, TOP_RIGHT, etc. | [ASL_STORELOCATOR position_maptype="1"] (integer — refer to Google Maps ControlPosition enum) |
| position_fullscreen | Sets the fullscreen button position on the map. | [ASL_STORELOCATOR position_fullscreen="9"] (integer — e.g., 9 = RIGHT_CENTER) |
| position_zoom | Sets the zoom control position. | [ASL_STORELOCATOR position_zoom="5"] (integer — e.g., 5 = LEFT_CENTER) |
| position_streetview | Sets the Street View control position. | [ASL_STORELOCATOR position_streetview="10"] (integer — e.g., 10 = BOTTOM_LEFT) |
| maxzoom | Maximum allowed zoom level (e.g., 21 is fully zoomed in). | [ASL_STORELOCATOR maxzoom="20"] (integer between 1 and 21) |
| minzoom | Minimum allowed zoom level. | [ASL_STORELOCATOR minzoom="5"] (integer between 1 and 21) |
| map_layout | Selects predefined layout template for the map and results. | [ASL_STORELOCATOR map_layout="-1"] (possible values: -1 to 9) |
| kml | Show the loaded KML files to display custom overlays. | [ASL_STORELOCATOR kml="1"] |
| direction_mode | Travel mode for directions. | [ASL_STORELOCATOR direction_mode="WALKING"] (options: DRIVING, WALKING, BICYCLING, TRANSIT, TWO_WHEELER) |
| default_lat | Sets the default latitude coordinate for the map center. Must be a valid latitude value. | [ASL_STORELOCATOR default_lat="40.7128"] (valid latitude) |
| default_lng | Sets the default longitude coordinate for the map center. Must be a valid longitude value. | [ASL_STORELOCATOR default_lng="-74.0060"] (valid longitude) |
| api_key | Adds a Google Maps API Key directly in the shortcode. Not recommended; API key should be set in ASL Settings. | [ASL_STORELOCATOR api_key="YOUR_API_KEY"] (not recommended; use ASL Settings) |
| reset_button | Enables a reset button to restore the Google Map zoom and pan to the original default state set in ASL Settings. | [ASL_STORELOCATOR reset_button="1"] |
| active_marker | Specifies the marker to be set as active (highlighted) when clicked. Leave empty to disable this feature. | [ASL_STORELOCATOR active_marker="123"] (marker ID) |
| geo_marker | Enables (1) or disables (0) the geo-marker icon shown on location search. | [ASL_STORELOCATOR geo_marker="1"] |
| geo_marker_id | Sets a custom geo-marker icon by specifying the marker ID from the Manage Markers page. | [ASL_STORELOCATOR geo_marker_id="7"] (marker ID from Manage Markers) |
| radius_color | Sets the color of the radius circle using a hex color code. | [ASL_STORELOCATOR radius_color="#00BFFF"] (hex color code, e.g., #FF0000, #00BFFF) |
List of the Attributes for the Configuration #
| Attributes | Description | Examples |
|---|---|---|
| analytics | Enables analytics tracking for user interactions (e.g., searches, clicks). | [ASL_STORELOCATOR analytics="1"] |
| enter_key | Allows users to trigger the search by pressing the Enter key. | [ASL_STORELOCATOR enter_key="1"] |
| target_blank | Opens store detail links in a new browser tab. | [ASL_STORELOCATOR target_blank="1"] |
| slug_link | Either to show or hide the website link CTA | [ASL_STORELOCATOR slug_link="0"] |
| link_type | Determines whether the CTA button links to the store’s website or to its internal detail page using a slug. | [ASL_STORELOCATOR link_type="1"] (0 = website, 1 = slug) |
| no_geocode | Disables address geocoding fallback when no store is found through text-based search. | [ASL_STORELOCATOR no_geocode="1"] |
| no_regex | To fix the accordion layout, some languages that contains UTF-8 codes | [ASL_STORELOCATOR no_regex="1"] |
| cache | Enables caching of store data to improve performance and reduce server load. | [ASL_STORELOCATOR cache="1"] |
| cache_ver | Defines the cache version; updating the version forces cache refresh. | [ASL_STORELOCATOR cache_ver="2"] (integer; change value to refresh cache) |
| load_all | Loads all markers at once instead of loading only those within map bounds. Use 1 only for very large datasets (e.g., 5000+ markers). | [ASL_STORELOCATOR load_all="1"] |
| gdpr | Displays a GDPR compliance message before loading Google Maps. | [ASL_STORELOCATOR gdpr="1"] |
| default_store | Displays a default store by its ID when no search results are found due to filters. Replace xxx with the store ID. | [ASL_STORELOCATOR default_store="123"] (store ID) |
| print_btn | Displays a print button for printing store details or directions. | [ASL_STORELOCATOR print_btn="1"] |
List of the Attributes for the Sorting #
| Attributes | Description | Examples |
|---|---|---|
| sort_by_bound | Sorts and prioritizes stores based on their visibility within the current map bounds. | [ASL_STORELOCATOR sort_by_bound="1"] |
| sort_random | Displays the store list in random order. | [ASL_STORELOCATOR sort_random="1"] |
| sort_by | Sorts stores by a specific field (e.g., name, distance, city). | [ASL_STORELOCATOR sort_by=""] (options: title, city, state, empty value for the distance) |
| search_dist_sort | Sorts the search results by distance after performing a search (overrides initial sorting). Use 1 to enable. | [ASL_STORELOCATOR search_dist_sort="1"] |
| ignore_priority_with_distance | Disables priority-based sorting only when a search is performed. | [ASL_STORELOCATOR ignore_priority_with_distance="1"] |
| cat_sort | Changes the default alphabetical sorting of the categories dropdown to another attribute such as ordr (order ID). | [ASL_STORELOCATOR cat_sort="ordr"] |
List of the Attributes for the UI/UX #
| Attributes | Description | Examples |
|---|---|---|
| time_format | Uses 24-hour format for store opening hours. | [ASL_STORELOCATOR time_format="1"] |
| distance_unit | Sets the distance unit for search results: KM or Miles. | [ASL_STORELOCATOR distance_unit="KM"] (options: KM, Miles) |
| info_x_offset | Horizontal offset for the info window in pixels. | [ASL_STORELOCATOR info_x_offset="10"] (integer in pixels) |
| info_y_offset | Vertical offset for the info window in pixels. | [ASL_STORELOCATOR info_y_offset="-60"] (integer in pixels) |
| hide_logo | Hides the store logo in the results list or detail panel. | [ASL_STORELOCATOR hide_logo="1"] |
| hide_hours | Hides store opening hours from the list or details. | [ASL_STORELOCATOR hide_hours="1"] |
| list_event | Defines the interaction event for list items (click, hover). | [ASL_STORELOCATOR list_event="click"] (options: click, hover) |
| tabs_layout | Displays the store list and filters in a tabbed interface. | [ASL_STORELOCATOR tabs_layout="1"] |
| display_list | Toggles the visibility of the store list. | [ASL_STORELOCATOR display_list="0"] |
| closed_label | Shows a “Closed” label for currently closed stores. | [ASL_STORELOCATOR closed_label="1"] |
| additional_info | Displays extra store info (e.g., tags, notes) if available. | [ASL_STORELOCATOR additional_info="1"] |
| template | Sets the visual layout template | [ASL_STORELOCATOR template="2"] (integer — template ID) |
| prompt_location | Prompts user to share their location on load | [ASL_STORELOCATOR prompt_location="1"] (possible options 0,1,2,3) |
| disable_scroll | Disables auto-scrolling to the map on mobile devices. | [ASL_STORELOCATOR disable_scroll="1"] |
| disable_list_click | Disables interaction when a store list item is clicked. | [ASL_STORELOCATOR disable_list_click="1"] |
| mouseover | Enables mouseover event for markers. | [ASL_STORELOCATOR mouseover="1"] |
| mouseover_list | Defines the interaction event for list items (click, hover). | [ASL_STORELOCATOR mouseover_list="hover"] (options: click, hover) |
| full_width | Enables full-width layout, stretching the plugin to 100% width. Options: 0 (off), 1 (on). | [ASL_STORELOCATOR full_width="1"] (0 = off, 1 = on) |
| infobox_width | Sets the width of the infobox in pixels. | [ASL_STORELOCATOR infobox_width="300"] (width in pixels) |
| ddl_max_height | Sets the maximum height (in pixels) of the category dropdown control. | [ASL_STORELOCATOR ddl_max_height="250"] (height in pixels) |
| layout | Possible options: 0, 1, 2, 3 – Layout 1 is accordion style, which displays stores in a Country > State > City hierarchy. Layout 3 is a category-based accordion. | [ASL_STORELOCATOR layout="1"] |
| font_color_scheme | Possible options: 0, 1. Value 1 applies a dark font color scheme. | [ASL_STORELOCATOR font_color_scheme="1"] |
| color_scheme | Possible options: 0 to 8. Changes the overall color theme of the locator. | [ASL_STORELOCATOR color_scheme="1"] |
| infobox_layout | Possible options: 0, 1, 2 – Changes the Marker InfoWindow (infobox) layout style. | [ASL_STORELOCATOR infobox_layout="0"] |
| zoom_btn | Shows or hides the zoom control button on the store detail panel. | [ASL_STORELOCATOR zoom_btn="1"] |
| direction_btn | Enables or disables the directions button in the store listing or detail view. | [ASL_STORELOCATOR direction_btn="1"] |
| md | Sets column widths for medium screens using Bootstrap grid. Format: list,map. | [ASL_STORELOCATOR md="6,6"] |
| lg | Sets column widths for large screens using Bootstrap grid. Format: list,map. | [ASL_STORELOCATOR lg="4,8"] |
