SLP® phpDocs

SLP_Settings extends SLP_Base_ReactObject

in package

• StoreLocatorPlus
• Settings

The UI and management interface for a page full of settings for a WordPress admin page.

Table of Contents

Properties

$addon  : object

$buildDir  : string

$buildURL  : string

$current_admin_page  : mixed

$form_action  : mixed

$form_enctype  : mixed

$form_name  : mixed

$known_classes  : mixed

$myslp  : MySLP

$name  : mixed

$pageName  : string

$save_text  : mixed

$scriptAssetFile  : string

$scriptFile  : string

$scriptFilebase  : string

$scriptHandle  : string

$scriptURL  : string

$sections  : mixed

$show_help_sidebar  : mixed

$slplus  : SLPlus

$uses_myslp  : bool

$uses_slplus  : mixed

$pluginDir  : mixed

$pluginURL  : mixed

$slug  : mixed

$wrapper_class  : mixed

Methods

__construct()  : mixed

Set some pre-load defaults.

__get()  : SLPlus_BaseClass_Object

__isset()  : bool

add_group()  : mixed

Add a group to the specified section.

add_ItemToGroup()  : mixed

Same as add_item but uses named params.

add_section()  : mixed

Create a settings page panel.

get_instance()  : static

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

get_section()  : SLP_Settings_Section|WP_Error

Return a section object.

has_section()  : bool

Return true if the section identified by the slug exists.

render()  : void

Render admin page - default can be overriden.

render_settings_page()  : mixed

Create the HTML for the plugin settings page on the admin panel.

set_properties()  : mixed

Set our properties.

enqueueReact()  : void

Things we normally want to do before each render

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

Pass data from PHP to React JavaScript environment.

initialize()  : void

Do at invocation.

add_help_section()  : void

Add the help sidebar.

add_smart_options_to_section()  : mixed

Add smart option groups and settings to this section.

enqueue_help_script()  : mixed

Enqueue help text manager script.

get_option_setting()  : string

Get the option setting (name)

get_value_for_setting()  : mixed

Get the value for a specific add-on option. If empty use add-on option_defaults. If still empty use slplus defaults.

save_button()  : void

Create the save button text.

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

Set Add Item To Group Params

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

Set Add Item To Group Params to new defaults.

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

Set Add Item To Group Params to new defaults.

set_section_slug()  : string

Set section slug by name if not provided.