SLP® phpDocs

API Documentation

Table of Contents

Interfaces

MySLP_Payment_Processor_Interface
Interface MySLP_Payment_Processor_Interface

Classes

MySLP_Admin
Admin interface methods.
MySLP_Admin_Dashboard
Class SLPlus_BaseClass_Object
MySLP_Admin_DashboardCodebase
The MySLP Admin Dashboard Codebase Widget
MySLP_Admin_DashboardDebugLog
Class MySLP_Admin_DashboardDebugLog
MySLP_Admin_DashboardNavbar
Class MySLP_Admin_DashboardNavbar
MySLP_Admin_DashboardSysInfo
Class MySLP_Admin_DashboardSysInfo
MySLP_Admin_UserSwitching
Manage user switching.
MySLP_AJAX
Class MySLP_AJAX
MySLP_Base
Class MySLP_Base
MySLP_DSRA
Class MySLP_DSRA
MySLP_Option
Class MySLP_Option
MySLP_Categry_Walker
The data interface helper.
CSVImportLocations
CSV Import of Locations
MySLP_Styles_Admin
SLP Styles Admin Class
Customer_Profile_History
Customer Profile History React Block
Customer_Profile_Invoices
Invoices React Block
Customer_Profile_Site_Info
Site Info React Block
Customer_Profile_Subscription
Subscription React Block
MySLP_Customer_Profile
MySLP_Customer_Profile class manages customer profiles and integrates various admin functionalities such as menu creation, plugin hooks, and actions specific to email settings and subscription handling.
MySLP_Deployment
Deployment helpers.
MySLP_DomainSwitcher
Handles switching the domain for MySLP installations.
MySLP_Location
Class MySLP_Location
MySLP_Admin_Locations
Class MySLP_Admin_Locations
MySLP_Settings_General
Class MySLP_Settings_General
MySLP
Class MySLP
MySLP_Addon
Main add-on class for the MySLP plugin.
MySLP_Categories
Categories class. This only runs if SLP Power is active
MySLP_Contact_Us
MySLP_Contact_Us class manages the "Contact Us" page and related email functionality.
MySLP_Cron_List_Table
Define and display the customer lists here
MySLP_Customer_Maintenance
Class MySLP_Customer_Maintenance
MySLP_Customer_Management
Class MySLP_Customer_Management
MySLP_Customers_List_Table
Define and display the customer lists here
MySLP_Email_Settings
Class MySLP_Email_Settings
MySLP_Option_Modifier
SLP Option Modifier
MySLP_REST_API
Class MySLP_REST_API
MySLP_Service_Levels
Class MySLP_Service_Levels
MySLP_SysAdmin_View_Profile
Class MySLP_SysAdmin_View_Profile
MySLP_User
Class MySLP_User a modified WP_User
RedisClusterSessionHandler
MySLP_RedisCluster
Class MySLP_Base
MySLP_Settings_History
The MySLP_Settings_History class is responsible for managing the settings history functionality within the application, including custom post type creation, REST API integration, admin menu additions, and tracking changes in settings.
MySLP_Settings_History_Dashboard
Represents the settings history dashboard for the MySLP plugin.
MySLP_Email_Template_Utils
Class MySLP_Email_Template_Utils
MySLP_Template
Class MySLP_Template
MySLP_History_Table
Class MySLP_History_Table
MySLP_NetworkAdmin_History_Log
Class MySLP_NetworkAdmin
MySLP_History
Class MySLP_History
MySLP_Payment_Processor
Class MySLP_Payment_Processor
MySLP_Payments
Class MySLP_Payments
MySLP_Recurring_Payments
Class MySLP_Recurring_Payments
MySLP_PayPal_Payments
Class MySLP_PayPal_Payments
MySLP_Payments_Page
Class MySLP_Payments_Page
MySLP_Signup_Admin
MySLP_Signup_Admin_Dashboard
MySLP_Signup_Base_Object
MySLP_Signup_Connector_Dashboard
MySLP_Signup_Footer
MySLP_Signup
Class MySLP_Signup
MySLP_Signup_Shortcode_myslpsignupform
MySLP_Signup_Stripe_Checkout
Class MySLP_Signup_Stripe_Checkout
SLP_Experience_Activation
Manage plugin activation.
SLP_Experience_Widget
Holds the admin-only code.
SLPWidget_Legacy_Settings
Class SLPWidget_Settings
SLP_Widget_Setting
Class SLP_Widget_Setting
SLP_Experience_Admin
Holds the admin-only code.
SLP_Experience_Admin_General_Text
SLP Text Modifier
SLP_Experience_Admin_Settings
Class SLP_Experience_Admin_UXSettings
SLP_Experience_Admin_Settings_Text
SLP Text Modifier
SLP_Experience_AJAX
Holds the ajax-only code.
SLP_Experience_Data
Class SLP_Experience_Data
SLP_Experience_Options
SmartOptions for the Experience add on.
SLP_Experience_UI
Holds the UI-only code.
SLP_Experience
Class SLP_Experience
WP_Widget_SLPExp
Class WP_Widget_SLP
SLPWidget_cities
Class SLPWidget_cities
SLPWidget_cities_UI
Class SLPWidget_cities_UI
SLPWidget_search
A basic slp widget
SLPWidget_search_UI
Class SLPWidget_search_UI
SLPWidget_states
Class SLPWidget_states
SLPWidget_states_UI
Class SLPWidget_states_UI
SLPPower_Activation
Manage plugin activation.
SLP_Power_Admin
General Admin methods, manage the "Pages" SEO hookups, category filter setup, add/edit category UX.
SLP_Power_Admin_EditTags
The WP edit tags interface.
SLP_Power_Admin_General_Text
SLP Text Modifier
SLP_Power_Admin_Info
The things that modify the Admin / General Tab.
SLP_Power_Admin_Location_Filters
Admin Filters on locations both UX side and BE database I/O side.
SLP_Power_Admin_Locations
The things that modify the Admin / Locations UX for power, adding import subtab, tweaking the add form.
SLP_Power_Admin_Locations_Actions
Handle location actions.
SLP_Power_Admin_Locations_Import
The things that modify the Admin / Locations / Import UX.
SLP_Power_Admin_Reports2022
Power Admin Reports
SLP_Power_AJAX
Holds the ajax-only code.
SLP_Power_AJAX_Location_Manager
Handle the AJAX location_manager requests.
SLP_Power_Category_Data
The data interface helper for the persistent data store (MySQL).
SLP_Power_Category_Manager
Manage categories for admin, UI, CRON, AJAX, REST.
SLP_Power_Category_Selector
A category selector object.
SLP_Power_Category_Selector_Manager
Manage the category selectors.
SLP_Power_Category_Stores_Taxonomy
Category interface.
SLP_Power_Category_Stores_Taxonomy_Meta
Category: Stores taxonomy metadata interface.
SLP_Power_Category_Walker_Legend
Admin and public UI rendering for categories, generating HTML for lists of categories.
SLP_Power_Cron
The cron job processing class.
SLP_Power_Data_Reports
Admin Report Data Interface for Power
SLP_Power_Directory_Landing_Page
The slp_directory shortcode landing page processor.
SLP_Power_Directory_UI_Shortcode_slp_directory
The slp_directory shortcode processor.
SLP_Power_Locations_Export
Export locations to a CSV file.
SLP_Power_Locations_Geocode
Geocode Locations
SLP_Power_Locations_Import
CSV Import handler for locations.
SLP_Power_Options
Manage the Power options, especially the Admin UI setting up the settings.
SLP_Power_Pages
System-wide Pages functionality for Power add on.
SLP_Power_Pages_Admin
Admin pages stuff.
SLP_Power_Pages_Global
System-wide Pages functionality for Power add on.
SLP_Power_Pages_Tab
Things we only need if the pages tab is active.
SLP_Power_Pages_UI
UI pages stuff on loaded of using pages is enabled.
SLP_Power_Pages_UI_Shortcode_slp_pages
UI pages stuff on loaded of using pages is enabled.
SLP_Power_Pages_UI_Shortcode_storepage
UI pages stuff on loaded of using pages is enabled.
SLP_Power_REST_Handler
Configure the REST handler and connect to WordPress engine.
SLP_Settings_import_stats
Class SLP_Setting is the admin interface and rendering engine for a single SLP Option.
SLP_Power_Text
Augment the SLP text tables.
SLP_Power_Text_Pages_Tab
Class SLPlus_BaseClass_Object
SLP_Power_UI
Interface methods rendering HTML for the public-side front end.
SLPPower
The main Power add on class.
SLP_Premier_Activation
Manage plugin activation.
SLP_Premier_Admin
Holds the admin-only code.
SLP_Premier_Admin_Experience
Class SLP_Premier_Admin_Experience
SLP_Premier_Admin_General
The things that modify the Admin / General Tab.
SLP_Premier_Admin_General_Text
SLP Text Modifier
SLP_Premier_Admin_Locations
Class SLP_Premier_Admin_Locations
SLP_Premier_Admin_Locations_Text
SLP Text Modifier
SLP_Premier_Location_Add
The things that modify the Admin / Locations / Add UX
SLP_Premier_AJAX
Holds the ajax-only code.
SLP_Premier_AJAX_Pagination
Holds the ajax-only code.
SLP_Premier_Category
Class SLP_Premier_Category
SLP_Premier_Category_UI
Add stuff to the Tagalong UI.
SLP_Premier_Category_Walker_Checklist
Category Walker
SLP_Premier_Options
Class SLP_Premier_Options
SLP_Premier_Schedule_Item
Class SLP_Premier_Schedule_Item
SLP_Premier_Schedule_Manager
The schedule manager.
SLP_Premier_Security_Block_IP
Class SLP_Premier_Security_Block_IP
SLP_Premier_Territory
Define a territory
SLP_Premier_Text_Admin_Experience
SLP Text Modifier
SLP_Premier_UI
Holds the UI-only code.
SLP_Premier_URL_Control
Class SLP_Premier_URL_Control
SLP_Premier
Class SLP_Premier
SLP_AddOn_Options
Class SLP_AddOn_Options
SLP_BaseClass_Admin
A base class that helps add-on packs separate admin functionality.
SLP_Object_With_Objects
Class SLP_Object_With_Objects
SLP_Object_WithOptions
Class SLP_Object_WithOptions
SLP_BaseClass_Addon
A base class that consolidates common add-on pack methods.
SLP_BaseClass_AJAX
A base class that helps add-on packs separate AJAX functionality.
SLPlus_BaseClass_Object
Class SLPlus_BaseClass_Object
SLP_BaseClass_UI
A base class that helps add-on packs separate UI functionality.
SLP_Actions
Store Locator Plus action hooks.
SLP_AddOn_Updates
Checks remote SLP server for add-on pack updates.
SLP_AddOns
Add On Manager
SLP_AddOns_Meta
Handle Add On MetaData.
SLP_Admin_Activation
Handles activation processes for the SLP plugin, including role management, plugin deactivation checks, add-on updates, file copying, database table management, and extended data table setup.
SLP_Admin_General
Store Locator Plus General Settings Interface
SLP_Admin_General_Text
Class SLP_Admin_General_Text
SLP_Admin_Helper
Helper, non-critical methods to make WordPress plugins easier to manage.
SLP_Admin_Info
SLP Admin Info Page
SLP_Admin_Locations
Store Locator Plus manage locations admin user interface.
SLP_Admin_Locations_Actions
Admin Locations Tab Actions Processing
SLP_Admin_Locations_Add
Add locations form, built as a Vue template.
SLP_Admin_Locations_Load
Load locations from another WordPress site.
SLP_Admin_Locations_New
React-backed "New" subtab for Locations.
SLP_Admin_Settings
Store Locator Plus Admin Settings tab.
SLP_Admin_Settings_Text
Class SLP_Admin_Settings_Text
SLP_Admin_Style
SLP Admin Style Page
SLP_Admin_UI
Class SLP_Admin_UI
SLP_Admin_Upgrade
Class SLP_Admin_Upgrade
SLP_Admin_Welcome
SLP Admin Info Page
SLP_AJAX
Holds the ajax-only code.
SLP_AJAX_Location_Manager
Handle the AJAX location_manager requests.
SLP_Base_Object
Class SLP_Base_Object
SLP_Base_ReactObject
Base object used for React driven components.
SLP_Base_Text
Class SLP_Base_Text
SLP_BaseClass_Activation
A base class that helps add-on packs separate activation functionality.
SLP_Blocks
Class SLPlus_BaseClass_Object
SLP_Country_Manager
Class SLP_Country
SLP_Data
The data interface helper.
SLP_Data_Extension
The extended data interface helper. Managed the extended data columns when needed.
SLP_Google
Class SLPlus_BaseClass_Object
SLP_Location_LoadFromWP
Class SLP_Base_Object
SLP_Location_Manager
Class SLP_Location_Manager
SLP_Location_Utilities
Class SLP_Base_Object
SLP_Message_Manager
Message Manager
SLP_Notifications_Manager
The Notification System.
SLP_REST_Environment
Handle the Environment apiGroup endpoints
SLP_REST_Handler
WP REST API interface.
SLP_REST_Schedule
Handle the Schedule apiGroup endpoints
SLP_Service
Class SLP_Service
SLP_Service_SaaS
Class SLPlus_BaseClass_Object
SLP_Settings
The UI and management interface for a page full of settings for a WordPress admin page.
SLP_Settings_checkbox
The checkbox setting.
SLP_Settings_custom
The custom setting.
SLP_Settings_details
Class SLP_Settings_details Represents specific settings related to rendering and default settings in the SLP context.
SLP_Settings_dropdown
The dropdown setting.
SLP_Settings_file
The file setting.
SLP_Settings_Group
Groups are collections of individual settings (items).
SLP_Settings_hidden
The hidden setting.
SLP_Settings_hyperbutton
The hyperbutton setting.
SLP_Settings_icon
The icon setting.
SLP_Settings_input
The input setting.
SLP_Settings_list
The list setting.
SLP_Settings_manage_locations_table
Class SLP_Setting is the admin interface and rendering engine for a single SLP Option.
SLP_Settings_password
The input setting.
SLP_Settings_Section
Sections are collections of groups.
SLP_Settings_subheader
Class SLP_Settings_subheader
SLP_Settings_submit
The submit setting.
SLP_Settings_textarea
The checkbox setting.
SLP_Settings_vue_component
The input setting.
SLP_SmartOptions
Smart Options setup defines user settings and manages event triggers.
SLP_Style
Class SLP_Style
SLP_Style_Manager
The "Locator Style" manager, handles implementing and changing SLP UI "themes".
SLP_Template
Class SLP_Template
SLP_Template_Vue
Class SLP_Template_Vue
SLP_Text
Class SLP_Text
SLP_Text_Links
Class SLP_Text_Links
SLP_UI
Store Locator Plus basic user interface.
SLP_UI_Shortcode
Class SLP_UI_Shortcode
SLP_UI_Shortcode_slp_location
Class SLP_UI_Shortcode_slp_location
SLP_UI_Shortcode_slp_option
Class SLP_UI_Shortcode_slp_option
SLP_WPOption_Manager
Assist with WP option I/O to add fitlers to delete/get/update wp_options.
SLPlus
The base plugin class for Store Locator Plus.
SLP_AddOn
Details about an Add On
SLP_Country
Class SLP_Country
SLP_Notice
This class represents each individual notice.
SLP_Option
A single Smart Option object that is setup via things like SLP_SmartOptions.
SLP_Setting
Class SLP_Setting is the admin interface and rendering engine for a single SLP Option.
SLP_Setting_item
Class SLP_Setting_item
SLP_Web_Link
Class SLP_Web_Link
SLPlus_Location
Store Locator Plus location interface and management class.

