SLP® phpDocs

StoreLocatorPlus

Packages

Actions
Locations
Country
REST
Settings
UI
Notification
Web

Interfaces

MySLP_Payment_Processor_Interface: Interface MySLP_Payment_Processor_Interface

Classes

MySLP_Payment_Processor: Class MySLP_Payment_Processor
MySLP_PayPal_Payments: Class MySLP_PayPal_Payments
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_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_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_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_Service: Class SLP_Service
SLP_Service_SaaS: Class SLPlus_BaseClass_Object
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_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_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_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_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.

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.

MYSLP_DEPLOYMENT_LEVEL


    public
        mixed
    MYSLP_DEPLOYMENT_LEVEL
    = 'live'

MYSLP_VERSION


    public
        mixed
    MYSLP_VERSION
    = $meta['Version']

SA_ALLOW_CACHE


    public
        mixed
    SA_ALLOW_CACHE
    = $sa_enable_cache

SA_ASSETS_DIR


    public
        mixed
    SA_ASSETS_DIR
    = \trailingslashit(\SA_PARENT_DIR) . 'assets/'

SA_ASSETS_URL


    public
        mixed
    SA_ASSETS_URL
    = \trailingslashit(\SA_PARENT_URL) . 'assets/'

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_CORE_DIR


    public
        mixed
    SA_CORE_DIR
    = \trailingslashit(\SA_PARENT_DIR) . 'core/'

SA_CORE_URL


    public
        mixed
    SA_CORE_URL
    = \trailingslashit(\SA_PARENT_URL) . 'core/'

SA_DB_CACHE_TIMEOUT


    public
        mixed
    SA_DB_CACHE_TIMEOUT
    = $sa_cache_timeout * 60

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/'

SA_META_PREFIX


    public
        mixed
    SA_META_PREFIX
    = '_sa_'

SA_MODELS_DIR


    public
        mixed
    SA_MODELS_DIR
    = \trailingslashit(\SA_PARENT_DIR) . 'models/'

SA_MODELS_URL


    public
        mixed
    SA_MODELS_URL
    = \trailingslashit(\SA_PARENT_URL) . 'models/'

SA_PARENT_DIR


    public
        mixed
    SA_PARENT_DIR
    = \plugin_dir_path(__FILE__)

SA_PARENT_URL


    public
        mixed
    SA_PARENT_URL
    = \plugin_dir_url(__FILE__)

SA_STRIPE_PUBLISHKEY


    public
        mixed
    SA_STRIPE_PUBLISHKEY
    = $sa_stripe_pub_key

SA_STRIPE_SECRETKEY


    public
        mixed
    SA_STRIPE_SECRETKEY
    = $sa_stripe_sec_key

SA_VIEWS_DIR


    public
        mixed
    SA_VIEWS_DIR
    = \trailingslashit(\SA_PARENT_DIR) . 'views/'

SA_VIEWS_URL


    public
        mixed
    SA_VIEWS_URL
    = \trailingslashit(\SA_PARENT_URL) . 'views/'

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

WP_AUTO_UPDATE_CORE


    public
        mixed
    WP_AUTO_UPDATE_CORE
    = \false

WP_DEFAULT_THEME


    public
        mixed
    WP_DEFAULT_THEME
    = 'myslp-dashboard-theme'

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 = '' ]) : 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.

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 ]) : 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.

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<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

StoreLocatorPlus

Table of Contents

Packages

Interfaces

Classes

Constants

Functions

Constants

MYSLP_DEPLOYMENT_LEVEL

MYSLP_VERSION

SA_ALLOW_CACHE

SA_ASSETS_DIR

SA_ASSETS_URL

SA_CONTROLLERS_DIR

SA_CONTROLLERS_URL

SA_CORE_DIR

SA_CORE_URL

SA_DB_CACHE_TIMEOUT

SA_EXTENSIONS_DIR

SA_EXTENSIONS_URL

SA_META_PREFIX

SA_MODELS_DIR

SA_MODELS_URL

SA_PARENT_DIR

SA_PARENT_URL

SA_STRIPE_PUBLISHKEY

SA_STRIPE_SECRETKEY

SA_VIEWS_DIR

SA_VIEWS_URL

SLPLUS_SCRIPTS_MANAGED

SLPLUS_UPLOADDIR

SLPLUS_UPLOADURL

WP_AUTO_UPDATE_CORE

WP_DEFAULT_THEME

Functions

user_switching_set_olduser_cookie()

Parameters

Tags

user_switching_clear_olduser_cookie()

Parameters

user_switching_get_olduser_cookie()

Return values

user_switching_get_auth_cookie()

Return values

switch_to_user()

Parameters

Return values

switch_off_user()

Return values

current_user_switched()

Return values

MySLP_loader()

slp_setup_environment()

slp_upload_dir_notice()