SLP® phpDocs

SLPlus extends SLP_Object_With_Objects
in package

The base plugin class for Store Locator Plus.

Table of Contents

Constants

category_option_base  = \SLPLUS_PREFIX . '-TAGALONG-category_'
earth_radius_km  = 6371
earth_radius_mi  = 3959
locationPostType  = 'store_page'
locationPostURL  = 'store-page'
locationTaxonomy  = 'stores'
menu_icon  = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyMC4wLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMy4zIDQyLjkiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDMzLjMgNDIuOTsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6dXJsKCNTVkdJRF8xXyk7fQ0KPC9zdHlsZT4NCjx0aXRsZT5TTFAtbG9nby1zbWFsbC1jb2xvcjwvdGl0bGU+DQo8bGluZWFyR3JhZGllbnQgaWQ9IlNWR0lEXzFfIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjMzNy43ODY3IiB5MT0iLTI4Ny40ODIyIiB4Mj0iMzY5LjA5NjYiIHkyPSItMjg3LjQ4MjIiIGdyYWRpZW50VHJhbnNmb3JtPSJtYXRyaXgoMSAwIDAgLTEgLTMzNi42MiAtMjY1Ljk4NjcpIj4NCgk8c3RvcCAgb2Zmc2V0PSIwIiBzdHlsZT0ic3RvcC1jb2xvcjojRUY1MzIzIi8+DQoJPHN0b3AgIG9mZnNldD0iMC4xNiIgc3R5bGU9InN0b3AtY29sb3I6I0UwNDkyNiIvPg0KCTxzdG9wICBvZmZzZXQ9IjAuNDMiIHN0eWxlPSJzdG9wLWNvbG9yOiNDRDNDMkEiLz4NCgk8c3RvcCAgb2Zmc2V0PSIwLjcxIiBzdHlsZT0ic3RvcC1jb2xvcjojQzIzNTJDIi8+DQoJPHN0b3AgIG9mZnNldD0iMSIgc3R5bGU9InN0b3AtY29sb3I6I0JFMzIyRCIvPg0KPC9saW5lYXJHcmFkaWVudD4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik0zMi41LDE3LjJjMC00LjgtMi4yLTkuMy01LjktMTIuM2MtMC42LTAuNS0xLjUtMC40LTIsMC4yYzAsMCwwLDAsMCwwbC0xLjEsMS40bDAsMGwtMS44LDIuM2wtMC4xLTAuMQ0KCWMtMC40LTAuMi0wLjgtMC40LTEuMi0wLjZjLTAuNy0wLjMtMS40LTAuNS0yLjItMC42Yy0wLjMtMC4xLTAuNy0wLjEtMS0wLjFjLTAuNCwwLTAuOCwwLTEuMSwwYy0wLjMsMC0wLjYsMC4xLTAuOSwwLjENCgljLTAuNCwwLjEtMC43LDAuMS0xLDAuMkMxMy44LDgsMTMuNCw4LjIsMTMsOC40Yy0wLjMsMC4xLTAuNiwwLjMtMC45LDAuNWMtMC40LDAuMi0wLjgsMC41LTEuMSwwLjhjLTAuNCwwLjMtMC44LDAuNy0xLjIsMS4xDQoJYy0wLjYsMC43LTEuMSwxLjQtMS41LDIuM2MtMC4yLDAuNC0wLjQsMC45LTAuNSwxLjNjLTAuMSwwLjItMC4xLDAuNC0wLjIsMC42djAuMWMwLDAuMi0wLjEsMC40LTAuMSwwLjdzMCwwLjQtMC4xLDAuNg0KCWMtMC4xLDAuNS0wLjEsMSwwLDEuNWMwLjEsMC41LDAuNSwwLjgsMC45LDAuOGgxNC41bDAsMGMtMC4xLDAuNC0wLjMsMC44LTAuNCwxLjJjLTAuMiwwLjQtMC40LDAuNy0wLjYsMWMtMC4yLDAuMy0wLjUsMC42LTAuNywwLjgNCgljLTAuMiwwLjItMC41LDAuNC0wLjcsMC41Yy0wLjMsMC4yLTAuNywwLjQtMSwwLjVjLTAuNCwwLjItMC44LDAuMy0xLjIsMC40Yy0wLjQsMC4xLTAuOCwwLjEtMS4yLDAuMWMtMC4zLDAtMC43LDAtMSwwDQoJYy0wLjctMC4xLTEuNC0wLjMtMi4xLTAuNmwtMC40LTAuMmMtMC40LTAuMi0wLjgtMC41LTEuMS0wLjljLTAuMi0wLjItMC40LTAuMy0wLjctMC4zYy0wLjIsMC0wLjUsMC4xLTAuNiwwLjNsLTAuOCwwLjhsLTAuMSwwLjENCgljLTAuMSwwLjEtMC4xLDAuMS0wLjIsMC4ybC0yLjcsMi43bC0wLjEtMC4xbC0wLjEtMC4xTDcsMjQuOWMtMS45LTIuMy0yLjktNS4zLTIuNy04LjNDNC41LDExLDguNSw2LjIsMTQuMSw0LjkNCgljMS44LTAuNCwzLjctMC40LDUuNSwwYzAuNywwLjIsMS40LTAuMSwxLjgtMC42YzAuNS0wLjcsMC40LTEuNi0wLjItMi4xQzIxLDIuMSwyMC44LDIsMjAuNiwxLjljLTguNC0yLjEtMTYuOSwzLTE5LDExLjQNCgljLTEuMiw0LjgtMC4xLDkuOCwzLDEzLjZsMCwwTDYsMjguNmMwLjUsMC42LDEuNSwwLjcsMi4xLDAuMmMwLDAsMC4xLTAuMSwwLjEtMC4xTDkuOSwyN2wwLDBsMi0yYzAuMiwwLjEsMC41LDAuMywwLjgsMC40DQoJYzAuOCwwLjQsMS43LDAuNywyLjUsMC44YzAuNCwwLjEsMC44LDAuMSwxLjIsMC4xaDAuNGMwLjcsMCwxLjMtMC4xLDItMC4yYzAuNC0wLjEsMC44LTAuMiwxLjItMC4zYzEtMC40LDEuOS0wLjksMi44LTEuNQ0KCWMwLjctMC41LDEuMi0xLjEsMS43LTEuOGMwLjUtMC42LDAuOC0xLjMsMS4xLTIuMWMwLjItMC41LDAuMy0wLjksMC40LTEuNGMwLjEtMC4zLDAuMS0wLjYsMC4xLTAuOWMwLTAuMywwLTAuNiwwLjEtMXYtMC4xDQoJYzAtMC4yLDAtMC40LDAtMC41YzAtMC4xLDAtMC4xLDAtMC4yaC0wLjhsMC44LDBjMC0wLjUtMC4zLTAuOS0wLjgtMC45Yy0wLjEsMC0wLjEsMC0wLjIsMGgtNi42Yy0wLjEsMC0wLjIsMC0wLjMsMGgtNy43bDAuMS0wLjINCgljMC40LTEuNCwxLjMtMi43LDIuNi0zLjVjMC43LTAuNCwxLjQtMC43LDIuMi0wLjljMC4zLTAuMSwwLjctMC4xLDEtMC4xYzAuMywwLDAuNiwwLDAuOSwwYzAuMiwwLDAuNSwwLjEsMC43LDAuMQ0KCWMwLjMsMC4xLDAuNywwLjIsMSwwLjNsMC4zLDAuMWwwLjcsMC40bDAuMSwwYzAuMywwLjIsMC42LDAuNSwwLjksMC44YzAuMiwwLjIsMC40LDAuMywwLjYsMC4zYzAuMiwwLDAuNS0wLjEsMC42LTAuM2wwLjgtMC44DQoJbDAuMy0wLjNsMi4zLTIuOWM0LjQsNC41LDQuNywxMS42LDAuOCwxNi41TDI2LjUsMjVsLTkuNywxMi4xTDE0LDMzLjZsMS4zLDAuMWgwLjJjMC45LDAsMS41LTAuNywxLjUtMS42YzAtMC44LTAuNi0xLjQtMS40LTEuNQ0KCWMtMS43LTAuMi0zLjUtMC4yLTUuMi0wLjJjLTAuNiwwLjEtMS4xLDAuNy0xLjIsMS4zbC0wLjYsNC42QzguNiwzNy4yLDkuMiwzNy45LDEwLDM4aDAuMmMwLjgsMCwxLjQtMC42LDEuNS0xLjRsMC4xLTAuOWw0LjQsNS40DQoJYzAuMywwLjMsMC44LDAuNCwxLjEsMC4xYzAsMCwwLjEtMC4xLDAuMS0wLjFMMjksMjYuOGwwLDBDMzEuMiwyNCwzMi40LDIwLjcsMzIuNSwxNy4yeiIvPg0KPC9zdmc+DQo='
web_timeout  = 30

