SLP® phpDocs

SLP_Premier_UI extends SLP_BaseClass_UI
in package

Holds the UI-only code.

This allows the main plugin to only include this file in the front end via the wp_enqueue_scripts call. Reduces the back-end footprint.

Table of Contents

Properties

$addon  : mixed
$js_requirements  : array<string|int, string>
$js_settings  : array<string|int, string>
$jsHandle  : mixed
$myslp  : MySLP
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
add_hooks_and_filters()  : void
Add WP Hooks and Filters
add_search_elements()  : array<string|int, mixed>
Add front end SLP search form elements.
at_startup()  : void
Do this at the start.
enqueue_ui_css()  : void
Manage the UI CSS enqueue process.
enqueue_ui_javascript()  : void
Manage the UI JavaScript enqueue process.
extend_slp_directory_shortcode()  : void
Things we do when the slp_directory shortcode processing is started by the Power add on.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
initialize()  : mixed
Instantiate the admin panel object.
modify_searchlayout()  : string
Modify the search form.
process_hook_ShortcodeSLPOption()  : array<string|int, mixed>
Process the SLP option shortcode hook.
process_slp_directory_text_if_blank()  : string
Add the text_if_blank shortcode attributet to slp_directory
set_properties()  : mixed
Set our properties.

Properties

$js_requirements

public array<string|int, string> $js_requirements

An array of the JavaScript hooks that are needed by the userinterface.js script. userinterface.js is only loaded if the file exists in the include directory.

$js_settings

public array<string|int, string> $js_settings

JavaScript settings that are to be localized as a _settings JS variable.

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

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

add_hooks_and_filters()

Add WP Hooks and Filters

public add_hooks_and_filters() : void
Tags
uses
SLP_Premier_UI::add_search_elements
uses
SLP_Premier_UI::modify_searchlayout

add_search_elements()

Add front end SLP search form elements.

public add_search_elements(array<string|int, mixed> $attributes) : array<string|int, mixed>
Parameters
$attributes : array<string|int, mixed>
Tags
used-by

SLP_Premier_UI::add_hooks_and_filters

Return values
array<string|int, mixed>

at_startup()

Do this at the start.

public final at_startup() : void

enqueue_ui_css()

Manage the UI CSS enqueue process.

public enqueue_ui_css() : void

enqueue_ui_javascript()

Manage the UI JavaScript enqueue process.

public enqueue_ui_javascript() : void

extend_slp_directory_shortcode()

Things we do when the slp_directory shortcode processing is started by the Power add on.

public extend_slp_directory_shortcode() : void

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

modify_searchlayout()

Modify the search form.

public modify_searchlayout(string $html) : string
Parameters
$html : string
Tags
filters

slp_searchlayout

used-by

SLP_Premier_UI::add_hooks_and_filters

Return values
string

process_hook_ShortcodeSLPOption()

Process the SLP option shortcode hook.

public process_hook_ShortcodeSLPOption([array<string|int, mixed>|null $attributes = array() ]) : array<string|int, mixed>

Ensure attributes are an array before passing to modifier.

Parameters
$attributes : array<string|int, mixed>|null = array()
Tags
uses
SLP_UI_Shortcode_slp_option::modify
Return values
array<string|int, mixed>

process_slp_directory_text_if_blank()

Add the text_if_blank shortcode attributet to slp_directory

public process_slp_directory_text_if_blank(string $text, array<string|int, string> $shortcode_attributes) : string
Parameters
$text : string
$shortcode_attributes : array<string|int, string>
Return values
string

set_properties()

Set our properties.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results