Documentation

1.Getting Started
This plugin gives opportunity to configure Multiple Stores on map. Stores can be search by using ‘Category Filter’, ‘Tag Words’ and ‘Radius’. Search is not restricted with in the premises of a country. If a store has multiple branches at different countries so map will point all of those countries that are in your search radius.
We can set multiple stores at nearby distance so it will point the total number of stores in an area. If we zoom in to those pointed numbers, then hidden stores would get segregated and shown separately.
Moreover, every listed store has an option of ‘Get Direction’ which will fetch ‘Your Current Location’ or the ‘location that has set by admin at backend’ and will show the route to desired location.
Multistore Locator is utilizing Google Map API that provides prompt information of your search query
2.Features List
- Stores can be added with Operating Timings, Address, Contact Details, Description about your store and Assigned Sales Manager
- Store categories can be added so that different category of stores will be displayed on your map.
- Store Tags can be added so that the user can search stores via ‘Tag Words’
- We can maintain ‘Store Manager’ list. One manager can be assigned to a specific store as well as multiple stores
- There is an option to ‘Import Stores’ and ‘Store Managers’ in csv file format
- We can export ‘Stores’ (by category filters) in csv format that we have made for our website
- Lastly, we can export ‘Sales Managers’ list in csv format that can be forward to anyone or can be modified for own use
- Import / Export New UI
- Map Theme color
- Map Button color
- Map Label color
- Gutenberg Block Support
3.Installation Guide
Visit Codecanyon Dashboard to download ‘WP Multi Store Locator Pro’ plugin
- Once downloaded then go to your WordPress Dashboard
- Then ‘Plugin’>’Add New’>’Upload Plugin’
- ‘Install’ and ‘Activate’ the plugin
4.Configuration of Google Account
4.1.Google Cloud Console Settings
- Go to google search bar and type ‘Google API cloud console’
- Then click on following link:
https://console.cloud.google.com/google/maps-apis/overview
- Next thing is to log in your google account
- Once you logged in so following screen will appear
- You have to click on ‘My Project’ as per below image
- By clicking on this button, you will be directed to below popup screen
- Here click on ‘New Project’
- A form will open to register a new project. User needs to enter following items in that form to proceed further
a- Project Name
b- Organization
c- Location
- Click on Create
- Your new project will be generated by clicking on ‘Create’ Button and will give a notification
- In ‘Notification’ list, click on ‘View’
- Clicking on ‘View’ button will open following screen
- Here we have to click on ‘Go to API’s Overview’
- Then following screen will appear in which you have to go in ‘Credentials’ Tab
- And then click on ‘Create Credentials’
- Select ‘API Key’
- Your API key will be created
4.2.API Key Authentication by Linking Billing Account
- You have to connect your ‘Project Account’ as ‘Billing Account’
- For that you have to go in ‘Navigation Menu’
- Then in ‘Billing’ Tab
- Click on ‘Link a Billing Account’ if you don’t have a billing account
- Or click on ‘Manage a Billing Account’ if you already have an account
- Click on ‘Create Billing Account’
- This option will take you on payment gateway option where you can pay and get the API key authenticated
- Here you need to select your ‘country from dropdown’, ‘Checkmark on terms and condition’
- Click on Continue button
- Upon clicking on continue button, you will routed on below screen where you need to fill necessary details and complete the process
5.Site Settings of Plugin
5.1.API key setting to establish Base Location of Map
- Admin will go in backend site settings
- Then on ‘Stores Locator’ Tab
- Click on ‘Settings’ Tab
- Paste the API Key in this form which you have activated earlier and saved it
- Admin can set ‘Address’, ‘Country’, ‘State’, ‘City’, ‘Postal Code’ that will be shown as default location
- Click on ‘Save Changes’ button
Impact on Frontend
Base location of map had set by admin at ‘Denver’ so blue pointer is showing base location while cluster in blue color is representing presence of multiple stores at nearby distance
5.2.Manual Addition of Store
- Go to ‘Store Locator’ Tab
- Then ‘Store List’
- Give ‘Name’ to your store
- Add ‘Description’ if you want
- Add ‘Phone No’
- Add ‘fax’
- Add ‘Email Address’
- Add ‘Website’
- Add ‘New Category’ or ‘Select’ from previously added categories
- Add ‘Tags’ or ‘Select’ from previously added tags
- Set ‘Product Image’
- Select ‘Working Hours’
- Select Sales Manager
- Give your ‘Address’ in ‘Address Bar’
- ‘Store Longitude and Latitude’ will be auto picked
- Select ‘Country’ from dropdown option
- Select ‘State’ from dropdown option
- Enter ‘City Name’
- Enter ‘Postal Code’
- Click on ‘Publish’ and the Store will be saved
Impact on frontend
All the details that has added above will get displayed against every store
Edit or Delete an Added Store
- Go to Store Locator Tab
- Then Stores List
- You can see an added store along with options to ‘edit’ or ‘trash’
5.3.Adding Store Category
- Go to ‘Store Locator’ Tab
- Then ‘Store Categories’ Tab
- Here you can add ‘Name’
- Add ‘Slug’
- Add ‘Parent Category’ by selecting a previously added category or set as ‘none’. None means it has no parent category.
- Give ‘Description’ if you want
- Add ‘Marker Color’ that you want to use to indicate your added store on map
- If you have a ‘Custom Marker’ so you can upload it
- Click on ‘Add New Category’
Impact on frontend
By selecting ‘BAKERS’ in category dropdown,list of bakeries has displayed with pointed locations on map
Edit/Delete an Added Store Category
- Go to ‘Stores Categories’
- We can ‘Edit’ any of previously added ‘Store Category’ or can ‘Delete’ it.
5.4.Adding Tags
- Go to ‘Store Locator’
- Then ‘Store Tags’
- Add ‘Name’
- Add ‘Slug’
- Add ‘Description’
- Click on ‘Add New Tag’
Impact on frontend
By selecting ‘BAKERS’ from ‘tag words’, list of bakeries has displayed with pointed locations on map
Edit/Delete an Added Tag
- You can ‘Edit’ and ‘Delete’ a previously added ‘Tag Word’
- Click on a ‘Added Tag’
- You can edit ‘Name’, ‘Slug’ or ‘Description’
- Click on ‘Update’
5.5.Map Addition
- Now you have to add a map and its shortcode is going to be pasted on a page, All the stores will get displayed on this map.
- Name the Map
- Next is Map Settings: You can use ‘Global Settings’ which would utilize the settings that are set at ‘Store Locator’ Tab > ‘Settings’ Tab > ‘Map Settings’. Else all the settings in this tab can be set manually
- In case of ‘Individual Map Setting’ we need to set following items:
- Checkmark ‘Show map on frontend’ so that it will render the map
- Map Width and Map Height
- Map Type
- Search Unit
- Direction Selection
- Default Map Zoom Level
- Location Search Zoom Level
- Fit Screen to Stores
- Fill radius with color
- Fill color
- Search Radius option
- Show Street View Control
- Show Map Cluster
- On page load get location
- Scroll to map top after search
- Show map type control
- Zoom by scroll on map
- Show map search options
- Hide Fields for ‘Search Map’ option
- Switch to RTL (When a user is utilizing language)
- Set map style
- Use Marker for default location of map/ You can add custom marker too
- Store Marker to Point Stores/ You can add custom marker too (We can also use Store Category Marker)
- Set info window content which will show the details of each store
- You can set customized map styles
- You can set ‘Placeholder’ and ‘Grid Settings’
5.6.Configure Sales Manager List
-
Admin can add ‘Sales Managers’ that can be allocated to a specific store or a manager can be allocated to several stores. Sales Manager can be seen on viewing a store at single page
-
Go to ‘Sales Manager’ Tab
-
Click on ‘Add New’
- Fill the following details to add a sale manager
- Identification
- Title
- Name
- Phone
- Publish
- We can delete any manager that had added previously
6.Import / Export
- Navigate to WordPress Admin Dashboard → Store Locator → Import/Export.
- Once done, you’ll see four tabs on this page.
- Import Stores
- Export Stores
- Import Sales Manager
- Export Sales Manager
6.1.Import Stores
- Navigate to the Import Stores tabs. (The Admin will be redirected on the Import Stores tab by default when you’re on the Import / Export page).
- Click on Sample CSV to download a sample file.
- Once done, a Sample_Stores.csv will be downloaded.
- Click on the file to open it.
- You can also edit the file according to your requirement.
- You can import the stores in CSV file format via the admin panel.
- Create your CSV Import file.
- Click on the Browse button.
- Select the CSV file.
- Once done, the name of the selected file will be displayed.
- Click on the Upload button.
- Once the operation is successful, a popup will appear, which will display all the details regarding the Imported file.
- Click on the VIEW IMPORT LOG button.
- It will display a log in which the store’s Code, Name, and Status will be displayed.
- Click on the DOWNLOAD LOG button.
- All the Logs will be downloaded in a CSV file.
- All the Logs will be downloaded in a CSV file.
- Open the download Logs file to view logs in CSV format.
- Navigate to WordPress Admin Dashboard → Store Locator → Stores List.
- Now you’re on the Store Locator page.
- All the Stores are present on this page.
- We can see that the Store we imported via the CSV file is now added in the Store List section.
6.2.Export Stores
- Navigate to the Export Stores tabs.
- There is a dropdown menu in the Export Stores tab in which all the Store Categories are mentioned.
- Click on the dropdown menu.
- Select the Category which you want to export.
- You can also select All Categories to export all stores.
- Once done, click on the Export button.
- A CSV File will be downloaded.
- Open the CSV file.
- Navigate to WordPress Admin Dashboard → Store Locator → Stores List.
- Now you’re on the Store Locator page.
- All the Stores are present on this page.
- We can see that all the stores present on the Store Locator page are exported in the CSV file.
6.3.Import Sales Manager
- Navigate to the Export Stores tabs.
- Click on Sample CSV to download a sample file.
- Once done, a Sample_Sales_Manager.csv will be downloaded.
- Click on the file to open it.
- You can also edit the file according to your requirement.
- You can import the sales manager in CSV file format via the admin panel.
- Create your CSV Import file.
- Click on the Browse button.
- Select the CSV file.
- Once done, the name of the selected file will be displayed.
- Click on the Upload button.
- Navigate to WordPress Admin Dashboard → Store Locator → Sales Managers List.
- Now you’re on the Sales Managers List page.
- All the Sales Managers are present on this page.
- We can see that the Sales Managers we imported via the CSV file are now added in the Sales Managers List section.
6.4.Export Sales Manager
- Navigate to the Export Sales Manager tabs.
- There is a dropdown menu in the Export Sales Manager tab in which all the Store Categories are mentioned.
- Click on the dropdown menu.
- Select the Category which you want to export.
- You can also select All Categories to export all the sales managers.
- Once done, click on the Export button.
- A CSV File will be downloaded.
- Open the CSV file.
- Navigate to WordPress Admin Dashboard → Store Locator → Sales Managers List.
- Now you’re on the Sales Managers List page.
- All the Sales Managers are present on this page.
- We can see that all the sales managers present on the Sales Managers List page are exported in the CSV file.
7.Default Settings for Store Locator Plugin
In this section we can set the default settings for following particulars. These settings are also available in ‘MAP’ Tab. If we turn ‘Global Settings’ in ‘MAP’ details instead of setting the details manually, so all the information will be used from this portion:
7.1.Initialize
It will show default location pointer. Country or location details will be set through following fields
7.2.Map Settings
Map Settings will be configured same as we did in ‘MAPS’ Tab
7.3.Placeholder Settings
In this section we will add following fields:
- Get Location
- Enter Location Text
- Select Category
- Select Tags
- Search Option Button Text
- Store List Text
- Visit Website Text
- Save
7.4.Grid Settings
In Grid Settings we can configure following fields:
- Show Grid on frontend checkmark
- Max limit of markers to be displayed
- Map results to be shown on which side
- Map search option window
8.Shortcode Settings
- Go to ‘Store Locator’
- Then ‘Maps’
- Then click on ‘Edit’ of a saved map
- Copy the shortcode
- Shortcode can also be copied from the option shown below
- Create a new page
- Give ‘Title’ to the page
- Click on ‘Add’ button
- Click on ‘Shortcode’
- Paste it below the title column
- ‘Publish’ it
9.Frontend Functionality
-
We need to go on ‘Store Page’ Tab or the tab where you have saved the ‘shortcode’
-
Click on ‘Search Option’ and it will show you following ‘search filters’:
- ‘Search stores by radius’
- ‘Search stores by category’
- ‘Search stores by tags’
- Whatever the search filter has applied it will show the result
- List of locations will be displayed
- Cluster of locations can be seen which will be segregated upon scrolling
- If we click on any ‘Store’ it will show the details of that store in this way
- We can ‘get the direction’ of store from ‘Our Location’ or the ‘default location of map’
- Map type can be changed
- If you are at some location but you want to set the map as it was showing on default so click on ’Reset Map’ Button
- Map is on his default screen now
10.Map Configuration
- Navigate to WordPress Admin Dashboard → Store Locator → Maps.
- Now you’re on the Maps page.
- All the maps are present on this page.
- Hover over any maps to view the suboptions.
- Click on the Edit button.
- Now you’re on the Edit Map page.
- On the right-hand side of the page, select the Map Layout according to your requirement.
10.1.Map Button Color
- Set the color of the Map Button Color using the below-specified method. The same procedure can be followed to change the color of the Map theme and Map labels.
10.2.Map Theme Color
- Set color of the Map theme from Map Theme Color.
10.3.Map Label Color
- Set color of labels displayed on the map from Map Label Color.
11.Gutenberg Block Support
- Navigate to WordPress Admin Dashboard → Pages → Add New.
- Add the Title of the page.
- Click on the sign ➕ to add blocks.
- Select or Search the MSL Map Form element.
- Select your Map from the dropdown according to your requirement.
- Click on Publish button.
12.Changelog
Version: 4.2 Date: 30/6/2020 Fixed - Some part of map is behind stores grid. Fixed - Stores sorting by distance not working when we search a location. Fixed - Only city name showing up in location field in full screen map Fixed - On Get Direction it always shows direction from default location to store location. Fixed - Notices and warnings. Fixed - Multi Store Locator element in WPBakery Page Builder not working. Fixed - '+' sign being added if phone number column is empty in Store Import. Added - Email and Description in Store Export. Added - Option to hide 'Points of Interest'.
Version: 4.1 Date: 30/4/2020 Added - Option to add category and description in store info-window in custom map. Added - Option to import store description via csv. Fixed - Google Logo Hide Issue Fixed
Version: 4.0 Date: 18/2/2020 Added - Fit Screen To Stores Option. Added - Fill Radius with color Option. Added - Fill color Option. Added - Export stores by category option. Added - Reset map option in search. Added 'Reset to Default' option in Global Map Settings. Improvement - Stores now showing from closest to the farthest in grid. Improvement - in custom maps on clicking a store info-window the address will now populate in directions route end field Improvement - displayed a message when map is disabled from back-end Fixed - 'Default Map Zoom Level' was not being applied. Fixed - 'Location Search Zoom Level' was not being applied. Fixed - Category Image was not saving on update in category page. Fixed - Showing all categories in search options instead of the ones assigned to map. Fixed - 'Maximum number of markers to be displayed' not working Fixed - after import, stores not visible on map until we update each store. Fixed - Map not rendering in Elementor page editor. Fixed - All visible warnings and notices. Removed - 'Location not found text' option from admin options Version: 3.5.0 Date: 14/1/2020 Fixed - Sales Managers not saving. Fixed - Use category markers for store markers not working. Fixed - Different Map Styles Not working. Fixed - Get Directions showing directions in terms of 'walking' instead of 'driving'. Added - 'clear stores' button on import. Added - Longitude and Latitude in import and export. Fixed - Shortcode showing custom and fullscreen map should now be compatible with Gutenberg and Divi theme. Fixed - Stores show up in frontend, even after they are deleted from trash in wordpress admin.
Version : 3.0.1 Date : 28/10/2019 Fixed - Old shortcode CSS issues fixed
Version: 3.0 Date: 02/09/2019 Added Multiple Maps By Categories. Added Info Window Customization. Added Google Maps Detailed Direction On Map & Redirect. Added Custom Markers. Added Category Based Markers Added Embed Map Functionality Added Multiple Templates Support For Maps
Version:2.9 Date: 17/01/2019 Fixed - Admin Backend CSS issue fixed Fixed - Fixed minor PHP bugs
Version: 2.8 Date: 12/06/2018 Fixed - Snazzy Maps styles issue. Fixed - Infobox store featured image issue. Added - Number of markers to be displayed on the map. Added - Visit website label to be dynamic.
Version: 2.7 Date: 30/03/2018 Fixed - Search box toggle issue.
Version: 2.6 Date: 07/03/2018 Fixed - Get my location SSL check. Added - Search location with function-based. Fixed - Map Search Open as Default with back end-setting.
Version: 2.4 Date: 15/02/2018 Added - Introduced map clusters functionality Added - Import/export categories. Added - Default location. Added - Map Zoom by scroll dynamic setting. Added - Added new layout. Added - Added multiple layout options. Fixed - Search locations. fixed - Admin settings in an easy way. fixed - CSS related issues.
Version: 1.8 Date: 18/1/2018 Added - Store List Dynamic Label. Added - Support for import/export store categories. Added - Optimized Import/Export Store compatibility.
Version: 1.5 Date: 11/10/2017 Fixed - Statistics Page Fixes. Fixed - Store import instantly. Added - Confliction with nice select removed. Added - Clickable Call button on store phone number infowindow.
Version: 1.4 Date: 19/09/2017 Added - Translation support using .PO .MO files
Version: 1.3.1 Date: 08/09/2017 Added - Compatible with Jupiter Version: 5.9.7 Fixed - Responsive CSS on search store layout.
Version: 1.3 Date: 21/08/2017 Fixed - cross browser CSS fixes. Fixed - Map Height Setting. Fixed - Listing Setting. Fixed - WooCommerce Confliction. Added - Support For Divi builder. Added - Support For Elementor builder. Added - Support For Beaver builder. Added - Support For UPD Power Builder ( Cherry framework ). Update - Overhaul the of import functionality.
Version: 1.2.2 Date: 28/07/2017 Added - Single Page Functionality For Your Stores.
Version: 1.2.1 24/07/2017 Fixed - Js store_locatore_search_lat,store_locatore_search_lng remove from hidden field to get direction.
Version: 1.2 Date: 07/07/2017 Added - RTL Support Added - Add Support For WPML Added - Add Support For Avada (Fusion Builder) Added - Add Support For Divi Builder Added - Add Support For Visual Composer.
Version: 1.1.1 Date: 14/06/2017 Fixed - broken icon in listing Added - Optimized Code Added - Optimized JS
Version: 1.1 Date: 30/05/2017 Added - attribute "Location" in the shortcode. Added attribute "City" in the shortcode. Added attribute "State" in the shortcode. Added - attribute "Radius" in the shortcode. Added - Option to display default map with in specific radius/location. [ store_locator_show city="Alabama" state="US" radius="25" ] Fixed - Direction Icon. Added - New Layouts Added - Store Listings Added - Counter icon Added - Custom Map Styling Added - Option to Enable/ Disable Search Filter Added - Search Placeholder Option Added - Add Your Own Marker Added - Search Toggle Disable / Enable Option
Version: 1.0 Date: initial release.