Properties

$Actions  : SLP_Actions
$Activation  : mixed
$add_ons  : mixed
$addon  : object
$AddOns  : SLP_AddOns
$Admin_Locations  : SLP_Admin_Locations
$Admin_Locations_Add  : SLP_Admin_Locations_Add
$admin_page_prefix  : mixed
$ajax  : mixed
$AJAX  : mixed
$class_prefix  : mixed
$clean  : mixed
$Country_Manager  : SLP_Country_Manager
$current_addon  : SLP_BaseClass_Addon
$currentLocation  : mixed
$database  : mixed
$db  : mixed
$dir  : mixed
$Experience_Admin_Locations  : SLP_Experience_Admin_Locations
$Helper  : SLP_Admin_Helper
$infoFetched  : mixed
$installed_version  : mixed
$Internet_Helper  : SLP_Internet_Helper
$javascript_is_forced  : mixed
$Location_Manager  : SLP_Location_Manager
$location_manager  : mixed
$min_add_on_versions  : array<string|int, mixed>
$myslp  : MySLP
$name  : mixed
$network_multisite  : mixed
$notifications  : mixed
$objects  : mixed
$options  : array<string|int, mixed>
$options_default  : mixed
$options_nojs  : mixed
$options_nojs_default  : mixed
$plugin_url  : mixed
$Power_Admin_General  : SLP_Power_Admin_General
$Power_Admin_General_Text  : SLP_Power_Admin_General_Text
$Power_Admin_Location_Filters  : SLP_Power_Admin_Location_Filters
$Power_Admin_Locations  : SLP_Power_Admin_Locations
$Power_Admin_Locations_Actions  : SLP_Power_Admin_Locations_Actions
$Power_AJAX  : SLP_Power_AJAX
$Power_Category_Manager  : SLP_Power_Category_Manager
$Power_Text  : SLP_Power_Text
$prefix  : mixed
$Premier_Category  : SLP_Premier_Category
$Premier_Category_UI  : SLP_Premier_Category_UI
$Premier_URL_Control  : SLP_Premier_URL_Control
$short_slug  : mixed
$shortcode_was_rendered  : mixed
$slider_rendered  : mixed
$slp_store_url  : mixed
$slplus  : SLPlus
$slug  : mixed
$SmartOptions  : SLP_SmartOptions
$support_url  : mixed
$Text  : mixed
$UI  : SLP_UI
$url  : mixed
$url_main_slp_site  : mixed
$userMetaKeys  : array<string|int, mixed>
$uses_myslp  : bool
$uses_slplus  : mixed
$WPOption_Manager  : SLP_WPOption_Manager
$main_id  : mixed

