SLP® phpDocs

SLP_Power_Pages_UI_Shortcode_storepage extends SLPlus_BaseClass_Object
in package

UI pages stuff on loaded of using pages is enabled.

[storepage] is used to render live details about a location, typically on a Store Page. Used by the Pages templates.

Table of Contents

Properties

$addon  : object
$myslp  : MySLP
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed
$no_map  : 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.
process_shortcode()  : string
Manage the shortcode
set_properties()  : mixed
Set our properties.
initialize()  : mixed
Do these things when this object is invoked. Override in your class.
create_string_hyperlink()  : string
Create an url hyperlink base on the type field provided.
create_string_image()  : string
Create an image string if the field and content are valid.
create_string_mailto()  : string
Create an email hyperlink base on the type field provided.
generate_map()  : mixed
Generate a map for the current location.
get_post_data()  : string
Return Post value for the linked post.
wrap_with_tag()  : string
Wrap output with tag and class if tag is specified.

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.

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

process_shortcode()

Manage the shortcode

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

named array of attributes set in shortcode

$content : string = null

the existing content that we will modify

Tags
used-by

\SLP_Power_Pages_UI::add_hooks_and_filters

Return values
string —

the modified HTML content

set_properties()

Set our properties.

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

initialize()

Do these things when this object is invoked. Override in your class.

protected initialize() : mixed

create_string_hyperlink()

Create an url hyperlink base on the type field provided.

private create_string_hyperlink(string $field, string $title, string $data) : string
Parameters
$field : string
$title : string
$data : string
Return values
string

create_string_image()

Create an image string if the field and content are valid.

private create_string_image(string $field, string $title, string $data) : string
Parameters
$field : string
$title : string
$data : string
Return values
string

create_string_mailto()

Create an email hyperlink base on the type field provided.

private create_string_mailto(string $field, string $data) : string
Parameters
$field : string
$data : string
Return values
string

wrap_with_tag()

Wrap output with tag and class if tag is specified.

private wrap_with_tag(string $html, string $tag, string $class) : string
Parameters
$html : string
$tag : string
$class : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results