{"id":231,"date":"2023-01-16T16:19:49","date_gmt":"2023-01-16T16:19:49","guid":{"rendered":"https:\/\/docs.storelocatorplus.com\/?p=231"},"modified":"2024-01-29T20:54:19","modified_gmt":"2024-01-29T20:54:19","slug":"results-layout","status":"publish","type":"post","link":"https:\/\/documentation.storelocatorplus.com\/results-layout\/","title":{"rendered":"Results Layout Shortcodes and Attributes"},"content":{"rendered":"\n

Changing the results layout is a feature provided for Professional level accounts<\/a>. Users of the self-managed WordPress plugins will find this in the Experience add on<\/a>.<\/p>\n\n\n\n

Default Format<\/h1>\n\n\n\n

The default format for the results string uses the numerical encoding for the various data elements that can be rendered.   This default string format is present in the base Store Locator Plus plugin.  You can reset  to the default at any time by deleting the entry in the Results Layout field under  Settings\/Results\/Appearance and saving the settings.
<\/p>\n\n\n\n\n\n\n

\n
\"\"<\/figure>\n<\/div>\n\n\n

 <\/h1>\n\n\n\n

 <\/h1>\n\n\n\n

 <\/h1>\n\n\n\n

Shortcodes <\/h1>\n\n\n\n

The Results Layout is a combination of HTML and special shortcodes that are only active when rendering locations.  These strings can be reordered or deleted if you have the add-on for the WP Store Locator Plus Plug-in (Experience<\/a> add on).  Display a specific location field, such as a store name, or a location data element, such as  distance,  where you want it to  appear in the results layout.   Location fields are data taken directly from the location data table.<\/p>\n\n\n\n

You can output a single field (using the correct data field name<\/a> as shown under Location  import) with the [slp_location <location_data>] shortcode in the results layout.<\/p>\n\n\n\n

[slp_location <field name>]<\/h2>\n\n\n\n

Display data for a single location. Field name is a location field name.<\/p>\n\n\n\n

It can be a primary field name such as ‘name’.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

It can be a Secondary Field Name, as indicated with the “dot notation” which allows access to the “Object” Primary Fields such as “data”.    This is typically where add on and extended fields live as well as full access to the raw data for the base plugin.   For example the field “data.sl_id” will output the location ID.<\/p>\n\n\n\n

Examples:<\/h3>\n\n\n\n

[slp_location address]<\/h4>\n\n\n\n

[slp_location address2]<\/h4>\n\n\n\n

[slp_location city]<\/h4>\n\n\n\n

Display the city.<\/p>\n\n\n\n

[slp_location city_state_zip]<\/h4>\n\n\n\n

The city followed by the state followed by the zip with USA-style formatting.   If the city and state are not blank a comma is inserted between the two.   The zip is at the end with a space before it if either city or state are not blank.<\/p>\n\n\n\n

[slp_location zip_state_city]<\/h4>\n\n\n\n

The zip followed by the state followed by the city with European-style formatting.  A space is inserted between each element.<\/p>\n\n\n\n

[slp_location country]<\/h4>\n\n\n\n

Display the country<\/p>\n\n\n\n

[slp_location email]<\/h4>\n\n\n\n

Display the email.  This is not clickable just the raw email.  You will likely want to use email_link from the Experience<\/a> add-on instead.<\/p>\n\n\n\n

[slp_location hours]<\/h4>\n\n\n\n

The raw hours text, not HTML sanitized.<\/p>\n\n\n\n

[slp_location hours_sanitized]<\/h4>\n\n\n\n

The hours text field with all special characters decoded using JavaScript text formatting.<\/p>\n\n\n\n

[slp_location url]<\/h4>\n\n\n\n

Display the url.  This is not clickable just the raw url.  You will likely want to use web_link or url_link instead.<\/p>\n\n\n\n

[slp_location url_link]<\/h4>\n\n\n\n

Display the url in a clickable link.  Displays the full URL instead of the website label.  Use web_link if you prefer the website label.  The website label can be changed with the Experience<\/a> add-on.<\/p>\n\n\n\n

[slp_location web_link]<\/h4>\n\n\n\n

This will be the location URL from the location database OR a link to the  Pages web page if \u201cpages replace website\u201d is enabled in  Pages.   The text will be the website label text.<\/p>\n\n\n\n

[slp_location data.sl_id]<\/h4>\n\n\n\n

Display the location ID field.<\/p>\n\n\n\n

[slp_location data.sl_private]<\/h4>\n\n\n\n

Display whether or not the location is private.<\/p>\n\n\n\n

\n\n\n\n

[slp_option <option_name>]<\/h3>\n\n\n\n

Display the value of a setting, typically from the base Store Locator Plus setting to output a label or other text element set in the global settings.<\/p>\n\n\n\n

\"\"
Some of the slp_option settings that come with the base plugin. Add ons can , and often to, modify the settings that can be used with the [slp_option …] shortcode in results layout.<\/figcaption><\/figure>\n\n\n\n
\n\n\n\n

[html br|closing_anchor]<\/h3>\n\n\n\n

Display an HTML string.<\/p>\n\n\n\n

Allows for a <br> tag or closing anchor tag <\/a> to be output based on conditions.<\/p>\n\n\n\n

Examples<\/h3>\n\n\n

[html br]<\/p>\n\n\n

[html closing_anchor]<\/p>\n\n\n\n

\n\n\n\n

[slp_addon …]<\/h3>\n\n\n\n

A placeholder marker for indicating to add ons where special processing is to take place.  Has not output.<\/p>\n\n\n\n

\n\n\n\n

Modifiers<\/h3>\n\n\n\n

These modifiers apply to ALL of the results layout settings other than [slp_addon …].<\/p>\n\n\n

[slp_location <fieldname>]<\/p>\n\n\n\n

, [slp_option <option_name>], and [html br|closing_anchor] can all use these as the third parameter.  The “text” will be the field value, setting value, or HTML <br\/> or <\/a> tag.\n<\/p>\n\n\n\n

ifset <fieldname><\/h3>\n\n\n\n

If the specified location data field is empty or evaluates to false as a JavaScript expression then NOTHING will be output.   Otherwise output the text.  Useful for turning off specific output when a field is blank.<\/p>\n\n\n\n

ifnotset=”<fieldname>”<\/h3>\n\n\n\n

Inverse of ifset as noted above.

If the specified location data field is NOT empty…<\/p>\n\n\n\n

Examples<\/h4>\n\n\n\n

The example shows the location’s phone number as long as the phone field is set. Only if the phone field is NOT set will it show the fax.

The [slp_location phone] field can be modified with other settings like add dial extension. The use of data.sl_phone, instead of simply phone, allows us to query the original location data.<\/p>\n\n\n\n

[slp_location phone ifset=\"data.sl_phone\"]\n[slp_location fax ifnotset=\"data.sl_phone\"]<\/pre>\n\n\n\n
suffix<\/h3>\n\n\n\n
Output the noted suffix after the text string.<\/p>\n\n\n\n
br<\/h4>\n\n\n\n
Output the HTML break <br\/><\/p>\n\n\n\n
comma<\/h4>\n\n\n\n
Output a comma ,<\/p>\n\n\n\n
comma_space<\/h4>\n\n\n\n
Output a comma followed by a space ,<\/p>\n\n\n\n
space<\/h4>\n\n\n\n
Output a space<\/p>\n\n\n\n
wrap<\/h3>\n\n\n\n
Wrap the text with some special HTML code.<\/p>\n\n\n\n
directions<\/h4>\n\n\n\n
An HTML anchor tag linked to the Google Maps directions format with source address being what the user typed in the search box and destination being the location’s full address.   Make the text for the given field the ‘clickable part’.<\/p>\n\n\n\n
img<\/h4>\n\n\n\n
Use the text as the image source in an HTML <img src… \/> tag.<\/p>\n\n\n\n
mailto<\/h4>\n\n\n\n
Use the text as the email address in an HTML <a href=”mailto…” tag.   Does NOT output the closing part of the tag.   Use [html closinganchor] to set this.<\/p>\n\n\n\n
website<\/h4>\n\n\n\n
Use the text as the website URL in an HTML <a href=”…” tag.  Does NOT output the closing part of the tag.   Use [html closinganchor] to set this.<\/p>\n\n\n\n
fullspan<\/h4>\n\n\n\n
Add a <span class=”results_line location_<field|option name>”>…<\/span> HTML string around the text.<\/p>\n\n\n\n
format<\/h3>\n\n\n\n
Apply a special format to the text.   Must be ‘decimal1<\/strong>‘ , ‘decimal2<\/strong>‘ , ‘sanitize<\/strong>‘, or ‘text<\/strong>‘.<\/p>\n\n\n\n
decimal1<\/h4>\n\n\n\n
Parse the text as a float and show one digit after the decimal.<\/p>\n\n\n\n
decimal2<\/h4>\n\n\n\n
Parse the text as a float and show two digits after the decimal.<\/p>\n\n\n\n
sanitize<\/h4>\n\n\n\n
Strip out anything that is not a “word character” (letters, numbers, underscores, hyphens).<\/p>\n\n\n\n
text<\/h4>\n\n\n\n
Force the data to be passed trough the  HTML parser and convert special HTML characters to their ampersand encoding.<\/p>\n\n\n\n
raw<\/h4>\n\n\n\n
Normally any text string will be run through the JavaScript HTML parser to encode special characters such as < to &lt;.   The raw modifier will force the original string to be output as-is.  Useful it trying to output an HTML setting intact.<\/p>\n\n\n\n
Default Setting for Results Layout<\/h2>\n\n\n\n
The default setting for the Results Layout (Smart Option ID: resultslayout) as of January 2023 is shown below:<\/p>\n\n\n\n
<div id=\"slp_results_[slp_location id]\" class=\"results_entry location_primary [slp_location featured]\">\n    <div class=\"results_row_left_column\"   id=\"slp_left_cell_[slp_location id]\"   >\n        <span class=\"location_name\">[slp_location name] [slp_location uml_buttons] [slp_location gfi_buttons]<\/span>\n        <span class=\"location_distance\">[slp_location distance_1] [slp_location distance_unit]<\/span>\n    <\/div>\n    <div class=\"results_row_center_column location_secondary\" id=\"slp_center_cell_[slp_location id]\" >\n        <span class=\"slp_result_address slp_result_street\">[slp_location address]<\/span>\n        <span class=\"slp_result_address slp_result_street2\">[slp_location address2]<\/span>\n        <span class=\"slp_result_address slp_result_citystatezip\">[slp_location city_state_zip]<\/span>\n        <span class=\"slp_result_address slp_result_country\">[slp_location country]<\/span>\n        <span class=\"slp_result_address slp_result_phone\">[slp_location phone_with_label]<\/span>\n        <span class=\"slp_result_address slp_result_fax\">[slp_location fax]<\/span>\n    <\/div>\n    <div class=\"results_row_right_column location_tertiary\"  id=\"slp_right_cell_[slp_location id]\"  >\n        <span class=\"slp_result_contact slp_result_website\">[slp_location web_link]<\/span>\n        <span class=\"slp_result_contact slp_result_email\">[slp_location email_link]<\/span>\n        <span class=\"slp_result_contact slp_result_directions\"><a href=\"https:\/\/[slp_option map_domain]\/maps?saddr=[slp_location search_address]&daddr=[slp_location location_address]\" target=\"_blank\" class=\"storelocatorlink\">[slp_location directions_text]<\/a><\/span>\n        <span class=\"slp_result_contact slp_result_hours\">[slp_location hours]<\/span>\n        [slp_location pro_tags]\n        [slp_location iconarray wrap=\"fullspan\"]\n    <\/div>\n<\/div>\n\nNOTE<\/strong>\nCategory icons or markers can be displayed on the map or in the result  but if you need to re-iterate and show the category text, you will need to add tags to locations and add the sl_tag  under the results layout. <\/code><\/pre>\n\n\n\n
Resetting To Default<\/h2>\n\n\n\n
This setting is included in the Default Locator Layout style.   <\/p>\n\n\n\n
To reset to this setting — NOTE: this will overwrite most of your locator settings.<\/em><\/strong><\/p>\n\n\n\n