Methods

__construct()  : mixed
Initialize a new SLPlus Object
__get()  : mixed
Get the value, running it through a filter.
__isset()  : bool
Allow isset to be called on private properties.
add_object()  : mixed
addon()  : mixed|null
Return an active addon object.
auto_load()  : mixed
Auto-loads classes whenever new ClassName() is called.
createobject_AJAX()  : mixed
Create the AJAX processing object and attach to this->ajax
enqueue_google_maps_script()  : void
Enqueues the Google Maps script with the dynamically generated URL from the plugin's settings.
find_addon()  : mixed|null|SLPlus
Find add on by class name.
get_apikey()  : mixed|void
Get an API key for SLP
get_google_maps_url()  : string
Get the Google Maps URL (front end)
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
initialize()  : mixed
Finish our starting constructor elements.
initialize_after_plugins_loaded()  : mixed
Things to do after all plugins are loaded.
instantiate()  : null|object
Instantiate an object of the noted class.
is_CheckTrue()  : bool|string
Return '1' if the given value is set to 'true', 'on', or '1' (case insensitive).
is_func_available()  : true
Check if certain safe mode restricted functions are available.
is_main_blog()  : bool
Are we on the main blog ID (first site)?
is_valid_url()  : bool
Checks if a URL is valid.
load_jquery_theme()  : mixed
Load the selected jQuery UI theme.
nqGoogleMaps()  : void
Enqueues the Google Maps script in async mode.
recenter_map()  : mixed
Re-center the map as needed.
sanitize_things()  : mixed
Sanitize some stuff we care about.
set_properties()  : mixed
Set our properties.
set_ValidOptions()  : mixed
Set valid options from the incoming REQUEST
set_ValidOptionsNoJS()  : mixed
Set valid options from the incoming REQUEST
ua_is_a_bot()  : bool
Check if User Agent is a bot.
user_can_manage_slp()  : bool
Return true if user can manage SLP.
at_startup()  : mixed
Things to do at startup after this baby is initialized. Override in your class.
set_default_object_options()  : mixed
Set default options for objects. Override in your class.
add_actions()  : mixed
Setup WordPress action scripts.
get_main_blog_id()  : int|null
Get the main blog ID.
set_map_center_fallback()  : mixed
Set the map center fallback for the selected country.

