StoreLocatorPlus
Table of Contents
Packages
Classes
- SLP_AddOn_Options
- Class SLP_AddOn_Options
- SLP_Object_With_Objects
- Class SLP_Object_With_Objects
- SLP_Object_WithOptions
- Class SLP_Object_WithOptions
- SLP_BaseClass_Activation
- A base class that helps add-on packs separate activation functionality.
- 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
- Store Locator Plus Activation handler.
- 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
- Base object used for React driven components.
- SLP_Admin_Settings
- Store Locator Plus Admin Settings tab.
- SLP_Admin_Settings_Text
- Class SLP_Admin_Settings_Text
- SLP_Admin_UI
- Store Locator Plus basic admin user interface.
- SLP_Admin_Upgrade
- Class SLP_Admin_Upgrade
- SLP_BaseClass_Admin
- A base class that helps add-on packs separate admin functionality.
- 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_Blocks
- Class SLPlus_BaseClass_Object
- SLP_Country_Manager
- Class SLP_Country
- 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_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_Setting is the admin interface and rendering engine for a single SLP Option.
- 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_style_vision_list
- The style vision list.
- SLP_Settings_subheader
- Class SLP_Settings_subheader
- SLP_Settings_submit
- The submit setting.
- SLP_Settings_textarea
- The checkbox setting.
- SLP_Settings_vision_list
- The vision list.
- SLP_Settings_vue_component
- The input setting.
- 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
- Methods to help manage the SLP text strings in an i18n compatible fashion.
- 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_Setting
- Class SLP_Setting is the admin interface and rendering engine for a single SLP Option.
- SLP_Setting_item
- Class SLP_Setting_item
- SLPlus_Location
- Store Locator Plus location interface and management class.
- MySLP_Activation
- Manage plugin activation.
- 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_Import
- The things that modify the Admin / Locations / Import UX.
- SLP_Power_Admin_Reports2022
- Class SLPlus_BaseClass_Object
- SLP_Power_AJAX_Location_Manager
- Handle the AJAX location_manager requests.
- 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_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_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
- MySLP_Admin
- Admin interface methods.
- MySLP_Admin_Dashboard
- Class SLPlus_BaseClass_Object
- MySLP_Admin_DashboardPlugins
- Class SLPlus_BaseClass_Object
- MySLP_AJAX
- Class MySLP_AJAX
- MySLP_Base
- MySLP_DSRA
- Class MySLP_DSRA
- MySLP_Option
- Class MySLP_Option
- MySLP_REST_API
- Class MySLP_REST_API
- MySLP_Styles_Admin
- SLP Styles Admin Class
- MySLP_Location
- Class MySLP_Location
- SLP_Dashboard_Admin_SLP_Navbar
- Class SLPlus_BaseClass_Object
- MySLP_Admin_Locations
- Class MySLP_Admin_Locations
- MySLP_Settings_General
- Class MySLP_Settings_General
- MySLP
- Class MySLP
- MySLP_Option_Modifier
- SLP Option Modifier
- MySLP_Service_Levels
- Class MySLP_Service_Levels
- MySLP_User
- Class MySLP_User a modified WP_User
- MySLP_Template
- Class MySLP_Template
Constants
- MYSLP_DEPLOYMENT_LEVEL = 'live'
- SLPLUS_SCRIPTS_MANAGED = true
Functions
- power_notify_slplus_dependency() : mixed
- power_notify_wp_dependency() : mixed
- user_switching_set_olduser_cookie() : mixed
- Sets authorisation cookies containing the originating user information.
- user_switching_clear_olduser_cookie() : mixed
- 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<string|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.
Constants
MYSLP_DEPLOYMENT_LEVEL
public
mixed
MYSLP_DEPLOYMENT_LEVEL
= 'live'
SLPLUS_SCRIPTS_MANAGED
public
mixed
SLPLUS_SCRIPTS_MANAGED
= true
Functions
power_notify_slplus_dependency()
power_notify_slplus_dependency() : mixed
power_notify_wp_dependency()
power_notify_wp_dependency() : mixed
user_switching_set_olduser_cookie()
Sets authorisation cookies containing the originating user information.
user_switching_set_olduser_cookie(int $old_user_id[, bool $pop = false ][, string $token = '' ]) : mixed
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
user_switching_clear_olduser_cookie()
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 ]) : mixed
Parameters
- $clear_all : bool = true
-
Optional. Whether to clear the cookies (as opposed to just popping the last user off the end). Default true.
user_switching_get_olduser_cookie()
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.
user_switching_get_auth_cookie()
Gets the value of the auth cookie containing the list of originating users.
user_switching_get_auth_cookie() : array<string|int, string>
Return values
array<string|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.