SLP® phpDocs

SLP_Experience_Widget extends SLPlus_BaseClass_Object
in package

Holds the admin-only code.

This allows the main plugin to only include this file in admin mode via the admin_menu call. Reduces the front-end footprint.

Table of Contents

Properties

$addon  : mixed
$myslp  : MySLP
$settings  : mixed
$settings_class_name  : mixed
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$js_settings  : mixed
$slug  : mixed
$initial_widget_request  : mixed
$widget_referral  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
create_object_settings()  : mixed
Create the settings object.
enqueue_javascript()  : mixed
Enqueue JavaScript needed for widgets.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_settings()  : mixed
Returns a pointer to the settings object
is_initial_widget_search()  : bool
Is this the initial widget search?
is_widget_referral()  : bool
Is this a widget referral?
register_widgets()  : mixed
Register our widgets with WordPress
set_properties()  : mixed
Set our properties.
set_SearchAddressFromRequest()  : mixed
Sets the current address based on the widget address
set_SearchCenter()  : mixed
Sets the search center based on the address
add_hooks_and_filters()  : mixed
Add our hooks and filters.
initialize()  : mixed
Run these things during invocation. (called from base object in __construct)

Properties

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

$initial_widget_request

private mixed $initial_widget_request = \null

Methods

__construct()

public __construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

__isset()

public __isset(string $property) : bool
Parameters
$property : string
Return values
bool

create_object_settings()

Create the settings object.

public create_object_settings() : mixed

enqueue_javascript()

Enqueue JavaScript needed for widgets.

public enqueue_javascript() : 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
static

get_settings()

Returns a pointer to the settings object

public get_settings() : mixed

is_initial_widget_search()

Is this the initial widget search?

public is_initial_widget_search(array<string|int, mixed> $var_array) : bool
Parameters
$var_array : array<string|int, mixed>

The form variables presented via REQUEST.

Return values
bool

is_widget_referral()

Is this a widget referral?

public is_widget_referral(array<string|int, mixed> $var_array) : bool
Parameters
$var_array : array<string|int, mixed>

The form variables presented via REQUEST.

Return values
bool

register_widgets()

Register our widgets with WordPress

public register_widgets() : mixed

The files must be in ./include/widgets/class..php. The classes must be named SLPWidget_ and extend WP_Widget.

set_properties()

Set our properties.

public set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

set_SearchAddressFromRequest()

Sets the current address based on the widget address

public set_SearchAddressFromRequest(mixed $currentVal) : mixed
Parameters
$currentVal : mixed

set_SearchCenter()

Sets the search center based on the address

public set_SearchCenter(mixed $currentVal) : mixed
Parameters
$currentVal : mixed

add_hooks_and_filters()

Add our hooks and filters.

protected add_hooks_and_filters() : mixed

initialize()

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

protected initialize() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results