Constants

category_option_base

public mixed category_option_base = \SLPLUS_PREFIX . '-TAGALONG-category_'

earth_radius_km

public mixed earth_radius_km = 6371

earth_radius_mi

public mixed earth_radius_mi = 3959

locationPostType

public mixed locationPostType = 'store_page'

locationPostURL

public mixed locationPostURL = 'store-page'

locationTaxonomy

public mixed locationTaxonomy = 'stores'

menu_icon

public mixed menu_icon = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyMC4wLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMy4zIDQyLjkiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDMzLjMgNDIuOTsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6dXJsKCNTVkdJRF8xXyk7fQ0KPC9zdHlsZT4NCjx0aXRsZT5TTFAtbG9nby1zbWFsbC1jb2xvcjwvdGl0bGU+DQo8bGluZWFyR3JhZGllbnQgaWQ9IlNWR0lEXzFfIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjMzNy43ODY3IiB5MT0iLTI4Ny40ODIyIiB4Mj0iMzY5LjA5NjYiIHkyPSItMjg3LjQ4MjIiIGdyYWRpZW50VHJhbnNmb3JtPSJtYXRyaXgoMSAwIDAgLTEgLTMzNi42MiAtMjY1Ljk4NjcpIj4NCgk8c3RvcCAgb2Zmc2V0PSIwIiBzdHlsZT0ic3RvcC1jb2xvcjojRUY1MzIzIi8+DQoJPHN0b3AgIG9mZnNldD0iMC4xNiIgc3R5bGU9InN0b3AtY29sb3I6I0UwNDkyNiIvPg0KCTxzdG9wICBvZmZzZXQ9IjAuNDMiIHN0eWxlPSJzdG9wLWNvbG9yOiNDRDNDMkEiLz4NCgk8c3RvcCAgb2Zmc2V0PSIwLjcxIiBzdHlsZT0ic3RvcC1jb2xvcjojQzIzNTJDIi8+DQoJPHN0b3AgIG9mZnNldD0iMSIgc3R5bGU9InN0b3AtY29sb3I6I0JFMzIyRCIvPg0KPC9saW5lYXJHcmFkaWVudD4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik0zMi41LDE3LjJjMC00LjgtMi4yLTkuMy01LjktMTIuM2MtMC42LTAuNS0xLjUtMC40LTIsMC4yYzAsMCwwLDAsMCwwbC0xLjEsMS40bDAsMGwtMS44LDIuM2wtMC4xLTAuMQ0KCWMtMC40LTAuMi0wLjgtMC40LTEuMi0wLjZjLTAuNy0wLjMtMS40LTAuNS0yLjItMC42Yy0wLjMtMC4xLTAuNy0wLjEtMS0wLjFjLTAuNCwwLTAuOCwwLTEuMSwwYy0wLjMsMC0wLjYsMC4xLTAuOSwwLjENCgljLTAuNCwwLjEtMC43LDAuMS0xLDAuMkMxMy44LDgsMTMuNCw4LjIsMTMsOC40Yy0wLjMsMC4xLTAuNiwwLjMtMC45LDAuNWMtMC40LDAuMi0wLjgsMC41LTEuMSwwLjhjLTAuNCwwLjMtMC44LDAuNy0xLjIsMS4xDQoJYy0wLjYsMC43LTEuMSwxLjQtMS41LDIuM2MtMC4yLDAuNC0wLjQsMC45LTAuNSwxLjNjLTAuMSwwLjItMC4xLDAuNC0wLjIsMC42djAuMWMwLDAuMi0wLjEsMC40LTAuMSwwLjdzMCwwLjQtMC4xLDAuNg0KCWMtMC4xLDAuNS0wLjEsMSwwLDEuNWMwLjEsMC41LDAuNSwwLjgsMC45LDAuOGgxNC41bDAsMGMtMC4xLDAuNC0wLjMsMC44LTAuNCwxLjJjLTAuMiwwLjQtMC40LDAuNy0wLjYsMWMtMC4yLDAuMy0wLjUsMC42LTAuNywwLjgNCgljLTAuMiwwLjItMC41LDAuNC0wLjcsMC41Yy0wLjMsMC4yLTAuNywwLjQtMSwwLjVjLTAuNCwwLjItMC44LDAuMy0xLjIsMC40Yy0wLjQsMC4xLTAuOCwwLjEtMS4yLDAuMWMtMC4zLDAtMC43LDAtMSwwDQoJYy0wLjctMC4xLTEuNC0wLjMtMi4xLTAuNmwtMC40LTAuMmMtMC40LTAuMi0wLjgtMC41LTEuMS0wLjljLTAuMi0wLjItMC40LTAuMy0wLjctMC4zYy0wLjIsMC0wLjUsMC4xLTAuNiwwLjNsLTAuOCwwLjhsLTAuMSwwLjENCgljLTAuMSwwLjEtMC4xLDAuMS0wLjIsMC4ybC0yLjcsMi43bC0wLjEtMC4xbC0wLjEtMC4xTDcsMjQuOWMtMS45LTIuMy0yLjktNS4zLTIuNy04LjNDNC41LDExLDguNSw2LjIsMTQuMSw0LjkNCgljMS44LTAuNCwzLjctMC40LDUuNSwwYzAuNywwLjIsMS40LTAuMSwxLjgtMC42YzAuNS0wLjcsMC40LTEuNi0wLjItMi4xQzIxLDIuMSwyMC44LDIsMjAuNiwxLjljLTguNC0yLjEtMTYuOSwzLTE5LDExLjQNCgljLTEuMiw0LjgtMC4xLDkuOCwzLDEzLjZsMCwwTDYsMjguNmMwLjUsMC42LDEuNSwwLjcsMi4xLDAuMmMwLDAsMC4xLTAuMSwwLjEtMC4xTDkuOSwyN2wwLDBsMi0yYzAuMiwwLjEsMC41LDAuMywwLjgsMC40DQoJYzAuOCwwLjQsMS43LDAuNywyLjUsMC44YzAuNCwwLjEsMC44LDAuMSwxLjIsMC4xaDAuNGMwLjcsMCwxLjMtMC4xLDItMC4yYzAuNC0wLjEsMC44LTAuMiwxLjItMC4zYzEtMC40LDEuOS0wLjksMi44LTEuNQ0KCWMwLjctMC41LDEuMi0xLjEsMS43LTEuOGMwLjUtMC42LDAuOC0xLjMsMS4xLTIuMWMwLjItMC41LDAuMy0wLjksMC40LTEuNGMwLjEtMC4zLDAuMS0wLjYsMC4xLTAuOWMwLTAuMywwLTAuNiwwLjEtMXYtMC4xDQoJYzAtMC4yLDAtMC40LDAtMC41YzAtMC4xLDAtMC4xLDAtMC4yaC0wLjhsMC44LDBjMC0wLjUtMC4zLTAuOS0wLjgtMC45Yy0wLjEsMC0wLjEsMC0wLjIsMGgtNi42Yy0wLjEsMC0wLjIsMC0wLjMsMGgtNy43bDAuMS0wLjINCgljMC40LTEuNCwxLjMtMi43LDIuNi0zLjVjMC43LTAuNCwxLjQtMC43LDIuMi0wLjljMC4zLTAuMSwwLjctMC4xLDEtMC4xYzAuMywwLDAuNiwwLDAuOSwwYzAuMiwwLDAuNSwwLjEsMC43LDAuMQ0KCWMwLjMsMC4xLDAuNywwLjIsMSwwLjNsMC4zLDAuMWwwLjcsMC40bDAuMSwwYzAuMywwLjIsMC42LDAuNSwwLjksMC44YzAuMiwwLjIsMC40LDAuMywwLjYsMC4zYzAuMiwwLDAuNS0wLjEsMC42LTAuM2wwLjgtMC44DQoJbDAuMy0wLjNsMi4zLTIuOWM0LjQsNC41LDQuNywxMS42LDAuOCwxNi41TDI2LjUsMjVsLTkuNywxMi4xTDE0LDMzLjZsMS4zLDAuMWgwLjJjMC45LDAsMS41LTAuNywxLjUtMS42YzAtMC44LTAuNi0xLjQtMS40LTEuNQ0KCWMtMS43LTAuMi0zLjUtMC4yLTUuMi0wLjJjLTAuNiwwLjEtMS4xLDAuNy0xLjIsMS4zbC0wLjYsNC42QzguNiwzNy4yLDkuMiwzNy45LDEwLDM4aDAuMmMwLjgsMCwxLjQtMC42LDEuNS0xLjRsMC4xLTAuOWw0LjQsNS40DQoJYzAuMywwLjMsMC44LDAuNCwxLjEsMC4xYzAsMCwwLjEtMC4xLDAuMS0wLjFMMjksMjYuOGwwLDBDMzEuMiwyNCwzMi40LDIwLjcsMzIuNSwxNy4yeiIvPg0KPC9zdmc+DQo='

