SLP_Admin_Welcome
extends SLP_Base_ReactObject
in package
SLP Admin Info Page
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.
- render() : void
- Render admin page - default can be overriden.
- 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.
Properties
$addon
public
object
$addon
$buildDir read-only
public
string
$buildDir
The build directory where the React script lives.
$buildURL read-only
public
string
$buildURL
The build URL where the React script lives.
$myslp
public
MySLP
$myslp
$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/
$scriptURL read-only
public
string
$scriptURL
The URL for the React script.
$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
Default false try to use SLPlus::get_instance() legacy models that use $this->slplus must set this to true.
$pluginDir
protected
mixed
$pluginDir
$pluginURL
protected
mixed
$pluginURL
$slug
protected
mixed
$slug
$wrapper_class
protected
mixed
$wrapper_class
= 'dashboard-wrapper react-wrapper'
Methods
__construct()
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
__get()
public
__get(string $property) : SLPlus_BaseClass_Object
Parameters
- $property : string
Return values
SLPlus_BaseClass_Object__isset()
public
__isset(string $property) : bool
Parameters
- $property : string
Return values
boolget_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
staticrender()
Render admin page - default can be overriden.
public
render() : void
Provide the DOM element where the React app will render: slp-full-page-react-app
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>initialize()
Do at invocation.
protected
initialize() : void
..