Constants

MYSLP_DEPLOYMENT_LEVEL  = 'live'
MYSLP_VERSION  = $meta['Version']
SA_ALLOW_CACHE  = $sa_enable_cache
SA_ASSETS_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'assets/'
SA_ASSETS_URL  = \trailingslashit(\SA_PARENT_URL) . 'assets/'
SA_CONTROLLERS_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'controllers/'
SA_CONTROLLERS_URL  = \trailingslashit(\SA_PARENT_URL) . 'controllers/'
SA_CORE_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'core/'
SA_CORE_URL  = \trailingslashit(\SA_PARENT_URL) . 'core/'
SA_DB_CACHE_TIMEOUT  = $sa_cache_timeout * 60
SA_EXTENSIONS_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'extensions/'
SA_EXTENSIONS_URL  = \trailingslashit(\SA_PARENT_URL) . 'extensions/'
SA_META_PREFIX  = '_sa_'
SA_MODELS_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'models/'
SA_MODELS_URL  = \trailingslashit(\SA_PARENT_URL) . 'models/'
SA_PARENT_DIR  = \plugin_dir_path(__FILE__)
SA_PARENT_URL  = \plugin_dir_url(__FILE__)
SA_STRIPE_PUBLISHKEY  = $sa_stripe_pub_key
SA_STRIPE_SECRETKEY  = $sa_stripe_sec_key
SA_VIEWS_DIR  = \trailingslashit(\SA_PARENT_DIR) . 'views/'
SA_VIEWS_URL  = \trailingslashit(\SA_PARENT_URL) . 'views/'
SLPLUS_SCRIPTS_MANAGED  = true
SLPLUS_UPLOADDIR  = SLPLUS_PLUGINDIR
SLPLUS_UPLOADURL  = SLPLUS_PLUGINURL
WP_AUTO_UPDATE_CORE  = \false
WP_DEFAULT_THEME  = 'myslp-dashboard-theme'