web_timeout

public mixed web_timeout = 30

Properties

$Activation

public mixed $Activation

$admin_page_prefix

public mixed $admin_page_prefix = \SLP_ADMIN_PAGEPRE

$class_prefix

public mixed $class_prefix = 'SLP_'

$clean

public mixed $clean = array('act' => '', 'action' => '', 'deactivate' => '', 'locationID' => 0, 'option_page' => '', 'orderBy' => '', 'page' => '', 'selected_nav_element' => '', 'sortorder' => '', 'start' => 0)

$currentLocation

public mixed $currentLocation

$database

public mixed $database

$Experience_Admin_Locations

public SLP_Experience_Admin_Locations $Experience_Admin_Locations

-- Premier Plugin

$infoFetched

public mixed $infoFetched = array()

$installed_version

public mixed $installed_version

$Internet_Helper

public SLP_Internet_Helper $Internet_Helper

Assist with Internet queries like remote gets and JSON parsing.

$javascript_is_forced

public mixed $javascript_is_forced = \false

$Location_Manager

public SLP_Location_Manager $Location_Manager

Higher level location manager things like initial distance updater and total location count management.

$location_manager

public mixed $location_manager

$min_add_on_versions

public array<string|int, mixed> $min_add_on_versions = array('slp-premier' => '2506.23.01', 'slp-power' => '2512.01.01', 'slp-experience' => '2512.15.01')

