Store Locator Plus®

SLP_BaseClass_Addon extends SLP_Object_WithOptions

in package

• StoreLocatorPlus

A base class that consolidates common add-on pack methods.

Table of Contents

Properties

$activation_class_name  : string

$activation_class_name  : mixed

$addon  : SLP_BaseClass_Addon

$admin  : SLP_BaseClass_Admin

$admin  : mixed

$admin_class_name  : string

$admin_menu_entries  : array<string|int, mixed>

$admin_menu_entries  : mixed

$ajax  : SLP_BaseClass_AJAX

$ajax  : mixed

$ajax_class_name  : string

$class_prefix  : string

$class_prefix  : string

$dir  : mixed

$dir  : string

$dir  : string

$dir  : string

$file  : string

$file  : mixed

$meta  : SLP_AddOns_Meta

$meta  : mixed

$metadata  : mixed

$min_slp_version  : string

$min_slp_version  : mixed

$name  : string

$name  : mixed

$objects  : array<string|int, mixed>

$objects  : array<string|int, mixed>

$objects  : array<string|int, mixed>

$option_defaults  : array<string|int, mixed>

$option_defaults  : mixed

$option_name  : mixed

$option_name  : string

$option_name  : string

$options  : mixed

$options  : array<string|int, mixed>

$options  : array<string|int, mixed>

$options_defaults  : array<string|int, mixed>

$options_defaults  : mixed

$short_slug  : string

$short_slug  : mixed

$slplus  : SLPlus

$slug  : string

$slug  : mixed

$Updates  : SLP_AddOn_Updates

$Updates  : mixed

$url  : string

$url  : mixed

$userinterface  : SLP_BaseClass_UI

$userinterface  : mixed

$userinterface_class_name  : string

$userinterface_class_name  : mixed

$uses_slplus  : bool

$version  : string

$version  : mixed

$widget  : SLP_BaseClass_Widget

$widget  : mixed

$widget_class_name  : string

$widget_class_name  : mixed

$WPOption_Manager  : SLP_WPOption_Manager

$WPOption_Manager  : mixed

$addon  : mixed

$admin_class_name  : mixed

$ajax_class_name  : mixed

$class_prefix  : mixed

$objects  : mixed

$slplus  : mixed

$uses_slplus  : mixed

Methods

__construct()  : mixed

__get()  : SLPlus_BaseClass_Object

__isset()  : bool

__set()  : SLP_Option|null

Allow value to be set directly.

add_hooks_and_filters()  : mixed

Add the plugin specific hooks and filter configurations here.

add_object()  : mixed

create_object()  : mixed

Instantiate our objects ONCE and refer to them in an object array.

create_object_Updates()  : mixed

Creates updates object AND checks for updates for this add-on.

createobject_Admin()  : mixed

Create the admin interface object and attach to this->admin

createobject_AJAX()  : mixed

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

createobject_UserInterface()  : mixed

Create the user interface object and attach to this->UserInterface

filter_AddMenuItems()  : array<string|int, mixed>

Add the items specified in the menu_entries property to the SLP menu.

get_addon_version()  : string

Get the add-on pack version.

get_instance()  : SLPlus_BaseClass_Object

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

get_meta()  : string

Get the add on metadata property as specified.

get_option()  : mixed

Get an option attribute.

init_options()  : mixed

Initialize the options properties from the WordPress database.

instantiate()  : null|object

Instantiate an object of the noted class.

load_options()  : mixed

Load the options class to help the SLP smart options if we have that feature.

set_option()  : bool

Set an option attribute.

set_option_defaults()  : mixed

Set option defaults outside of hard-coded property values via an array.

set_properties()  : mixed

Set our properties.

set_ValidOptions()  : mixed

Set valid options according to the addon options array.

setting_name()  : string

Generate a proper setting name for the settings class.

slp_init()  : mixed

Things to do once SLP is alive.

at_startup()  : mixed

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

initialize()  : mixed

Run these things during invocation. (called from base object in __construct)

set_default_object_options()  : mixed

Set default options for objects. Override in your class.

augment_class()  : string

Augment the class names so we can reference simple property names.

auto_instantiate()  : mixed

Any object with auto_instantiate set to true is instantiate during initialization.

check_my_version_compatibility()  : bool

Check the current version of this Add On works with the latest version of the SLP base plugin.

create_object_option_manager()  : mixed

Create an option manager object for this addon.

create_object_widget()  : mixed

Create and attach the widget object as needed.

get_short_slug()  : string

Get the short slug, just the base/directory part of the fully qualified WP slug for this plugin.

VersionCheck()  : mixed

Compare current plugin version with minimum required.