Functions

user_switching_set_olduser_cookie()  : void
Sets authorisation cookies containing the originating user information.
user_switching_clear_olduser_cookie()  : void
Clears the cookies containing the originating user, or pops the latest item off the end if there's more than one.
user_switching_get_olduser_cookie()  : string|false
Gets the value of the cookie containing the originating user.
user_switching_get_auth_cookie()  : array<int, string>
Gets the value of the auth cookie containing the list of originating users.
switch_to_user()  : false|WP_User
Switches the current logged in user to the specified user.
switch_off_user()  : bool
Switches off the current logged in user. This logs the current user out while retaining a cookie allowing them to log straight back in using the 'Switch back to {user}' system.
current_user_switched()  : false|WP_User
Returns whether or not the current user switched into their account.
MySLP_loader()  : void
Our loader class. Start Execution here.
slp_setup_environment()  : mixed
Setup the SLP Environment (defines, etc.)
slp_upload_dir_notice()  : mixed
Upload directory issue warning.

Constants

MYSLP_DEPLOYMENT_LEVEL

public mixed MYSLP_DEPLOYMENT_LEVEL = 'live'

SA_CONTROLLERS_DIR

public mixed SA_CONTROLLERS_DIR = \trailingslashit(\SA_PARENT_DIR) . 'controllers/'