$name

public mixed $name = \SLPLUS_NAME

$network_multisite

public mixed $network_multisite = \false

$notifications

public mixed $notifications

$options

public array<string|int, mixed> $options = array( 'ignore_radius' => '0', // Passed in as form var from Experience 'map_domain' => 'maps.google.com', 'no_autozoom' => '0', )

$options_default

public mixed $options_default = array()

$options_nojs

public mixed $options_nojs = array('broadcast_timestamp' => '0', 'default_country' => 'us', 'extended_data_tested' => '0', 'map_language' => 'en', 'next_field_id' => 1, 'next_field_ported' => '', 'premium_user_id' => '', 'premium_subscription_id' => '', 'radius_behavior' => 'always_use', 'slplus_plugindir' => \SLPLUS_PLUGINDIR, 'slplus_basename' => \SLPLUS_BASENAME, 'themes_last_updated' => '0')

$options_nojs_default

public mixed $options_nojs_default = array()

$plugin_url

public mixed $plugin_url = \SLPLUS_PLUGINURL

$Power_Admin_General

public SLP_Power_Admin_General $Power_Admin_General

$prefix

public mixed $prefix = \SLPLUS_PREFIX

$short_slug

public mixed $short_slug = 'store-locator-le'

$shortcode_was_rendered

public mixed $shortcode_was_rendered = \false

$slider_rendered

public mixed $slider_rendered = \false

$slp_store_url

public mixed $slp_store_url = 'https://wordpress.storelocatorplus.com/'

$support_url

public mixed $support_url = 'https://docs.storelocatorplus.com'

$url_main_slp_site

public mixed $url_main_slp_site = 'https://storelocatorplus.com'

$userMetaKeys

public array<string|int, mixed> $userMetaKeys = ['locations_per_page']

$uses_myslp

public bool $uses_myslp

Set to true to add a $myslp property pointing to global $myslp

$uses_slplus

public mixed $uses_slplus = \false

$WPOption_Manager

public SLP_WPOption_Manager $WPOption_Manager

Augment the WordPress get/update/delete option functions with fiters.

-- Experience Plugin

$main_id

private mixed $main_id

Methods

__construct()

Initialize a new SLPlus Object

public __construct() : mixed

__get()

Get the value, running it through a filter.

public __get(string $property) : mixed
Parameters
$property : string
Return values
mixed —

null if not set or the value

__isset()

Allow isset to be called on private properties.

public __isset(mixed $property) : bool
Parameters
$property : mixed
Return values
bool

addon()

Return an active addon object.

public addon(mixed $slug) : mixed|null
Parameters
$slug : mixed
Return values
mixed|null —

null if not add on is active.

auto_load()

Auto-loads classes whenever new ClassName() is called.

public auto_load(mixed $class_name) : mixed

Loads them from the module/ directory for the add on. is the part after the class prefix before an _ or . For example SLP_Power_Admin would load the include/module/admin/SLP_Power_Admin.php file.

Parameters
$class_name : mixed

createobject_AJAX()

Create the AJAX processing object and attach to this->ajax

public createobject_AJAX() : mixed
Tags
used-by

\MySLP_REST_API::set_options

TODO: remove ->ajax, ->AJAX when all things use slplus->AJAX instead of ->ajax (GFI)

enqueue_google_maps_script()

Enqueues the Google Maps script with the dynamically generated URL from the plugin's settings.

public enqueue_google_maps_script([string $strategy = 'defer' ]) : void

Checks if the google_server_key is set, if not, the script is not enqueued. The WordPress script with the handle slp_core is a dependency. WordPress handle for the script: google_maps

Parameters
$strategy : string = 'defer'

The script loading strategy, default is 'defer'.

Tags
@return

void.

uses
SLPlus::get_google_maps_url
uses
SLP_Actions::register_slp_core_script

find_addon()

Find add on by class name.

public find_addon(string $class_name) : mixed|null|SLPlus
Parameters
$class_name : string
Return values
mixed|null|SLPlus

get_apikey()

Get an API key for SLP

public get_apikey() : mixed|void
Return values
mixed|void

get_google_maps_url()

Get the Google Maps URL (front end)

public get_google_maps_url([mixed $addCallback = true ]) : string
Parameters
$addCallback : mixed = true
Return values
string

get_instance()

Return an instance of the object which is also registered to the slplus global less the SLP_ part.

public static get_instance([bool $no_global = false ][, mixed $params = array() ]) : static
Parameters
$no_global : bool = false

set to true to skip assigning object to SLP global as a property.

$params : mixed = array()

object init params

Return values
static

initialize()

Finish our starting constructor elements.

public initialize() : mixed

initialize_after_plugins_loaded()

Things to do after all plugins are loaded.

public initialize_after_plugins_loaded() : mixed

instantiate()

Instantiate an object of the noted class.

public instantiate(string $class[, array<string|int, mixed> $options = array() ]) : null|object
Parameters
$class : string
$options : array<string|int, mixed> = array()
Return values
null|object

is_CheckTrue()

Return '1' if the given value is set to 'true', 'on', or '1' (case insensitive).

public is_CheckTrue(mixed $value[, string $return_type = 'boolean' ]) : bool|string

Return '0' otherwise.

Useful for checkbox values that may be stored as 'on' or '1'.

Parameters
$value : mixed
$return_type : string = 'boolean'
Return values
bool|string

is_func_available()

Check if certain safe mode restricted functions are available.

public is_func_available(mixed $funcname) : true

exec, set_time_limit

Parameters
$funcname : mixed
Return values
true

is_main_blog()

Are we on the main blog ID (first site)?

public is_main_blog() : bool
Return values
bool

is_valid_url()

Checks if a URL is valid.

public is_valid_url(mixed $url) : bool
Parameters
$url : mixed
Return values
bool

load_jquery_theme()

Load the selected jQuery UI theme.

public load_jquery_theme([string $theme = 'none' ]) : mixed
Parameters
$theme : string = 'none'

the jQuery UI theme

nqGoogleMaps()

Enqueues the Google Maps script in async mode.

public nqGoogleMaps() : void
Tags
uses
SLPlus::get_google_maps_url

recenter_map()

Re-center the map as needed.

public recenter_map() : mixed

Sets Center Map At ('map-center') and Lat/Lng Fallback if any of those entries are blank.

Uses the Map Domain ('default_country') as the source for the new center.

sanitize_things()

Sanitize some stuff we care about.

public sanitize_things() : mixed

Called via add_action( 'plugins_loaded' , ... )

set_properties()

Set our properties.

public set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

set_ValidOptions()

Set valid options from the incoming REQUEST

public set_ValidOptions(mixed $val, string $key) : mixed
Parameters
$val : mixed
  • the value of a form var
$key : string
  • the key for that form var

set_ValidOptionsNoJS()

Set valid options from the incoming REQUEST

public set_ValidOptionsNoJS(mixed $val, string $key) : mixed

Set this if the incoming value is not an empty string.

Parameters
$val : mixed
  • the value of a form var
$key : string
  • the key for that form var

ua_is_a_bot()

Check if User Agent is a bot.

public ua_is_a_bot() : bool
Return values
bool

user_can_manage_slp()

Return true if user can manage SLP.

public user_can_manage_slp() : bool
Return values
bool

at_startup()

Things to do at startup after this baby is initialized. Override in your class.

protected at_startup() : mixed

NOTE: this will not run at initialization if $this->objects is empty.

set_default_object_options()

Set default options for objects. Override in your class.

protected set_default_object_options() : mixed

add_actions()

Setup WordPress action scripts.

private add_actions() : mixed

Note: admin_menu is not called on every admin page load Reference: http://codex.wordpress.org/Plugin_API/Action_Reference

get_main_blog_id()

Get the main blog ID.

private get_main_blog_id() : int|null
Return values
int|null

set_map_center_fallback()

Set the map center fallback for the selected country.

private set_map_center_fallback([string $for = 'latlng' ]) : mixed
Parameters
$for : string = 'latlng'

latlng | lat | lng


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results