includes/class-yith-store-locator-admin.php

yith_sl_admin_tabs

Tabs available on plugin admin panel in YITH -> Store Locator

Params

 array $admin_tabs




Return
 array $admin_tabs

yith_sl_plugin_panel_args

Default args used to instance the Store Locator options panel

Params

 array $admin_tabs




Return
 array $admin_tabs

includes/class-yith-store-locator-data-store.php

yith_sl_post_language

Store post language

Params

 string $language the language

 int  $post_id the post ID




Return
 array

includes/class-yith-store-locator-exporter.php

yith_sl_stores_export_get_filename

Name of the file generated on export of the stores

Params

 string $filename Filename




Return
 array

yith_sl_export_stores_columns

Default columns used to prepare the CSV file exporting stores

Params

 array $columns List of default columns




Return
 array

includes/class-yith-store-locator-filters-taxonomies.php

yith_sl_filter_radius_slug

Params

 string $filter_radius_slug the filter radius slug




Return
 string

yith_sl_filters_types

Filter types, default are dropdown and checkbox

Params

 array $filter_types the filter types




Return
 array

yith_sl_filters_radius_title

Params

 string $title the filter radius title




Return
 string

includes/class-yith-store-locator-frontend.php

yith_sl_get_results_args

Args used to get results

Params

 array $args list of args




Return
 array

yith_sl_is_store_locator_page

Detect if page includes shortcode [yith_store_locator]

Params

 bool $is_store_locator_page true/false




Return
 bool

includes/class-yith-store-locator-importer.php

yith_sl_csv_mapping_fields

Default fields used to map import of stores

Params

 array $fields CSV mapping fields




Return
 array

yith_sl_insert_store_args

Params

 array $args Store args




Return
 array

includes/class-yith-store-locator-post-type-admin.php

yith_sl_address_format

Format used to compose store address on frontend

Params

 string $format Address format, default is '{address_line_1} - {address_line_2}\n{city} - {state} - {postcode}\n{country}'




Return
 array

yith_sl_store_metaboxes

List of metaboxes registred for store edit page

Params

 array $metaboxes Metaboxes




Return
 array

includes/class-yith-store-locator-post-type.php

yith_sl_rewrite_slug_post_type

Params

 string $slug the post type rewrite slug




Return
 string

yith_sl_add_shop_manager_capabilities

Add shop manager capabilities to stores management

Params

 bool $add Add shop manager capabilities




Return
 bool

includes/class-yith-store-locator-scripts.php

yith_wcsl_always_enqueue_script

Params

 bool $enqueue Enqueue scripts




Return
 bool

includes/class-yith-store-locator-settings.php

yith_sl_store_locator_options

Params

 bool $option_value Option value

 bool $key Option key

 bool $default Option default value




Return
 bool

includes/class-yith-store-locator-shortcode.php

yith_sl_show_map_after_search_and_filters

Params

 bool $show show map




Return
 bool

yith_sl_show_map_on_right_side

Params

 bool $show Show map




Return
 bool

includes/class-yith-store-locator-store.php

yith_sl_store_name

Params

 string $name the store name




Return
 string

yith_sl_store_description

Params

 string $description the store description




Return
 string

yith_sl_store_image

Params

 string $image the store image




Return
 string

yith_sl_store_full_address_format

Params

 string $format the address format, default is {address_line1} {address_line2}\n{city} {state} \n {postcode} {country}

 object $this store object




Return
 string

yith_sl_address_separator

Separator used inside the address

Params

 string $separator the address separetor




Return
 string

includes/class-yith-store-locator.php

yith_sl_is_admin

Params

 bool $is_admin




Return
 bool

includes/functions.php

yith_sl_default_options

List of default values for options

Params

 array $defaults list of values




Return
 array

yith_sl_search_stores_args

Params

 array $search_args search args




Return
 array

yith_sl_filtered_stores

List of stores shown on frontend

Params

 array $stores list of stores

 array $args   list of args used to retrieve stores before




Return
 array

includes/woocommerce/class-yith-store-locator-wc-exporter.php

yith_sl_export_stock_default_columns

Params

 array $columns list of columns




Return
 array

includes/woocommerce/class-yith-store-locator-woocommerce.php

yith_sl_wc_tab_store_name

Store name shown inside the list you find in Store Locator in product edit page

Params

 string $store_name the store name

 object $store      the object $store




Return
 string

plugin-options/general-options.php

yith_sl_panel_general_options

Params

 array $custom_tab list of options




Return
 array

plugin-options/store-locator-page-options.php

yith_sl_panel_store_locator_page_options

Params

 array $custom_tab list of tabs




Return
 array

plugin-options/store-locator-page/filters-options.php

yith_sl_panel_store_locator_page_filters_options

Params

 array $options_tab list of options




Return
 array

plugin-options/store-locator-page/general-options.php

yith_sl_panel_store_locator_page_filters_options

Params

 array $option_tab list of options




Return
 array

plugin-options/store-locator-page/map-options.php

yith_sl_panel_store_locator_page_map_options

Params

 array $options_tab list of options




Return
 array