SA_CONTROLLERS_URL

public mixed SA_CONTROLLERS_URL = \trailingslashit(\SA_PARENT_URL) . 'controllers/'

SA_EXTENSIONS_DIR

public mixed SA_EXTENSIONS_DIR = \trailingslashit(\SA_PARENT_DIR) . 'extensions/'

SA_EXTENSIONS_URL

public mixed SA_EXTENSIONS_URL = \trailingslashit(\SA_PARENT_URL) . 'extensions/'

SLPLUS_SCRIPTS_MANAGED

public mixed SLPLUS_SCRIPTS_MANAGED = true

SLPLUS_UPLOADDIR

public mixed SLPLUS_UPLOADDIR = SLPLUS_PLUGINDIR

SLPLUS_UPLOADURL

public mixed SLPLUS_UPLOADURL = SLPLUS_PLUGINURL

Functions

Sets authorisation cookies containing the originating user information.

user_switching_set_olduser_cookie(int $old_user_id[, bool $pop = false ][, string $token = '' ]) : void
Parameters
$old_user_id : int

The ID of the originating user, usually the current logged in user.

$pop : bool = false

Optional. Pop the latest user off the auth cookie, instead of appending the new one. Default false.

$token : string = ''

Optional. The old user's session token to store for later reuse. Default empty string.

