SLP® phpDocs

SLP_Admin_Locations_New extends SLP_Base_ReactObject
in package

React-backed "New" subtab for Locations.

Table of Contents

Properties

$addon  : object
$buildDir  : string
$buildURL  : string
$myslp  : MySLP
$pageName  : string
$scriptAssetFile  : string
$scriptFile  : string
$scriptFilebase  : string
$scriptHandle  : string
$scriptURL  : string
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$pluginDir  : mixed
$pluginURL  : mixed
$slug  : mixed
$wrapper_class  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_react_mount_html()  : string
Get React mount markup and enqueue React assets.
render()  : void
Render only the React mount container for use in a settings subtab.
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.
enqueue_location_add_react()  : void
Enqueue script + vars for the location add panel without redefining global slpReact.

Properties

$buildDir read-only

public string $buildDir

The build directory where the React script lives.

$pageName

public string $pageName

The page name for React, update with initialize() override.

$scriptAssetFile read-only

public string $scriptAssetFile

The fully qualified file name for the React script supporting asset PHP file.

$scriptFile read-only

public string $scriptFile

The fully qualified file name for the React script.

$scriptFilebase

public string $scriptFilebase

The name of the edit/view mode script file, default: script.js.

$scriptHandle

public string $scriptHandle

Both the WP handle for managing the react script and the build/ subdir in which ot find the react scripts.

$uses_myslp

public bool $uses_myslp

Set to true to add a $myslp property pointing to global $myslp

$uses_slplus

public bool $uses_slplus

Default false try to use SLPlus::get_instance() legacy models that use $this->slplus must set this to true.

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

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_react_mount_html()

Get React mount markup and enqueue React assets.

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

enqueueReact()

Things we normally want to do before each render

protected enqueueReact() : void

get_vars_for_react()

Pass data from PHP to React JavaScript environment.

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

Use this for one-time setup, things that are mostly static in PHP but you need to send to JS.

Return values
array<string|int, mixed>

enqueue_location_add_react()

Enqueue script + vars for the location add panel without redefining global slpReact.

private enqueue_location_add_react() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results