plugin-options/store-locator-page/search-options.php

yith_sl_panel_store_locator_page_search_options

Params

 array $option_tab list of options




Return
 array

plugin-options/stores-results-options.php

yith_sl_panel_stores_results_options

Params

 array $custom_tab list of options




Return
 array

plugin-options/stores/page-details-options.php

yith_sl_panel_stores_page_details_options

Params

 array $custom_tab list of options




Return
 array

plugin-options/woocommerce-options.php

yith_sl_panel_woocommerce_options

Params

 array $tab list of tabs




Return
 array

plugin-options/woocommerce/general-options.php

yith_sl_panel_woocommerce_filters_options

List of options available in YITH -> Store Locator -> WooCommerce Options -> General

Params

 array $custom_tab list of options




Return
 array

templates/admin/importer/modal.php

yith_sl_modal_import_mapping_fields

List of fields used to map store information inside the import admin modal

Params

 array $tab list of fields




Return
 array

templates/admin/woocommerce/stock-table.php

yith_sl_no_store_label

Params

 string $label the label.




Return
 string

templates/frontend/fields/checkbox.php

yith_sl_allow_default_value_for_filters

Allow default value for filters on first loading of store locator form

Params

 bool $allow the value, default is "true"




Return
 bool

templates/frontend/fields/dropdown.php

yith_sl_allow_default_value_for_filters

Allow default value for filters on first loading of store locator form

Params

 bool $allow the value, default is "true"




Return
 bool

templates/frontend/fields/radius-dropdown.php

yith_sl_allow_default_value_for_filters

Allow default value for filters on first loading of store locator form

Params

 bool $allow the value, default is "true"




Return
 bool

templates/frontend/fields/radius-opened.php

yith_sl_allow_default_value_for_filters

Allow default value for filters on first loading of store locator form

Params

 bool $allow the value, default is "true"




Return
 bool

templates/frontend/fields/select.php

yith_sl_allow_default_value_for_filters

Allow default value for filters on first loading of store locator form

Params

 bool $allow the value, default is "true"




Return
 bool

templates/frontend/pin-info-modal.php

yith_sl_target_view_website_link

Params

 string $value the attribute value.




Return
 string

templates/frontend/shortcodes/filters.php

yith_sl_open_filters_label

Params

 string $label default value




Return
 string

templates/frontend/shortcodes/filters/dropdown.php

yith_sl_filter_label

Filter label shown in store locator form

Params

 string $filter_label the filter label

 array $filter filter object




Return
 array

templates/frontend/shortcodes/filters/opened.php

yith_sl_show_filter_label

Params

 bool $show show the filter label




Return
 bool

templates/frontend/shortcodes/search.php

yith_sl_address_tooltip_text

Params

 string $text default text




Return
 string

templates/frontend/shortcodes/store-locator.php

yith_sl_move_move_map_to_selected_store_event

Javascript event used by the plugin to move map to selected store. Event is detected on store details wrapper in results list

Params

 string $event the JS event




Return
 string

yith_sl_show_default_location_for_no_results

Show default location on map in case of no results.

Params

bool $show_default_location show default location, false by default




Return
bool

yith_sl_map_zoom_control

Enable map zoom control

Params

bool $enable Enable zoom control




Return
bool

yith_sl_change_browser_url

Update browser url after any research

Params

string $update_url Update browser url (yes/no)




Return
string

templates/frontend/shortcodes/store-locator/active-filters.php

yith_sl_filter_label

Params

 string $label the filter label




Return
 string

yith_sl_clear_all_filters

Params

 string $label the filter label




Return
 string

templates/frontend/shortcodes/store-locator/single-result.php

yith_sl_target_view_website_link

Params

 string $value the attribute value.




Return
 string

templates/frontend/single/alternative.php

yith_sl_contact_phone_label

Label used for "contact phone" field in store detail page

Params

string $label contact phone label




Return
string.

yith_sl_contact_mobile_label

Label used for "contact mobile phone" field in store detail page

Params

string $label contact mobile phone label




Return
string. ?>

yith_sl_contact_email_label

Label used for "contact email" field in store detail page

Params

string $label contact email label




Return
string. ?>

yith_sl_contact_website_label

Label used for "contact website" field in store detail page

Params

string $label contact website label




Return
string. ?>

templates/frontend/single/classic.php

yith_sl_contact_phone_label

Label used for "contact phone" field in store detail page

Params

string $label contact phone label




Return
string.

yith_sl_contact_mobile_label

Label used for "contact mobile phone" field in store detail page

Params

string $label contact mobile phone label




Return
string.

yith_sl_contact_email_label

Label used for "contact email" field in store detail page

Params

string $label contact email label




Return
string.

yith_sl_contact_website_label

Label used for "contact website" field in store detail page

Params

string $label contact website label




Return
string.

templates/frontend/single/main.php

yith_sl_custom_direction_label

Label used for "Get Direction" field in store detail page

Params

string $label "Get direction" label




Return
string.

yith_sl_custom_contact_label

Label used for "Contact Store" button in store detail page

Params

string $label "Contact store" label




Return
string.