Tags
since
1.4.0

The $token parameter was added.

Clears the cookies containing the originating user, or pops the latest item off the end if there's more than one.

user_switching_clear_olduser_cookie([bool $clear_all = true ]) : void
Parameters
$clear_all : bool = true

Optional. Whether to clear the cookies (as opposed to just popping the last user off the end). Default true.

Gets the value of the cookie containing the originating user.

user_switching_get_olduser_cookie() : string|false
Return values
string|false

The old user cookie, or boolean false if there isn't one.

Gets the value of the auth cookie containing the list of originating users.

user_switching_get_auth_cookie() : array<int, string>
Return values
array<int, string>

Array of originating user authentication cookie values. Empty array if there are none.

switch_to_user()

Switches the current logged in user to the specified user.

switch_to_user(int $user_id[, bool $remember = false ][, bool $set_old_user = true ]) : false|WP_User
Parameters
$user_id : int

The ID of the user to switch to.

$remember : bool = false

Optional. Whether to 'remember' the user in the form of a persistent browser cookie. Default false.

$set_old_user : bool = true

Optional. Whether to set the old user cookie. Default true.

Return values
false|WP_User

WP_User object on success, false on failure.

switch_off_user()

Switches off the current logged in user. This logs the current user out while retaining a cookie allowing them to log straight back in using the 'Switch back to {user}' system.

switch_off_user() : bool
Return values
bool

True on success, false on failure.

current_user_switched()

Returns whether or not the current user switched into their account.

current_user_switched() : false|WP_User
Return values
false|WP_User

False if the user isn't logged in or they didn't switch in; old user object (which evaluates to true) if the user switched into the current user account.

MySLP_loader()

Our loader class. Start Execution here.

MySLP_loader() : void

slp_setup_environment()

Setup the SLP Environment (defines, etc.)

slp_setup_environment() : mixed

slp_upload_dir_notice()

Upload directory issue warning.

slp_upload_dir_notice() : mixed

        
On this page

Search results