SLP_Admin_Settings
extends SLP_Object_With_Objects
in package
Store Locator Plus Admin Settings tab.
Table of Contents
Properties
- $addon : object
- $class_prefix : string
- $dir : string
- $myslp : MySLP
- $option_cache : array<string|int, string>
- $Settings : SLP_Settings
- $slplus : SLPlus
- $uses_myslp : bool
- $uses_slplus : bool
- $objects : mixed
- $slug : mixed
- $group_params : mixed
- $map_languages : mixed
- $update_info : mixed
Methods
- __construct() : mixed
- __get() : mixed
- Get the value, running it through a filter.
- __isset() : bool
- Allow isset to be called on private properties.
- add_map() : mixed
- Add the map tab to the admin settings page.
- add_object() : mixed
- add_results() : mixed
- Add the results admin tab.
- add_search() : mixed
- Add the admin Search tab
- add_tools() : mixed
- Tools
- add_view() : mixed
- View
- display() : mixed
- Render the map settings admin page.
- get_instance() : static
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- initialize() : mixed
- Setup the group params at startup.
- instantiate() : null|object
- Instantiate an object of the noted class.
- save_options() : mixed
- Save the options to the WP database options table.
- set_properties() : mixed
- Set our properties.
- at_startup() : mixed
- Things to do at startup after this baby is initialized. Override in your class.
- set_default_object_options() : mixed
- Set our object options.
- add_map_functionality() : mixed
- Map / Functionality
- add_search_appearance() : mixed
- Search / Appearance
- add_search_functionality() : mixed
- Search / Functionality
- save_custom_css() : mixed
- Save or update custom CSS
- set_map_languages() : mixed
- Set the map languages when needed.
Properties
$addon
public
object
$addon
$class_prefix
public
string
$class_prefix
the prefix that goes before all our classes
$dir
public
string
$dir
the root directory for this theme
$myslp
public
MySLP
$myslp
$option_cache read-only
public
array<string|int, string>
$option_cache
$Settings read-only
public
SLP_Settings
$Settings
$slplus
public
SLPlus
$slplus
$uses_myslp
public
bool
$uses_myslp
Set to true to add a $myslp property pointing to global $myslp
$uses_slplus
public
bool
$uses_slplus
Set to true (default) if the object needs access to the SLPlus plugin object.
$objects
protected
mixed
$objects
= array('Settings' => array('auto_instantiate' => \true, 'subdir' => 'include/module/settings/'))
$slug
protected
mixed
$slug
$group_params
private
mixed
$group_params
= array()
$map_languages
private
mixed
$map_languages
= array()
$update_info
private
mixed
$update_info
= array()
Methods
__construct()
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
__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
booladd_map()
Add the map tab to the admin settings page.
public
add_map() : mixed
add_object()
public
add_object(mixed $object) : mixed
Parameters
- $object : mixed
add_results()
Add the results admin tab.
public
add_results() : mixed
add_search()
Add the admin Search tab
public
add_search() : mixed
add_tools()
Tools
public
add_tools() : mixed
add_view()
View
public
add_view() : mixed
display()
Render the map settings admin page.
public
display() : mixed
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
staticinitialize()
Setup the group params at startup.
public
initialize() : 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|objectsave_options()
Save the options to the WP database options table.
public
save_options() : mixed
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
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 our object options.
protected
set_default_object_options() : mixed
add_map_functionality()
Map / Functionality
private
add_map_functionality() : mixed
add_search_appearance()
Search / Appearance
private
add_search_appearance() : mixed
add_search_functionality()
Search / Functionality
private
add_search_functionality() : mixed
save_custom_css()
Save or update custom CSS
private
save_custom_css() : mixed
Called when "Save Settings" button is clicked
set_map_languages()
Set the map languages when needed.
private
set_map_languages() : mixed